X11 Work Bench Toolkit  1.0
Core API

Modules

 ClientMessage Atoms
 
 Window Manager Atoms
 
 Default Parameters
 
 Window 'Core'
 
 Event Handling
 
 Keyboard event handling
 
 Mouse Pointer event handling
 
 Clipboard and Selections
 
 Exposure and Mapping/Visibility
 
 Timer Functions
 

Data Structures

struct  _WBPoint_
 internal wrapper struct for 'point' definition More...
 
struct  _WBExtent_
 internal wrapper struct for 'extent' definition More...
 
struct  _WBRect_
 internal wrapper struct for 'rectangle' definition More...
 
struct  _WBGeom_
 internal wrapper struct for X11 'geometry' definition More...
 

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 GCAll
 A bit mask for ALL GC properties (used when copying a GC) More...
 

Typedefs

typedef struct _WBPoint_ WB_POINT
 internal wrapper struct for 'point' definition More...
 
typedef struct _WBExtent_ WB_EXTENT
 internal wrapper struct for 'extent' definition More...
 
typedef struct _WBRect_ WB_RECT
 internal wrapper struct for 'rectangle' definition More...
 
typedef struct _WBGeom_ WB_GEOM
 internal wrapper struct for X11 'geometry' definition More...
 

Detailed Description

The 'Core' API for the X11workbench Toolkit identifies those functions that implement the most essential functions, such as the creation and destruction of windows, and the main event loop, All programs using the API must correctly initialize and make use of these functions in lieu of calling their X11 counterparts.

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 129 of file window_helper.h.

Typedef Documentation

◆ WB_EXTENT

internal wrapper struct for 'extent' definition

The extent structure has been defined primarily for convenience, so that specific coding methods that work well in GUI environments that use 'extents' can easily be ported into this environment.

typedef struct _WBExtent_
{
unsigned int width; // the 'width' value of the extent.
unsigned int height; // the 'height' value of the extent.

◆ WB_GEOM

internal wrapper struct for X11 'geometry' definition

The geometry structure is a wrapper for the X11 functions that specify the individual parameters for a geometry, such as XGetGeometry. Instead of passing 5 integers, you pass the pointer to a structure for the X11workbench API functions. This provides many advantages over the 'individual parameter' method as well as providing a structure for cacheing geometry information.

typedef struct _WBGeom_
{
int x, y;
unsigned int width, height, border;

Use of 'int' and 'unsigned int' for the various parameter is consistent with the various 'Geom' functions, which typically use 'int *' for returned parameters, as shown:

Status XGetGeometry(Display *display, Drawable d, Window *root_return,
int *x_return, int *y_return,
unsigned int *width_return, unsigned int *height_return,
unsigned int *border_return, unsigned int *depth_return);

◆ WB_POINT

internal wrapper struct for 'point' definition

The point structure has been defined primarily for convenience, so that specific coding methods that work well in GUI environments that use 'points' can easily be ported into this environment.

typedef struct _WBPoint_
{
int x; // the 'x' value of the point. can be negative.
int y; // the 'y' value of the point. can be negative.

Note that this is different from an XPoint structure, which is defined as

typedef struct
{
short x, y;
} XPoint;

◆ WB_RECT

internal wrapper struct for 'rectangle' definition

The rectangle structure has been defined primarily for convenience, so that specific coding methods that work well in GUI environments that use rectangles (instead of 'geometry') can easily be ported into this environment.

typedef struct _WBRect_
{
int left, top, right, bottom;

Note that this is different from an XRectangle structure, which is defined as

typedef struct
{
short x, y;
unsigned short width, height;
} XRectangle;