X11workbench Toolkit  1.0
Pointer/Cursor management

Functions

void WBSetWindowDefaultCursor (Window wID, int idStandardCursor)
 Assigns a default cursor (by ID) to a window. More...
 
int WBGetWindowDefaultCursor (Window wID)
 returns the default cursor ID for a window More...
 
void WBBeginWaitCursor (Window wID)
 increment 'wait cursor' count, set cursor to WB_WAIT_CURSOR More...
 
void WBEndWaitCursor (Window wID)
 decrement 'wait cursor' count, restore to default when zero More...
 
void WBSetWindowCursor (Window wID, int idCursor)
 immediately set the window cursor More...
 
void WBRestoreDefaultCursor (Window wID)
 restore the default cursor More...
 

Detailed Description

Window-related API for managing the window's cursor. The cursor can be changed depending on the current context, and is a property of the window itself.

Use these API funtions to manage the cursor for a particular window.

See Also: WB_DEFAULT_CURSOR, WB_WAIT_CURSOR

Function Documentation

◆ WBBeginWaitCursor()

void WBBeginWaitCursor ( Window  wID)

increment 'wait cursor' count, set cursor to WB_WAIT_CURSOR

Parameters
wIDThe Window ID to which the wait cursor needs to be assigned

Header File: window_helper.h

Definition at line 6358 of file window_helper.c.

◆ WBEndWaitCursor()

void WBEndWaitCursor ( Window  wID)

decrement 'wait cursor' count, restore to default when zero

Parameters
wIDThe Window ID to which the cursor needs to be restored

Header File: window_helper.h

Definition at line 6399 of file window_helper.c.

◆ WBGetWindowDefaultCursor()

int WBGetWindowDefaultCursor ( Window  wID)

returns the default cursor ID for a window

Parameters
wIDThe Window ID from which to return the default cursor
Returns
The Cursor ID (Typically an XC_ definition from X11/cursorfont.h). A value of '-1' equates to 'None'

Header File: window_helper.h

Definition at line 6348 of file window_helper.c.

◆ WBRestoreDefaultCursor()

void WBRestoreDefaultCursor ( Window  wID)

restore the default cursor

Parameters
wIDThe Window ID to which the default cursor needs to be restored

Header File: window_helper.h

Definition at line 6459 of file window_helper.c.

◆ WBSetWindowCursor()

void WBSetWindowCursor ( Window  wID,
int  idCursor 
)

immediately set the window cursor

Parameters
wIDThe Window ID to which the cursor needs to be assigned
idCursorThe Cursor ID (Typically an XC_ definition from X11/cursorfont.h). A value of '-1' equates to 'None'

Header File: window_helper.h

Definition at line 6447 of file window_helper.c.

◆ WBSetWindowDefaultCursor()

void WBSetWindowDefaultCursor ( Window  wID,
int  idStandardCursor 
)

Assigns a default cursor (by ID) to a window.

Parameters
wIDThe Window ID to which to assign the default cursor
idStandardCursorThe default Cursor ID to assign (Typically an XC_ definition from X11/cursorfont.h). A value of '-1' equates to 'None'

Header File: window_helper.h

Definition at line 6335 of file window_helper.c.