Default Parameters and Definitions

Macros
#define	WB_DEFAULT_CURSOR   XC_left_ptr
	The default window cursor (this is what xterm uses)
#define	WB_WAIT_CURSOR   XC_watch /*XC_clock*/
	The 'wait' cursor (this is what xterm uses)
#define	WB_DEFAULT_FONT   "fixed"
	The default X11 font name (currently "fixed")
#define	WB_DEFAULT_FONT_SIZE   13 /* override via settings */
	The default X11 font size (currently 13)
#define	WINDOW_DATA_SIZE   4 /* size of a 'void *' array that stores per-window data */
	The 'window data' array size (currently 4 void pointers)
#define	EVENT_ALL_MASK   0x01ffffffL /* 2^24 | 2^23 ... 2^0 - see X.h */
	An event mask for ALL events, with bits 0 through 24 set - see X.h which only defines bits 0 to 24 for an event mask.
#define	GCAll
	A bit mask for ALL GC properties (used when copying a GC) More...

Functions
static __inline__ Display *	WBGetDefaultDisplay (void)
	Returns the default Display. More...
WB_FONTC	WBGetDefaultFont (void)
	Returns a pointer to the default font WB_FONT for the default display. This is a shared resource; do NOT free it nor alter it! More...
Window	WBGetHiddenHelperWindow (void)
	Returns a special 'hidden' window used for information purposes. More...

Detailed Description

Functions and variables associated with default parameters, and default definitions

Macro Definition Documentation

GCAll

#define GCAll

Value:

(GCFunction | GCPlaneMask | GCForeground | GCBackground | GCLineWidth | \
               GCLineStyle | GCCapStyle | GCJoinStyle | GCFillStyle | GCFillRule | \
               GCTile | GCStipple | GCTileStipXOrigin | GCTileStipYOrigin | GCFont | \
               GCSubwindowMode | GCGraphicsExposures | GCClipXOrigin | GCClipYOrigin | \
               GCClipMask | GCDashOffset | GCDashList | GCArcMode)

A bit mask for ALL GC properties (used when copying a GC)

Definition at line 173 of file window_helper.h.

Function Documentation

WBGetDefaultDisplay()

static __inline__ Display* WBGetDefaultDisplay ( void  )

static

Returns the default Display.

The default display is usually the ONLY display in use by the application. This function returns that Display pointer, which can be used in any case where the current display is not known

See also

WBGetWindowDisplay()

Header File: window_helper.h

Definition at line 814 of file window_helper.h.

WBGetDefaultFont()

WB_FONTC WBGetDefaultFont

(

void

)

Returns a pointer to the default font WB_FONT for the default display. This is a shared resource; do NOT free it nor alter it!

Returns

A pointer to a WB_FONT object (const), or 'NULL' on error. This is a shared resource; do NOT free it nor alter it!

The default WB_FONT is allocated at startup. This function returns its value (not a copy), which can then be used in a case where the 'in use' WB_FONT is not known, or when an overriding font has not been specified.

Header File: window_helper.h

Definition at line 1376 of file window_helper.c.

WBGetHiddenHelperWindow()

Window WBGetHiddenHelperWindow

(

void

)

Returns a special 'hidden' window used for information purposes.

This function returns a special window that was created for information purposes. If you need a window for query purposes that belongs to the default display, you can use the one returned by this function.

Header File: window_helper.h

Definition at line 1417 of file window_helper.c.