ISWP

The ISWP (set-window-position) class positions and sizes the client window and extension windows of the class IFrameWindow. Classes derived from IFrameHandler may need to manipulate ISWP objects when overriding the IFrameHandler::format and IFrameHandler::positionExtensions functions. For these cases, ISWP objects can be accessed from the class IFrameFormatEvent.


ISWP - Member Functions and Data by Group

Constructors & Destructor

You can construct, destruct, and copy objects of this class.


[view class]
~ISWP
public:
~ISWP()

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
ISWP


Overload 1
public:
ISWP(const ISWP& original)

Constructs a new object, as a copy of the specified ISWP object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
ISWP()

The default constructor initializes all data to 0.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator =
public:
ISWP& operator =(const ISWP& original)

Copies the specified ISWP object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Data

These data members store the state of the object.


[view class]
behind

Stores the window that the window identified by the function windowHandle is ordered after. Applying this action is equivalent to calling the function IWindow::positionBehindSibling.


Overload 1
public:
IWindowHandle behind

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
IWindowHandle behind

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
cx

Stores the width to be given to the window identified by the function windowHandle. Applying this action is equivalent to calling the function IWindow::sizeTo.


Overload 1
public:
long cx

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
long cx

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
cy

Stores the height to be given to the window identified by the function windowHandle. Applying this action is equivalent to calling the function IWindow::sizeTo.


Overload 1
public:
long cy

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
long cy

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
fl

Stores flags to indicate what actions are to be applied to the window identified by the function windowHandle.


Overload 1
public:
unsigned long fl

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
unsigned long fl

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
hwnd

Stores the window that actions are to be applied to.


Overload 1
public:
IWindowHandle hwnd

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
IWindowHandle hwnd

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
ulReserved1
public:
unsigned long ulReserved1

Unused at this time.

Supported Platforms

Windows OS/2 AIX
No Yes Yes


[view class]
ulReserved2
public:
unsigned long ulReserved2

Unused at this time.

Supported Platforms

Windows OS/2 AIX
No Yes Yes


[view class]
x

Stores the x-component of where the window identified by the function windowHandle will be positioned on the screen relative to its parent window. Applying this action is equivalent to calling the function IWindow::moveTo.


Overload 1
public:
long x

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
long x

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
y

Stores the y-component of where the window identified by the function windowHandle will be positioned on the screen relative to its parent window. Applying this action is equivalent to calling the function IWindow::moveTo.


Overload 1
public:
long y

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
long y

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Testing

Use testing members to determine the actions stored for a window.


[view class]
isHide
public:
bool isHide() const

Returns if the window identified by the function windowHandle is to be hidden.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isMove
public:
bool isMove() const

Returns if the window identified by the function windowHandle is to be moved. The function position returns the new position of the window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isShow
public:
bool isShow() const

Returns if the window identified by the function windowHandle is to be made visible.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isSize
public:
bool isSize() const

Returns if the window identified by the function windowHandle is to be sized. The function size returns the new size for the window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
isZOrder
public:
bool isZOrder() const

Returns if the order of the window identified by the function windowHandle is to be changed, relative to the order of its sibling windows.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Window Manipulation

Use these members to identify actions to be applied to a window.


[view class]
flags
public:
unsigned long& flags()

Returns the flags stored in this object.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
position
public:
IPoint position() const

Returns the point where the window identified by the function windowHandle is to be positioned, relative to its parent window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setHide
public:
ISWP& setHide(bool enable = true)

Specifies whether the window identified by the function windowHandle is to be hidden.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setMove
public:
ISWP& setMove(bool enable = true)

Specifies whether the window identified by the function windowHandle is to be moved.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setNoAdjust
public:
ISWP& setNoAdjust(bool enable = true)

Specifies whether the position or size of the window identified by the function windowHandle can be adjusted while it is moved or sized.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setPosition
public:
ISWP& setPosition(const IPoint& point)

Set the point where the window identified by the function windowHandle is to be positioned, relative to its parent window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setShow
public:
ISWP& setShow(bool enable = true)

Specifies whether the window identified by the function windowHandle is to be made visible.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setSize
public:
ISWP& setSize(const ISize& size)

Sets a new size for the window identified by the function windowHandle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setSizeFlag
public:
ISWP& setSizeFlag(bool enable = true)

Specifies whether the window identified by the function windowHandle is to be sized.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
setZOrder
public:
ISWP& setZOrder(bool enable = true)

Specifies whether the order of the window identified by the function windowHandle is to be changed, relative to its sibling windows.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
size
public:
ISize size() const

Returns the new size for the window identified by the function windowHandle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
windowHandle
public:
IWindowHandle windowHandle() const

Returns the handle of the associated window.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


ISWP - Inherited Member Functions and Data

Inherited Public Functions

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data