main controlling structure for frame windows More...

#include <frame_window.h>

Data Fields
unsigned int	ulTag
	tag indicating I'm a frame window

Window	wID
	Window id for the frame window.

int	iFlags
	bitmask of attribute flags (see WBFrameWindow_FLAGS enumeration)

int	iClientX
	The current X position of the frame window's client area (relative to the window)

int	iClientY
	The current Y position of the frame window's client area (relative to the window)

int	iClientWidth
	The current width of the frame window's client area.

int	iClientHeight
	The current height of the frame window's client area.

Detailed Description

main controlling structure for frame windows

By default a frame window can handle multiple documents. Documents are selected via tabs. At least one tab will always be visible unless there are no 'contents'. The contained windows will be re-sized automatically as needed. Contained windows may also register their own menus and/or menu handlers.

The WBFrameWindow structure maintains the basic window state information, and contains additional data members that are not declared in WBFrameWindow. You should not create any derived 'superclass' versions that contain this structure as an embedded member. Instead, you should use a pointer to a WBFrameWindow structure within your implementation, and not rely on any data members within the structure that are not accessible through the use of an API function.

This structure is created using FWCreateFrameWindow(), and destroyed using either FWDestroyFrameWindow() (using the Window ID) or FWDestroyFrameWindow2() (using the structure pointer).

typedef struct __WB_FRAME_WINDOW__
{
  unsigned int ulTag;                  // tag indicating I'm a frame window
  Window wID;                          // Window id for the frame window
  int iFlags;                          // bitmask of attribute flags (see \ref WBFrameWindow_FLAGS enumeration)
  int iClientX;                        // The current X position of the frame window's client area
  int iClientY;                        // The current Y position of the frame window's client area
  int iClientWidth;                    // The current width of the frame window's client area
  int iClientHeight;                   // The current height of the frame window's client area
} WBFrameWindow;

See also: Frame Window APIs and Structures

Definition at line 274 of file frame_window.h.

The documentation for this struct was generated from the following file:

frame_window.h

Data Fields

Detailed Description