<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>widget - X11 Widgets</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:bfriesen@freddy.simplesystems.org" /> </head> <body style="background-color: white"> <P><a name="__index__"></a></P> <!-- INDEX BEGIN --> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li> <ul> <li><a href="#xcolorbrowserwidget">XColorBrowserWidget</a></li> <li><a href="#xcommandwidget">XCommandWidget</a></li> <li><a href="#xconfirmwidget">XConfirmWidget</a></li> <li><a href="#xdialogwidget">XDialogWidget</a></li> <li><a href="#xfilebrowserwidget">XFileBrowserWidget</a></li> <li><a href="#xfontbrowserwidget">XFontBrowserWidget</a></li> <li><a href="#xinfowidget">XInfoWidget</a></li> <li><a href="#xlistbrowserwidget">XListBrowserWidget</a></li> <li><a href="#xmenuwidget">XMenuWidget</a></li> <li><a href="#xmonitorwidget">XMonitorWidget</a></li> <li><a href="#xnoticewidget">XNoticeWidget</a></li> <li><a href="#xpreferenceswidget">XPreferencesWidget</a></li> <li><a href="#xtextviewwidget">XTextViewWidget</a></li> </ul> </ul> <!-- INDEX END --> <hr /> <P> </P> <h1><a name="name">NAME</a></h1> <P>widget - X11 Widgets</P> <P> </P> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <P>void Magick <strong>XColorBrowserWidget</strong>( Display *display, MagickXWindows *windows, const char *action, char *reply );</P> <P>int Magick <strong>XCommandWidget</strong>( Display *display, MagickXWindows *windows, const char ** selections, XEvent *event );</P> <P>int Magick <strong>XConfirmWidget</strong>( Display *display, MagickXWindows *windows, const char *reason, const char *description );</P> <P>int Magick <strong>XDialogWidget</strong>( Display *display, MagickXWindows *windows, const char *action, const char *query, char *reply );</P> <P>void Magick <strong>XFileBrowserWidget</strong>( Display *display, MagickXWindows *windows, const char *action, char *reply );</P> <P>void Magick <strong>XFontBrowserWidget</strong>( Display *display, MagickXWindows *windows, const char *action, char *reply );</P> <P>void Magick <strong>XInfoWidget</strong>( Display *display, MagickXWindows *windows, const char *activity );</P> <P>void Magick <strong>XListBrowserWidget</strong>( Display *display, MagickXWindows *windows, MagickXWindowInfo *window_info, const char ** list, const char *action, const char *query, char *reply );</P> <P>int Magick <strong>XMenuWidget</strong>( Display *display, MagickXWindows *windows, const char *title, const char ** selections, char *item );</P> <P>void Magick <strong>XMonitorWidget</strong>( Display *display, MagickXWindows *windows, const char *task, const magick_int64_t quantum, const magick_uint64_t span );</P> <P>void Magick <strong>XNoticeWidget</strong>( Display *display, MagickXWindows *windows, const char *reason, const char *description );</P> <P>unsigned int Magick <strong>XPreferencesWidget</strong>( Display *display, MagickXResourceInfo *resource_info, MagickXWindows *windows );</P> <P>void Magick <strong>XTextViewWidget</strong>( Display *display, const MagickXResourceInfo *resource_info, MagickXWindows *windows, const unsigned int mono, const char *title, const char ** textlist );</P> <P> </P> <hr /> <h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1> <P> </P> <h2><a name="xcolorbrowserwidget">XColorBrowserWidget</a></h2> <P>Method MagickXColorBrowserWidget 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 MagickXColorBrowserWidget method is:</P> <blockquote>void MagickXColorBrowserWidget ( Display *display, MagickXWindows *windows, const char *action, char *reply ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_display_3a">display:</a></strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong><a name="item_o_window_3a">window:</a></strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_action_3a">action:</a></strong> <DD> <P>Specifies a pointer to the action of this widget.</P> </dd> </li> <dt><strong><a name="item_o_reply_3a">reply:</a></strong> <DD> <P>The response from the user is returned in this parameter.</P> </dd> </li> </dl> <P> </P> <h2><a name="xcommandwidget">XCommandWidget</a></h2> <P>Method MagickXCommandWidget maps a menu and returns the command pointed to by the user when the button is released.</P> <P>The format of the MagickXCommandWidget method is:</P> <blockquote>int MagickXCommandWidget ( Display *display, MagickXWindows *windows, const char **selections, XEvent *event ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_selection_number_3a">selection_number:</a></strong> <DD> <P>Specifies the number of the selection that the user choose.</P> </dd> </li> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_selections_3a">selections:</a></strong> <DD> <P>Specifies a pointer to one or more strings that comprise the choices in the menu.</P> </dd> </li> <dt><strong><a name="item_o_event_3a">event:</a></strong> <DD> <P>Specifies a pointer to a X11 XEvent structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="xconfirmwidget">XConfirmWidget</a></h2> <P>Method MagickXConfirmWidget 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 MagickXConfirmWidget method is:</P> <blockquote>int MagickXConfirmWidget ( Display *display, MagickXWindows *windows, const char *reason, const char *description ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong><a name="item_o_status_3a">status:</a></strong> <DD> <P>Method MagickXConfirmWidget returns True if the user presses Yes otherwise False is returned.</P> </dd> </li> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_reason_3a">reason:</a></strong> <DD> <P>Specifies the message to display before terminating the program.</P> </dd> </li> <dt><strong><a name="item_o_description_3a">description:</a></strong> <DD> <P>Specifies any description to the message.</P> </dd> </li> </dl> <P> </P> <h2><a name="xdialogwidget">XDialogWidget</a></h2> <P>Method MagickXDialogWidget 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 MagickXDialogWidget method is:</P> <blockquote>int MagickXDialogWidget ( Display *display, MagickXWindows *windows, const char *action, const char *query, char *reply ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong>action:</strong> <DD> <P>Specifies a pointer to the action of this widget.</P> </dd> </li> <dt><strong><a name="item_o_query_3a">query:</a></strong> <DD> <P>Specifies a pointer to the query to present to the user.</P> </dd> </li> <dt><strong>reply:</strong> <DD> <P>The response from the user is returned in this parameter.</P> </dd> </li> </dl> <P> </P> <h2><a name="xfilebrowserwidget">XFileBrowserWidget</a></h2> <P>Method MagickXFileBrowserWidget 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 MagickXFileBrowserWidget method is:</P> <blockquote>void MagickXFileBrowserWidget ( Display *display, MagickXWindows *windows, const char *action, char *reply ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong>action:</strong> <DD> <P>Specifies a pointer to the action of this widget.</P> </dd> </li> <dt><strong>reply:</strong> <DD> <P>The response from the user is returned in this parameter.</P> </dd> </li> </dl> <P> </P> <h2><a name="xfontbrowserwidget">XFontBrowserWidget</a></h2> <P>Method MagickXFontBrowserWidget 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 MagickXFontBrowserWidget method is:</P> <blockquote>void MagickXFontBrowserWidget ( Display *display, MagickXWindows *windows, const char *action, char *reply ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong>action:</strong> <DD> <P>Specifies a pointer to the action of this widget.</P> </dd> </li> <dt><strong>reply:</strong> <DD> <P>The response from the user is returned in this parameter.</P> </dd> </li> </dl> <P> </P> <h2><a name="xinfowidget">XInfoWidget</a></h2> <P>Method MagickXInfoWidget 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 MagickXInfoWidget method is:</P> <blockquote>void MagickXInfoWidget ( Display *display, MagickXWindows *windows, const char *activity ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_activity_3a">activity:</a></strong> <DD> <P>This character string reflects the current activity and is displayed in the Info widget.</P> </dd> </li> </dl> <P> </P> <h2><a name="xlistbrowserwidget">XListBrowserWidget</a></h2> <P>Method MagickXListBrowserWidget 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 MagickXListBrowserWidget method is:</P> <blockquote>void MagickXListBrowserWidget ( Display *display, MagickXWindows *windows, MagickXWindowInfo *window_info, const char **list, const char *action, const char *query, char *reply ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_list_3a">list:</a></strong> <DD> <P>Specifies a pointer to an array of strings. The user can select from these strings as a possible reply value.</P> </dd> </li> <dt><strong>action:</strong> <DD> <P>Specifies a pointer to the action of this widget.</P> </dd> </li> <dt><strong>query:</strong> <DD> <P>Specifies a pointer to the query to present to the user.</P> </dd> </li> <dt><strong>reply:</strong> <DD> <P>The response from the user is returned in this parameter.</P> </dd> </li> </dl> <P> </P> <h2><a name="xmenuwidget">XMenuWidget</a></h2> <P>Method MagickXMenuWidget maps a menu and returns the command pointed to by the user when the button is released.</P> <P>The format of the MagickXMenuWidget method is:</P> <blockquote>int MagickXMenuWidget ( Display *display, MagickXWindows *windows, const char *title, const char **selections, char *item ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>selection_number:</strong> <DD> <P>Specifies the number of the selection that the user choose.</P> </dd> </li> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_title_3a">title:</a></strong> <DD> <P>Specifies a character string that describes the menu selections.</P> </dd> </li> <dt><strong>selections:</strong> <DD> <P>Specifies a pointer to one or more strings that comprise the choices in the menu.</P> </dd> </li> <dt><strong><a name="item_o_item_3a">item:</a></strong> <DD> <P>Specifies a character array. The item selected from the menu is returned here.</P> </dd> </li> </dl> <P> </P> <h2><a name="xmonitorwidget">XMonitorWidget</a></h2> <P>Method MagickXMonitorWidget 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.</P> <P>The format of the MagickXMonitorWidget method is:</P> <blockquote>void MagickXMonitorWidget ( Display *display, MagickXWindows *windows, const char *task, const magick_int64_t quantum, const magick_uint64_t span ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_task_3a">task:</a></strong> <DD> <P>Identifies the task in progress.</P> </dd> </li> <dt><strong><a name="item_o_quantum_3a">quantum:</a></strong> <DD> <P>Specifies the quantum position within the span which represents how much progress has been made in completing a task.</P> </dd> </li> <dt><strong><a name="item_o_span_3a">span:</a></strong> <DD> <P>Specifies the span relative to completing a task.</P> </dd> </li> </dl> <P> </P> <h2><a name="xnoticewidget">XNoticeWidget</a></h2> <P>Method MagickXNoticeWidget 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 MagickXNoticeWidget method is:</P> <blockquote>void MagickXNoticeWidget ( Display *display, MagickXWindows *windows, const char *reason, const char *description ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong>reason:</strong> <DD> <P>Specifies the message to display before terminating the program.</P> </dd> </li> <dt><strong>description:</strong> <DD> <P>Specifies any description to the message.</P> </dd> </li> </dl> <P> </P> <h2><a name="xpreferenceswidget">XPreferencesWidget</a></h2> <P>Method MagickXPreferencesWidget 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 MagickXPreferencesWidget method is:</P> <blockquote>unsigned int MagickXPreferencesWidget ( Display *display, MagickXResourceInfo *resource_info, MagickXWindows *windows ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong><a name="item_o_resource_info_3a">resource_info:</a></strong> <DD> <P>Specifies a pointer to a X11 MagickXResourceInfo structure.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> </dl> <P> </P> <h2><a name="xtextviewwidget">XTextViewWidget</a></h2> <P>Method MagickXTextViewWidget displays text in a Text View widget.</P> <P>The format of the MagickXTextViewWidget method is:</P> <blockquote>void MagickXTextViewWidget ( Display *display, const MagickXResourceInfo *resource_info, MagickXWindows *windows, const unsigned int mono, const char *title, const char **textlist ); </blockquote><P>A description of each parameter follows:</P> <dl> <dt><strong>display:</strong> <DD> <P>Specifies a connection to an X server; returned from XOpenDisplay.</P> </dd> </li> <dt><strong>resource_info:</strong> <DD> <P>Specifies a pointer to a X11 MagickXResourceInfo structure.</P> </dd> </li> <dt><strong>window:</strong> <DD> <P>Specifies a pointer to a MagickXWindows structure.</P> </dd> </li> <dt><strong><a name="item_o_mono_3a">mono:</a></strong> <DD> <P>Use mono-spaced font when displaying text.</P> </dd> </li> <dt><strong>title:</strong> <DD> <P>This character string is displayed at the top of the widget window.</P> </dd> </li> <dt><strong><a name="item_o_textlist_3a">textlist:</a></strong> <DD> <P>This string list is displayed within the Text View widget.</P> </dd> </dl> </body> </html>
