<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><HTML> <HEAD><meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <TITLE>NAME</TITLE> <link rel="StyleSheet" href="../magick.css" type="text/css"> </HEAD> <body bgcolor="#FFFFFF" text="#000000" link="#0085c0" alink="#0085c0" vlink="#800080"> <A NAME="__index__"></A> <!-- INDEX BEGIN --> <UL> <LI><A HREF="#name"> <FONT SIZE=-1>NAME</FONT></A> <LI><A HREF="#synopsis"> <FONT SIZE=-1>SYNOPSIS</FONT></A> <LI><A HREF="#function descriptions"> <FONT SIZE=-1>FUNCTION</FONT> <FONT SIZE=-1>DESCRIPTIONS</FONT></A> <UL> <LI><A HREF="#xcolorbrowserwidget">XColorBrowserWidget</A> <LI><A HREF="#xcommandwidget">XCommandWidget</A> <LI><A HREF="#xconfirmwidget">XConfirmWidget</A> <LI><A HREF="#xdialogwidget">XDialogWidget</A> <LI><A HREF="#xfilebrowserwidget">XFileBrowserWidget</A> <LI><A HREF="#xfontbrowserwidget">XFontBrowserWidget</A> <LI><A HREF="#xinfowidget">XInfoWidget</A> <LI><A HREF="#xlistbrowserwidget">XListBrowserWidget</A> <LI><A HREF="#xmenuwidget">XMenuWidget</A> <LI><A HREF="#xmonitorwidget">XMonitorWidget</A> <LI><A HREF="#xnoticewidget">XNoticeWidget</A> <LI><A HREF="#xpreferenceswidget">XPreferencesWidget</A> <LI><A HREF="#xtextviewwidget">XTextViewWidget</A> </UL> </UL> <!-- INDEX END --> <HR> <P> <H1><A NAME="name"> <FONT SIZE=-1>NAME</FONT></A></H1> <P>widget -</P> <P> <HR> <H1><A NAME="synopsis"> <FONT SIZE=-1>SYNOPSIS</FONT></A></H1> <P>void <STRONG>XColorBrowserWidget</STRONG>( Display *display, XWindows *windows, const char *action, char *reply );</P> <P>int <STRONG>XCommandWidget</STRONG>( Display *display, XWindows *windows, const char ** selections, XEvent *event );</P> <P>int <STRONG>XConfirmWidget</STRONG>( Display *display, XWindows *windows, const char *reason, const char *description );</P> <P>int <STRONG>XDialogWidget</STRONG>( Display *display, XWindows *windows, const char *action, const char *query, char *reply );</P> <P>void <STRONG>XFileBrowserWidget</STRONG>( Display *display, XWindows *windows, const char *action, char *reply );</P> <P>void <STRONG>XFontBrowserWidget</STRONG>( Display *display, XWindows *windows, const char *action, char *reply );</P> <P>void <STRONG>XInfoWidget</STRONG>( Display *display, XWindows *windows, const char *activity );</P> <P>void <STRONG>XListBrowserWidget</STRONG>( Display *display, XWindows *windows, XWindowInfo *window_info, const char ** list, const char *action, const char *query, char *reply );</P> <P>int <STRONG>XMenuWidget</STRONG>( Display *display, XWindows *windows, const char *title, const char ** selections, char *item );</P> <P>void <STRONG>XMonitorWidget</STRONG>( Display *display, XWindows *windows, const char *task, const off_t quantum, const off_t span );</P> <P>void <STRONG>XNoticeWidget</STRONG>( Display *display, XWindows *windows, const char *reason, const char *description );</P> <P>unsigned int <STRONG>XPreferencesWidget</STRONG>( Display *display, XResourceInfo *resource_info, XWindows *windows );</P> <P>void <STRONG>XTextViewWidget</STRONG>( Display *display, const XResourceInfo *resource_info, XWindows *windows, const unsigned int mono, const char *title, const char ** textlist );</P> <P> <HR> <H1><A NAME="function descriptions"> <FONT SIZE=-1>FUNCTION</FONT> <FONT SIZE=-1>DESCRIPTIONS</FONT></A></H1> <P> <H2><A NAME="xcolorbrowserwidget">XColorBrowserWidget</A></H2> <P>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.</P> <P>The format of the XColorBrowserWidget method is:</P> <blockquote>void XColorBrowserWidget ( Display *display, XWindows *windows, const char *action, char *reply ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG><A NAME="item_o_display%3A">display:</A></STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_window%3A">window:</A></STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_action%3A">action:</A></STRONG><BR> <DD> Specifies a pointer to the action of this widget. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_reply%3A">reply:</A></STRONG><BR> <DD> The response from the user is returned in this parameter. <P></P></DL></DL> <P> <H2><A NAME="xcommandwidget">XCommandWidget</A></H2> <P>Method XCommandWidget maps a menu and returns the command pointed to by the user when the button is released.</P> <P>The format of the XCommandWidget method is:</P> <blockquote>int XCommandWidget ( Display *display, XWindows *windows, const char **selections, XEvent *event ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG><A NAME="item_o_selection_number%3A">selection_number:</A></STRONG><BR> <DD> Specifies the number of the selection that the user choose. <P></P> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_selections%3A">selections:</A></STRONG><BR> <DD> Specifies a pointer to one or more strings that comprise the choices in the menu. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_event%3A">event:</A></STRONG><BR> <DD> Specifies a pointer to a <FONT SIZE=-1>X11</FONT> XEvent structure. <P></P></DL></DL> <P> <H2><A NAME="xconfirmwidget">XConfirmWidget</A></H2> <P>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.</P> <P>The format of the XConfirmWidget method is:</P> <blockquote>int XConfirmWidget ( Display *display, XWindows *windows, const char *reason, const char *description ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG><A NAME="item_o_status%3A">status:</A></STRONG><BR> <DD> Method XConfirmWidget returns True if the user presses Yes otherwise False is returned. <P></P> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_reason%3A">reason:</A></STRONG><BR> <DD> Specifies the message to display before terminating the program. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_description%3A">description:</A></STRONG><BR> <DD> Specifies any description to the message. <P></P></DL></DL> <P> <H2><A NAME="xdialogwidget">XDialogWidget</A></H2> <P>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.</P> <P>The format of the XDialogWidget method is:</P> <blockquote>int XDialogWidget ( Display *display, XWindows *windows, const char *action, const char *query, char *reply ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG>action:</STRONG><BR> <DD> Specifies a pointer to the action of this widget. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_query%3A">query:</A></STRONG><BR> <DD> Specifies a pointer to the query to present to the user. <P></P> <dd><p></p><dt><STRONG>reply:</STRONG><BR> <DD> The response from the user is returned in this parameter. <P></P></DL></DL> <P> <H2><A NAME="xfilebrowserwidget">XFileBrowserWidget</A></H2> <P>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.</P> <P>The format of the XFileBrowserWidget method is:</P> <blockquote>void XFileBrowserWidget ( Display *display, XWindows *windows, const char *action, char *reply ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG>action:</STRONG><BR> <DD> Specifies a pointer to the action of this widget. <P></P> <dd><p></p><dt><STRONG>reply:</STRONG><BR> <DD> The response from the user is returned in this parameter. <P></P></DL></DL> <P> <H2><A NAME="xfontbrowserwidget">XFontBrowserWidget</A></H2> <P>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.</P> <P>The format of the XFontBrowserWidget method is:</P> <blockquote>void XFontBrowserWidget ( Display *display, XWindows *windows, const char *action, char *reply ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG>action:</STRONG><BR> <DD> Specifies a pointer to the action of this widget. <P></P> <dd><p></p><dt><STRONG>reply:</STRONG><BR> <DD> The response from the user is returned in this parameter. <P></P></DL></DL> <P> <H2><A NAME="xinfowidget">XInfoWidget</A></H2> <P>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.).</P> <P>The format of the XInfoWidget method is:</P> <blockquote>void XInfoWidget ( Display *display, XWindows *windows, const char *activity ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_activity%3A">activity:</A></STRONG><BR> <DD> This character string reflects the current activity and is displayed in the Info widget. <P></P></DL></DL> <P> <H2><A NAME="xlistbrowserwidget">XListBrowserWidget</A></H2> <P>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.</P> <P>The format of the XListBrowserWidget method is:</P> <blockquote>void XListBrowserWidget ( Display *display, XWindows *windows, XWindowInfo *window_info, const char **list, const char *action, const char *query, char *reply ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_list%3A">list:</A></STRONG><BR> <DD> Specifies a pointer to an array of strings. The user can select from these strings as a possible reply value. <P></P> <dd><p></p><dt><STRONG>action:</STRONG><BR> <DD> Specifies a pointer to the action of this widget. <P></P> <dd><p></p><dt><STRONG>query:</STRONG><BR> <DD> Specifies a pointer to the query to present to the user. <P></P> <dd><p></p><dt><STRONG>reply:</STRONG><BR> <DD> The response from the user is returned in this parameter. <P></P></DL></DL> <P> <H2><A NAME="xmenuwidget">XMenuWidget</A></H2> <P>Method XMenuWidget maps a menu and returns the command pointed to by the user when the button is released.</P> <P>The format of the XMenuWidget method is:</P> <blockquote>int XMenuWidget ( Display *display, XWindows *windows, const char *title, const char **selections, char *item ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>selection_number:</STRONG><BR> <DD> Specifies the number of the selection that the user choose. <P></P> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_title%3A">title:</A></STRONG><BR> <DD> Specifies a character string that describes the menu selections. <P></P> <dd><p></p><dt><STRONG>selections:</STRONG><BR> <DD> Specifies a pointer to one or more strings that comprise the choices in the menu. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_item%3A">item:</A></STRONG><BR> <DD> Specifies a character array. The item selected from the menu is returned here. <P></P></DL></DL> <P> <H2><A NAME="xmonitorwidget">XMonitorWidget</A></H2> <P>Method XMonitorWidget displays the progress a task is making in completing a task. <FONT SIZE=-1>A</FONT> span of zero toggles the active status. An inactive state disables the progress monitor.</P> <P>The format of the XMonitorWidget method is:</P> <blockquote>void XMonitorWidget ( Display *display, XWindows *windows, const char *task, const off_t quantum, const off_t span ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_task%3A">task:</A></STRONG><BR> <DD> Identifies the task in progress. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_quantum%3A">quantum:</A></STRONG><BR> <DD> Specifies the quantum position within the span which represents how much progress has been made in completing a task. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_span%3A">span:</A></STRONG><BR> <DD> Specifies the span relative to completing a task. <P></P></DL></DL> <P> <H2><A NAME="xnoticewidget">XNoticeWidget</A></H2> <P>Method XNoticeWidget displays a Notice widget with a notice to the user. The function returns when the user presses the ``Dismiss'' button.</P> <P>The format of the XNoticeWidget method is:</P> <blockquote>void XNoticeWidget ( Display *display, XWindows *windows, const char *reason, const char *description ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG>reason:</STRONG><BR> <DD> Specifies the message to display before terminating the program. <P></P> <dd><p></p><dt><STRONG>description:</STRONG><BR> <DD> Specifies any description to the message. <P></P></DL></DL> <P> <H2><A NAME="xpreferenceswidget">XPreferencesWidget</A></H2> <P>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.</P> <P>The format of the XPreferencesWidget method is:</P> <blockquote>unsigned int XPreferencesWidget ( Display *display, <A HREF="types/XResourceInfo.html">XResourceInfo</A> *resource_info, XWindows *windows ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_resource_info%3A">resource_info:</A></STRONG><BR> <DD> Specifies a pointer to a <FONT SIZE=-1>X11</FONT> XResourceInfo structure. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P></DL></DL> <P> <H2><A NAME="xtextviewwidget">XTextViewWidget</A></H2> <P>Method XTextViewWidget displays text in a Text View widget.</P> <P>The format of the XTextViewWidget method is:</P> <blockquote>void XTextViewWidget ( Display *display, const <A HREF="types/XResourceInfo.html">XResourceInfo</A> *resource_info, XWindows *windows, const unsigned int mono, const char *title, const char **textlist ); </blockquote><P> <FONT SIZE=-1>A</FONT> description of each parameter follows:</P> <DL><DT><DD><DL> <dd><p></p><dt><STRONG>display:</STRONG><BR> <DD> Specifies a connection to an <FONT SIZE=-1>X</FONT> server; returned from XOpenDisplay. <P></P> <dd><p></p><dt><STRONG>resource_info:</STRONG><BR> <DD> Specifies a pointer to a <FONT SIZE=-1>X11</FONT> XResourceInfo structure. <P></P> <dd><p></p><dt><STRONG>window:</STRONG><BR> <DD> Specifies a pointer to a XWindows structure. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_mono%3A">mono:</A></STRONG><BR> <DD> Use mono-spaced font when displaying text. <P></P> <dd><p></p><dt><STRONG>title:</STRONG><BR> <DD> This character string is displayed at the top of the widget window. <P></P> <dd><p></p><dt><STRONG><A NAME="item_o_textlist%3A">textlist:</A></STRONG><BR> <DD> This string list is displayed within the Text View widget. </DL></DL> </BODY> </HTML>
