NAME

widget - X11 User Interface Routines for ImageMagick

SYNOPSIS

XColorBrowserWidget(display,windows,action,reply)

selection_number=XCommandWidget(display,windows,selections,event)

status=XConfirmWidget(display,windows,message,qualifier)

XDialogWidget(display,windows,action,query,reply)

XFileBrowserWidget(display,windows,action,reply)

XFontBrowserWidget(display,windows,action,reply)

XInfoWidget(display,windows,activity)

XListBrowserWidget(display,windows,window_info,list,action,query,reply)

selection_number=XMenuWidget(display,windows,title,selections,item)

XMonitorWidget(display,windows,task,quantum,span)

XNoticeWidget(display,windows,message,qualifier)

XPreferencesWidget(display,resource_info,windows)

XTextViewWidget(display,resource_info,windows,mono,title,textlist)

FUNCTION DESCRIPTIONS

XColorBrowserWidget

Function 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 routine is: 

      XColorBrowserWidget(display,windows,action,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

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

The format of the XCommandWidget routine is: 

      selection_number=XCommandWidget(display,windows,selections,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

Function 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 routine is: 

      status=XConfirmWidget(display,windows,message,qualifier)

A description of each parameter follows:

status:
Function 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.

message:
Specifies the message to display before terminating the program.

qualifier:
Specifies any qualifier to the message.

XDialogWidget

Function 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 routine is: 

      XDialogWidget(display,windows,action,query,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

Function 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 routine is: 

      XFileBrowserWidget(display,windows,action,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

Function 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 routine is: 

      XFontBrowserWidget(display,windows,action,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

Function 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 routine is: 

      XInfoWidget(display,windows,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

Function 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 routine is: 

      XListBrowserWidget(display,windows,window_info,list,action,query,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

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

The format of the XMenuWidget routine is: 

      selection_number=XMenuWidget(display,windows,title,selections,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

Function 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 routine is: 

      XMonitorWidget(display,windows,task,quantum,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

Function 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 routine is: 

      XNoticeWidget(display,windows,message,qualifier)

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.

message:
Specifies the message to display before terminating the program.

qualifier:
Specifies any qualifier to the message.

XPreferencesWidget

Function 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 routine is: 

      XPreferencesWidget(display,resource_info,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

Function XTextViewWidget displays text in a Text View widget.

The format of the XTextViewWidget routine is: 

      XTextViewWidget(display,resource_info,windows,mono,title,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.