X11workbench Toolkit  1.0
ClientMessage Event Atoms

Variables

Atom aDIALOG_INIT
 DIALOG_INIT ClientMessage, sent to dialog window callback on frame create. More...
 
Atom aDLGC_PROP_NOTIFY
 DLGC_PROP_NOTIFY ClientMessage, notify control of property change. More...
 
Atom aDLGC_CONTROL_SET
 CONTROL_SET ClientMessage - use this to set specific supported control properties by sending it to the control's window callback. More...
 
Atom aDLGC_CONTROL_GET
 CONTROL_GET ClientMessage - use this to get specific supported control properties by sending it to the control's window callback. More...
 
Atom aCONTROL_NOTIFY
 dialog control and child window notification messages More...
 
Atom aDLG_FOCUS
 dialog focus messages More...
 

Detailed Description

Atoms for ClientMessage Events associated with Dialog Boxes

The following atoms are used by dialog windows in ClientMessage events, for intercommunication between controls and the dialog frame window, to command the dialog box window (or a control) to perform a specific function, or to notify the dialog box callback function of certain events (like dialog box initialization or control activation).

Variable Documentation

◆ aCONTROL_NOTIFY

Atom aCONTROL_NOTIFY

dialog control and child window notification messages

These events are posted to the owning window (or dialog box frame) for controls that are members of the dialog box or window. These provide a powerful asynchronous method by which you can handle user input and other information directly from the control windows.

CONTROL_NOTIFY message format (relative to XEvent.xclient)

type == ClientMessage
message_type == aCONTROL_NOTIFY
format == 32 (always)
data.l[0] contains the dialog control ID (or -1 if N/A)
data.l[1] is the notify code
data.l[2] is window ID

Other data elements are specific to the type notify code being used.
For more information, see: Notification Atoms

Definition at line 256 of file window_helper.c.

◆ aDIALOG_INIT

Atom aDIALOG_INIT

DIALOG_INIT ClientMessage, sent to dialog window callback on frame create.

DIALOG_INIT message format (relative to XEvent.xclient)
type == ClientMessage
message_type == aDIALOG_INIT
format == 32 (always)

Definition at line 358 of file dialog_support.c.

◆ aDLG_FOCUS

Atom aDLG_FOCUS

dialog focus messages

DLG_FOCUS message format (relative to XEvent.xclient)

type == ClientMessage
message_type == aDLG_FOCUS
format == 32 (always)
data.l[0] is a tri-state value as follows

  • less than zero for 'previous window'
  • greater than zero for 'next window'
  • equal to zero for 'set to this window'

for data.l[0] == 0

  • data.l[1] is the control id to set focus to
  • data.l[2] is non-zero if the control focus was assigned via a hot-key, else zero.

by convention, all remaining entries in 'data.l' should be zero

Definition at line 360 of file window_helper.c.

◆ aDLGC_CONTROL_GET

Atom aDLGC_CONTROL_GET

CONTROL_GET ClientMessage - use this to get specific supported control properties by sending it to the control's window callback.

CONTROL_GET message format (relative to XEvent.xclient)
type == ClientMessage
message_type == aCONTROL_GET
format == 32 (always)
data.l[0] == control property identifier
The return value from the message will be the desired property, either as an Atom or as a 32-bit integer. A value of '0' or 'None' may be returned if this property is not supported; control properties should be carefully set up to allow for this.

See also
ControlGetSetProperties

Definition at line 417 of file dialog_support.c.

◆ aDLGC_CONTROL_SET

Atom aDLGC_CONTROL_SET

CONTROL_SET ClientMessage - use this to set specific supported control properties by sending it to the control's window callback.

CONTROL_SET message format (relative to XEvent.xclient)
type == ClientMessage
message_type == aCONTROL_SET
format == 32 (always)
data.l[0] == control property identifier
data.l[1] == new value (Atom or 32-bit integer)

See also
ControlGetSetProperties

Definition at line 399 of file dialog_support.c.

◆ aDLGC_PROP_NOTIFY

Atom aDLGC_PROP_NOTIFY

DLGC_PROP_NOTIFY ClientMessage, notify control of property change.

DLGC_PROP_NOTIFY message format (relative to XEvent.xclient)
type == ClientMessage
message_type == aDLGC_PROP_NOTIFY
format == 32 (always)
data.l[0] == Atom of property that changed

Definition at line 370 of file dialog_support.c.