m+INAME>j Pair








NAME



widget -






(

SYNOPSIS

z

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 );

y

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

y

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

g

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 off_t quantum, const size_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 );






B

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.

7

The format of the XColorBrowserWidget method is:

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

A description of each parameter follows:


E
o display:


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


C
o window:


,Specifies a pointer to a XWindows structure.


C
o action:


1Specifies a pointer to the action of this widget.


A
o reply:


9The response from the user is returned in this parameter.





4

XCommandWidget

t

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

2

The format of the XCommandWidget method is:

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

A description of each parameter follows:


W
o selection_number:


;Specifies the number of the selection that the user choose.


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


K
o selections:


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


A
o event:


.Specifies a pointer to a X11 XEvent structure.





4

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.

2

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:


C
o status:


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


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


C
o reason:


@Specifies the message to display before terminating the program.


M
o description:


)Specifies any description to the message.





2

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.

1

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:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


$
o action:


1Specifies a pointer to the action of this widget.


A
o query:


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


#
o reply:


9The 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.

6

The format of the XFileBrowserWidget method is:

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

A description of each parameter follows:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


$
o action:


1Specifies a pointer to the action of this widget.


#
o reply:


9The 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.

6

The format of the XFontBrowserWidget method is:

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

A description of each parameter follows:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


$
o action:


1Specifies a pointer to the action of this widget.


#
o reply:


9The 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:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


G
o activity:


XThis 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.

6

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:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


?
o list:


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


$
o action:


1Specifies a pointer to the action of this widget.


#
o query:


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


#
o reply:


9The response from the user is returned in this parameter.





.

XMenuWidget

q

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:


.
o selection_number:


;Specifies the number of the selection that the user choose.


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


A
o title:


@Specifies a character string that describes the menu selections.


(
o selections:


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


?
o item:


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





4

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.

2

The format of the XMonitorWidget method is:

¿
void XMonitorWidget ( Display *display, XWindows *windows, const char *task, const off_t quantum, const size_t span );

A description of each parameter follows:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


?
o task:


Identifies the task in progress.


E
o quantum:


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


?
o span:


1Specifies the span relative to completing a task.





2

XNoticeWidget

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

1

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:


%
o display:


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


$
o window:


,Specifies a pointer to a XWindows structure.


$
o reason:


@Specifies the message to display before terminating the program.


)
o 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.

6

The format of the XPreferencesWidget method is:

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

A description of each parameter follows:


%
o display:


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


Q
o resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.


$
o window:


,Specifies a pointer to a XWindows structure.





6

XTextViewWidget

B

Method XTextViewWidget displays text in a Text View widget.

3

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:


%
o display:


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


+
o resource_info:


5Specifies a pointer to a X11 XResourceInfo structure.


$
o window:


,Specifies a pointer to a XWindows structure.


?
o mono:


*Use mono-spaced font when displaying text.


#
o title:


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


G
o textlist:


:This string list is displayed within the Text View widget.