X11 Work Bench Toolkit  1.0
__WBChildFrame__ Struct Reference

Structure that defines a Child Frame within a Frame Window. More...

#include <frame_window.h>

Data Fields

unsigned int ulTag
 tag indicating I'm a 'Child Frame' window
 
Window wID
 window identifier for the 'Child Frame' window. may contain 'None' while being destroyed
 
WBFrameWindowpOwner
 a pointer to the WBFrameWindow owner
 
XFontSet rFontSet
 default font for the window
 
WB_GEOM geom
 total client-area geometry (excludes scroll bars) in 'pixels'
 
WB_GEOM geomEntire
 client-area geometry (excludes scroll bars)
 
WB_POINT origin
 viewport 'origin' in 'client units' (such as chars and lines) - determines scroll behavior
 
WB_EXTENT extent
 viewport 'extent' in 'client units' (such as chars and lines) - determines scroll behavior
 
int iRowHeight
 cached 'row height' (height of line including interline spacing)
 
int iColWidth
 cached 'column width' (width of 1 character)
 
WB_SCROLLINFO scroll
 'scroll info' (horizontal and vertical min/max/pos and other details)
 
int iSplit
 reserved - position for 'split' (-1 for 'no split')
 
WB_SCROLLINFO scrollSplit
 reserved - 'scroll info' for 'split' area (implementation-defined)
 
int fFlags
 various bitflags defining features. See WBChildFrame_FLAGS enum.
 
char * szDisplayName
 display name shown in tab and title bar. You should not alter this member directly.
 
Atom aImageAtom
 'image' atom for display in tabs. default is 'None'. You should not alter this member directly.
 
char * szStatusText
 Status text ('WBAlloc'd) to display when this child frame window has the input focus. Updated by 'superclass'. can be NULL.
 
char * pszMenuResource
 resource string for this child frame's menu (NULL = 'use default')
 
WBFWMenuHandlerpMenuHandler
 menu handler for this child frame's menu (NULL = 'use default')
 
int iContextMenuID
 menu ID (from pszMenuResource or owning frame's menu) for context popup, -1 if none
 
WBWinEvent pUserCallback
 message callback function pointer (can be NULL)
 
void(* destructor )(struct __WBChildFrame__ *)
 pointer to a 'superclass' destructor. If not NULL, will be called by FWDestroyChildFrame()
 
struct __WBChildFrameUI__pUI
 pointer to 'WBChildFrameUI' function pointer table (assigned by 'superclass')
 
struct __WBChildFrame__pNext
 'Next Object' pointer in an internally stored linked list (do not alter or use this)
 

Detailed Description

Structure that defines a Child Frame within a Frame Window.

The WBFWMenuHandler structure is designed to be initialized via macros, so that a set of callback functions can then be easily used to handle menu events. If no menu handler is present for a menu item, or if the menu UI handler is NOT NULL and returns a non-zero value, the menu item will be disabled and displayed accordingly. It will not be possible to use its hotkey nor select it. Otherwise, the menu will be displayed normally and be selectable, and its hotkey will be able to activate it.

typedef struct __WBChildFrame__
{
unsigned int ulTag;
// tag indicating I'm a 'Child Frame' window
Window wID;
// window identifier for the 'Child Frame' window. may contain 'None' while being destroyed
// a pointer to the WBFrameWindow owner
XFontSet rFontSet;
// default font set for the window
// client-area geometry (excludes scroll bars)
// entire client-area geometry (for painting scroll bars)
// 'origin' in 'client units' (such as chars and lines) - determines scroll behavior
// 'extent' in 'client units' (such as chars and lines) - determines scroll behavior
// cached 'row height' (height of line including interline spacing)
int iColWidth;
// cached 'column width' (width of 1 character)
// 'scroll info' (horizontal and vertical min/max/pos and other details)
int iSplit;
// reserved - position for 'split' (-1 for 'no split')
// reserved - 'scroll info' for 'split' area (implementation-defined)
int fFlags;
// various bitflags defining features.
// display name shown in tab and title bar. You should not alter this member directly.
Atom aImageAtom;
// 'image' atom for display in tabs. default is 'None'. You should not alter this member directly.
char *szStatusText;
// Status text ('WBAlloc'd) to display when this child frame window has the input focus.
// Updated by 'superclass'. Can be NULL.
// WBAlloc'd resource string for this child frame's menu (NULL = 'use default')
// WBAlloc'd menu handler for this child frame's menu (NULL = 'use default')
// menu ID (from pszMenuResource or owning frame's menu) for context popup, -1 if none
// message callback function pointer (can be NULL)
void (*destructor)(struct __WBChildFrame__ *);
// pointer to a destructor. if not NULL, will be called by FWDestroyChildFrame()
// pointer to 'WBChildFrameUI' function pointer table (assigned by 'superclass')
// 'Next Object' pointer in an internally stored linked list (do not alter or use this)
See also
Frame Windows

NOTE: you should not attempt to modify any of these structure members directly. Use the appropriate API functions to modify their values. If this were C++, these members would be marked 'protected'.

Definition at line 409 of file frame_window.h.


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