widget - X11 Widgets

- NAME
- SYNOPSIS
- FUNCTION DESCRIPTIONS

- XColorBrowserWidget
- XCommandWidget
- XConfirmWidget
- XDialogWidget
- XFileBrowserWidget
- XFontBrowserWidget
- XInfoWidget
- XListBrowserWidget
- XMenuWidget
- XMonitorWidget
- XNoticeWidget
- XPreferencesWidget
- XTextViewWidget

# NAME

widget - X11 Widgets

# SYNOPSIS

void XColorBrowserWidget( Display *display, XWindows *windows, const char *action, char *reply );

int XCommandWidget( Display *display, XWindows *windows, const char ** selections, XEvent *event );

int XConfirmWidget( Display *display, XWindows *windows, const char *reason, const char *description );

int XDialogWidget( Display *display, XWindows *windows, const char *action, const char *query, char *reply );

void XFileBrowserWidget( Display *display, XWindows *windows, const char *action, char *reply );

void XFontBrowserWidget( Display *display, XWindows *windows, const char *action, char *reply );

void XInfoWidget( Display *display, XWindows *windows, const char *activity );

void XListBrowserWidget( Display *display, XWindows *windows, XWindowInfo *window_info, const char ** list, const char *action, const char *query, char *reply );

int XMenuWidget( Display *display, XWindows *windows, const char *title, const char ** selections, char *item );

void XMonitorWidget( Display *display, XWindows *windows, const char *task, const magick_int64_t quantum, const magick_uint64_t span );

void XNoticeWidget( Display *display, XWindows *windows, const char *reason, const char *description );

unsigned int XPreferencesWidget( Display *display, XResourceInfo *resource_info, XWindows *windows );

void XTextViewWidget( Display *display, const XResourceInfo *resource_info, XWindows *windows, const unsigned int mono, const char *title, const char ** textlist );

# FUNCTION DESCRIPTIONS

## XColorBrowserWidget

Method XColorBrowserWidget displays a Color Browser widget with a color query to the user. The user keys a reply and presses the Action or Cancel button to exit. The typed text is returned as the reply function parameter.

The format of the XColorBrowserWidget method is:

> void XColorBrowserWidget ( Display *display, XWindows *windows, const char *action, char *reply );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

action:

  Specifies a pointer to the action of this widget.

reply:

  The response from the user is returned in this parameter.

## XCommandWidget

Method XCommandWidget maps a menu and returns the command pointed to by the user when the button is released.

The format of the XCommandWidget method is:

> int XCommandWidget ( Display *display, XWindows *windows, const char **selections, XEvent *event );

A description of each parameter follows:

selection_number:

  Specifies the number of the selection that the user choose.

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

selections:

  Specifies a pointer to one or more strings that comprise the choices in the menu.

event:

  Specifies a pointer to a X11 XEvent structure.

## XConfirmWidget

Method XConfirmWidget displays a Confirm widget with a notice to the user. The function returns -1 if Dismiss is pressed, 0 for Cancel, and 1 for Yes.

The format of the XConfirmWidget method is:

> int XConfirmWidget ( Display *display, XWindows *windows, const char *reason, const char *description );

A description of each parameter follows:

status:

  Method XConfirmWidget returns True if the user presses Yes otherwise False is returned.

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

reason:

  Specifies the message to display before terminating the program.

description:

  Specifies any description to the message.

## XDialogWidget

Method XDialogWidget displays a Dialog widget with a query to the user. The user keys a reply and presses the Ok or Cancel button to exit. The typed text is returned as the reply function parameter.

The format of the XDialogWidget method is:

> int XDialogWidget ( Display *display, XWindows *windows, const char *action, const char *query, char *reply );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

action:

  Specifies a pointer to the action of this widget.

query:

  Specifies a pointer to the query to present to the user.

reply:

  The response from the user is returned in this parameter.

## XFileBrowserWidget

Method XFileBrowserWidget displays a File Browser widget with a file query to the user. The user keys a reply and presses the Action or Cancel button to exit. The typed text is returned as the reply function parameter.

The format of the XFileBrowserWidget method is:

> void XFileBrowserWidget ( Display *display, XWindows *windows, const char *action, char *reply );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

action:

  Specifies a pointer to the action of this widget.

reply:

  The response from the user is returned in this parameter.

## XFontBrowserWidget

Method XFontBrowserWidget displays a Font Browser widget with a font query to the user. The user keys a reply and presses the Action or Cancel button to exit. The typed text is returned as the reply function parameter.

The format of the XFontBrowserWidget method is:

> void XFontBrowserWidget ( Display *display, XWindows *windows, const char *action, char *reply );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

action:

  Specifies a pointer to the action of this widget.

reply:

  The response from the user is returned in this parameter.

## XInfoWidget

Method XInfoWidget displays text in the Info widget. The purpose is to inform the user that what activity is currently being performed (e.g. reading an image, rotating an image, etc.).

The format of the XInfoWidget method is:

> void XInfoWidget ( Display *display, XWindows *windows, const char *activity );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

activity:

  This character string reflects the current activity and is displayed in the Info widget.

## XListBrowserWidget

Method XListBrowserWidget displays a List Browser widget with a query to the user. The user keys a reply or select a reply from the list. Finally, the user presses the Action or Cancel button to exit. The typed text is returned as the reply function parameter.

The format of the XListBrowserWidget method is:

> void XListBrowserWidget ( Display *display, XWindows *windows, XWindowInfo *window_info, const char **list, const char *action, const char *query, char *reply );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

list:

  Specifies a pointer to an array of strings. The user can select from these strings as a possible reply value.

action:

  Specifies a pointer to the action of this widget.

query:

  Specifies a pointer to the query to present to the user.

reply:

  The response from the user is returned in this parameter.

## XMenuWidget

Method XMenuWidget maps a menu and returns the command pointed to by the user when the button is released.

The format of the XMenuWidget method is:

> int XMenuWidget ( Display *display, XWindows *windows, const char *title, const char **selections, char *item );

A description of each parameter follows:

selection_number:

  Specifies the number of the selection that the user choose.

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

title:

  Specifies a character string that describes the menu selections.

selections:

  Specifies a pointer to one or more strings that comprise the choices in the menu.

item:

  Specifies a character array. The item selected from the menu is returned here.

## XMonitorWidget

Method XMonitorWidget displays the progress a task is making in completing a task. A span of zero toggles the active status. An inactive state disables the progress monitor.

The format of the XMonitorWidget method is:

> void XMonitorWidget ( Display *display, XWindows *windows, const char *task, const magick_int64_t quantum, const magick_uint64_t span );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

task:

  Identifies the task in progress.

quantum:

  Specifies the quantum position within the span which represents how much progress has been made in completing a task.

span:

  Specifies the span relative to completing a task.

## XNoticeWidget

Method XNoticeWidget displays a Notice widget with a notice to the user. The function returns when the user presses the ``Dismiss'' button.

The format of the XNoticeWidget method is:

> void XNoticeWidget ( Display *display, XWindows *windows, const char *reason, const char *description );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

window:

  Specifies a pointer to a XWindows structure.

reason:

  Specifies the message to display before terminating the program.

description:

  Specifies any description to the message.

## XPreferencesWidget

Method XPreferencesWidget displays a Preferences widget with program preferences. If the user presses the Apply button, the preferences are stored in a configuration file in the users' home directory.

The format of the XPreferencesWidget method is:

> unsigned int XPreferencesWidget ( Display *display, XResourceInfo *resource_info, XWindows *windows );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

resource_info:

  Specifies a pointer to a X11 XResourceInfo structure.

window:

  Specifies a pointer to a XWindows structure.

## XTextViewWidget

Method XTextViewWidget displays text in a Text View widget.

The format of the XTextViewWidget method is:

> void XTextViewWidget ( Display *display, const XResourceInfo *resource_info, XWindows *windows, const unsigned int mono, const char *title, const char **textlist );

A description of each parameter follows:

display:

  Specifies a connection to an X server; returned from XOpenDisplay.

resource_info:

  Specifies a pointer to a X11 XResourceInfo structure.

window:

  Specifies a pointer to a XWindows structure.

mono:

  Use mono-spaced font when displaying text.

title:

  This character string is displayed at the top of the widget window.

textlist:

  This string list is displayed within the Text View widget.