summaryrefslogtreecommitdiff
path: root/www/api/widget.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/api/widget.html')
-rw-r--r--www/api/widget.html460
1 files changed, 237 insertions, 223 deletions
diff --git a/www/api/widget.html b/www/api/widget.html
index c560fca..76119eb 100644
--- a/www/api/widget.html
+++ b/www/api/widget.html
@@ -1,12 +1,14 @@
-<?xml version="1.0" encoding="utf-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html lang="en">
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" />
-<title>widget</title>
-<link rel="stylesheet" href="../docutils-api.css" type="text/css" />
+ <meta charset="utf-8">
+ <meta content="en" name="language">
+ <title>widget</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">
+
</head>
+
<body>
<div class="banner">
@@ -19,6 +21,7 @@
</form>
</div>
+
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
@@ -32,36 +35,34 @@
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
+
<div class="document" id="widget">
<h1 class="title">widget</h1>
-<h2 class="subtitle" id="x11-widgets">X11 Widgets</h2>
-
+<p class="subtitle" id="x11-widgets">X11 Widgets</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
-<li><a class="reference internal" href="#xcolorbrowserwidget" id="id25">XColorBrowserWidget</a></li>
-<li><a class="reference internal" href="#xcommandwidget" id="id26">XCommandWidget</a></li>
-<li><a class="reference internal" href="#xconfirmwidget" id="id27">XConfirmWidget</a></li>
-<li><a class="reference internal" href="#xdialogwidget" id="id28">XDialogWidget</a></li>
-<li><a class="reference internal" href="#xfilebrowserwidget" id="id29">XFileBrowserWidget</a></li>
-<li><a class="reference internal" href="#xfontbrowserwidget" id="id30">XFontBrowserWidget</a></li>
-<li><a class="reference internal" href="#xinfowidget" id="id31">XInfoWidget</a></li>
-<li><a class="reference internal" href="#xlistbrowserwidget" id="id32">XListBrowserWidget</a></li>
-<li><a class="reference internal" href="#xmenuwidget" id="id33">XMenuWidget</a></li>
-<li><a class="reference internal" href="#xmonitorwidget" id="id34">XMonitorWidget</a></li>
-<li><a class="reference internal" href="#xnoticewidget" id="id35">XNoticeWidget</a></li>
-<li><a class="reference internal" href="#xpreferenceswidget" id="id36">XPreferencesWidget</a></li>
-<li><a class="reference internal" href="#xtextviewwidget" id="id37">XTextViewWidget</a></li>
+<li><p><a class="reference internal" href="#xcolorbrowserwidget" id="id25">XColorBrowserWidget</a></p></li>
+<li><p><a class="reference internal" href="#xcommandwidget" id="id26">XCommandWidget</a></p></li>
+<li><p><a class="reference internal" href="#xconfirmwidget" id="id27">XConfirmWidget</a></p></li>
+<li><p><a class="reference internal" href="#xdialogwidget" id="id28">XDialogWidget</a></p></li>
+<li><p><a class="reference internal" href="#xfilebrowserwidget" id="id29">XFileBrowserWidget</a></p></li>
+<li><p><a class="reference internal" href="#xfontbrowserwidget" id="id30">XFontBrowserWidget</a></p></li>
+<li><p><a class="reference internal" href="#xinfowidget" id="id31">XInfoWidget</a></p></li>
+<li><p><a class="reference internal" href="#xlistbrowserwidget" id="id32">XListBrowserWidget</a></p></li>
+<li><p><a class="reference internal" href="#xmenuwidget" id="id33">XMenuWidget</a></p></li>
+<li><p><a class="reference internal" href="#xmonitorwidget" id="id34">XMonitorWidget</a></p></li>
+<li><p><a class="reference internal" href="#xnoticewidget" id="id35">XNoticeWidget</a></p></li>
+<li><p><a class="reference internal" href="#xpreferenceswidget" id="id36">XPreferencesWidget</a></p></li>
+<li><p><a class="reference internal" href="#xtextviewwidget" id="id37">XTextViewWidget</a></p></li>
</ul>
</div>
<div class="section" id="xcolorbrowserwidget">
<h1><a class="toc-backref" href="#id25">XColorBrowserWidget</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
- char *reply );
-</pre>
+<pre class="literal-block">void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
+ char *reply );</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
@@ -69,20 +70,22 @@ void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const
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>
-<pre class="literal-block">
-void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
- char *reply );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">void MagickXColorBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
+ char *reply );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>action:</dt>
-<dd>Specifies a pointer to the action of this widget.</dd>
+<dd><p>Specifies a pointer to the action of this widget.</p>
+</dd>
<dt>reply:</dt>
-<dd>The response from the user is returned in this parameter.</dd>
+<dd><p>The response from the user is returned in this parameter.</p>
+</dd>
</dl>
</div>
</div>
@@ -90,34 +93,35 @@ XOpenDisplay.</dd>
<h1><a class="toc-backref" href="#id26">XCommandWidget</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
-<pre class="literal-block">
-int MagickXCommandWidget( Display *display, MagickXWindows *windows,
- const char ** selections, XEvent *event );
-</pre>
+<pre class="literal-block">int MagickXCommandWidget( Display *display, MagickXWindows *windows,
+ const char ** selections, XEvent *event );</pre>
</div>
<div class="section" id="id2">
<h2>Description</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>
-<pre class="literal-block">
-int MagickXCommandWidget( Display *display, MagickXWindows *windows,
- const char ** selections, XEvent *event );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">int MagickXCommandWidget( Display *display, MagickXWindows *windows,
+ const char ** selections, XEvent *event );</pre>
+<dl class="simple">
<dt>selection_number:</dt>
-<dd>Specifies the number of the selection that the
-user choose.</dd>
+<dd><p>Specifies the number of the selection that the
+user choose.</p>
+</dd>
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>selections:</dt>
-<dd>Specifies a pointer to one or more strings that comprise
-the choices in the menu.</dd>
+<dd><p>Specifies a pointer to one or more strings that comprise
+the choices in the menu.</p>
+</dd>
<dt>event:</dt>
-<dd>Specifies a pointer to a X11 XEvent structure.</dd>
+<dd><p>Specifies a pointer to a X11 XEvent structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -125,10 +129,8 @@ the choices in the menu.</dd>
<h1><a class="toc-backref" href="#id27">XConfirmWidget</a></h1>
<div class="section" id="id3">
<h2>Synopsis</h2>
-<pre class="literal-block">
-int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char *reason,
- const char *description );
-</pre>
+<pre class="literal-block">int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char *reason,
+ const char *description );</pre>
</div>
<div class="section" id="id4">
<h2>Description</h2>
@@ -136,24 +138,27 @@ int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char
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>
-<pre class="literal-block">
-int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char *reason,
- const char *description );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">int MagickXConfirmWidget( Display *display, MagickXWindows *windows, const char *reason,
+ const char *description );</pre>
+<dl class="simple">
<dt>status:</dt>
-<dd>Method MagickXConfirmWidget returns True if the user presses Yes
-otherwise False is returned.</dd>
+<dd><p>Method MagickXConfirmWidget returns True if the user presses Yes
+otherwise False is returned.</p>
+</dd>
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>reason:</dt>
-<dd>Specifies the message to display before terminating the
-program.</dd>
+<dd><p>Specifies the message to display before terminating the
+program.</p>
+</dd>
<dt>description:</dt>
-<dd>Specifies any description to the message.</dd>
+<dd><p>Specifies any description to the message.</p>
+</dd>
</dl>
</div>
</div>
@@ -161,10 +166,8 @@ program.</dd>
<h1><a class="toc-backref" href="#id28">XDialogWidget</a></h1>
<div class="section" id="id5">
<h2>Synopsis</h2>
-<pre class="literal-block">
-int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *action,
- const char *query, char *reply );
-</pre>
+<pre class="literal-block">int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *action,
+ const char *query, char *reply );</pre>
</div>
<div class="section" id="id6">
<h2>Description</h2>
@@ -172,22 +175,25 @@ int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *
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>
-<pre class="literal-block">
-int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *action,
- const char *query, char *reply );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">int MagickXDialogWidget( Display *display, MagickXWindows *windows, const char *action,
+ const char *query, char *reply );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>action:</dt>
-<dd>Specifies a pointer to the action of this widget.</dd>
+<dd><p>Specifies a pointer to the action of this widget.</p>
+</dd>
<dt>query:</dt>
-<dd>Specifies a pointer to the query to present to the user.</dd>
+<dd><p>Specifies a pointer to the query to present to the user.</p>
+</dd>
<dt>reply:</dt>
-<dd>The response from the user is returned in this parameter.</dd>
+<dd><p>The response from the user is returned in this parameter.</p>
+</dd>
</dl>
</div>
</div>
@@ -195,10 +201,8 @@ XOpenDisplay.</dd>
<h1><a class="toc-backref" href="#id29">XFileBrowserWidget</a></h1>
<div class="section" id="id7">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
- char *reply );
-</pre>
+<pre class="literal-block">void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
+ char *reply );</pre>
</div>
<div class="section" id="id8">
<h2>Description</h2>
@@ -206,20 +210,22 @@ void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const
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>
-<pre class="literal-block">
-void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
- char *reply );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">void MagickXFileBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
+ char *reply );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>action:</dt>
-<dd>Specifies a pointer to the action of this widget.</dd>
+<dd><p>Specifies a pointer to the action of this widget.</p>
+</dd>
<dt>reply:</dt>
-<dd>The response from the user is returned in this parameter.</dd>
+<dd><p>The response from the user is returned in this parameter.</p>
+</dd>
</dl>
</div>
</div>
@@ -227,10 +233,8 @@ XOpenDisplay.</dd>
<h1><a class="toc-backref" href="#id30">XFontBrowserWidget</a></h1>
<div class="section" id="id9">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
- char *reply );
-</pre>
+<pre class="literal-block">void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
+ char *reply );</pre>
</div>
<div class="section" id="id10">
<h2>Description</h2>
@@ -238,20 +242,22 @@ void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const
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>
-<pre class="literal-block">
-void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
- char *reply );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">void MagickXFontBrowserWidget( Display *display, MagickXWindows *windows, const char *action,
+ char *reply );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>action:</dt>
-<dd>Specifies a pointer to the action of this widget.</dd>
+<dd><p>Specifies a pointer to the action of this widget.</p>
+</dd>
<dt>reply:</dt>
-<dd>The response from the user is returned in this parameter.</dd>
+<dd><p>The response from the user is returned in this parameter.</p>
+</dd>
</dl>
</div>
</div>
@@ -259,9 +265,7 @@ XOpenDisplay.</dd>
<h1><a class="toc-backref" href="#id31">XInfoWidget</a></h1>
<div class="section" id="id11">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *activity );
-</pre>
+<pre class="literal-block">void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *activity );</pre>
</div>
<div class="section" id="id12">
<h2>Description</h2>
@@ -269,19 +273,20 @@ void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *a
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>
-<pre class="literal-block">
-void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *activity );
-</pre>
+<pre class="literal-block">void MagickXInfoWidget( Display *display, MagickXWindows *windows, const char *activity );</pre>
<p>A description of each parameter follows:</p>
-<dl class="docutils">
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>activity:</dt>
-<dd>This character string reflects the current activity and is
-displayed in the Info widget.</dd>
+<dd><p>This character string reflects the current activity and is
+displayed in the Info widget.</p>
+</dd>
</dl>
</div>
</div>
@@ -289,11 +294,9 @@ displayed in the Info widget.</dd>
<h1><a class="toc-backref" href="#id32">XListBrowserWidget</a></h1>
<div class="section" id="id13">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXListBrowserWidget( Display *display, MagickXWindows *windows,
+<pre class="literal-block">void MagickXListBrowserWidget( Display *display, MagickXWindows *windows,
MagickXWindowInfo *window_info, const char ** list,
- const char *action, const char *query, char *reply );
-</pre>
+ const char *action, const char *query, char *reply );</pre>
</div>
<div class="section" id="id14">
<h2>Description</h2>
@@ -302,26 +305,30 @@ 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>
-<pre class="literal-block">
-void MagickXListBrowserWidget( Display *display, MagickXWindows *windows,
+<pre class="literal-block">void MagickXListBrowserWidget( Display *display, MagickXWindows *windows,
MagickXWindowInfo *window_info, const char ** list,
- const char *action, const char *query, char *reply );
-</pre>
-<dl class="docutils">
+ const char *action, const char *query, char *reply );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>list:</dt>
-<dd>Specifies a pointer to an array of strings. The user can
-select from these strings as a possible reply value.</dd>
+<dd><p>Specifies a pointer to an array of strings. The user can
+select from these strings as a possible reply value.</p>
+</dd>
<dt>action:</dt>
-<dd>Specifies a pointer to the action of this widget.</dd>
+<dd><p>Specifies a pointer to the action of this widget.</p>
+</dd>
<dt>query:</dt>
-<dd>Specifies a pointer to the query to present to the user.</dd>
+<dd><p>Specifies a pointer to the query to present to the user.</p>
+</dd>
<dt>reply:</dt>
-<dd>The response from the user is returned in this parameter.</dd>
+<dd><p>The response from the user is returned in this parameter.</p>
+</dd>
</dl>
</div>
</div>
@@ -329,37 +336,39 @@ select from these strings as a possible reply value.</dd>
<h1><a class="toc-backref" href="#id33">XMenuWidget</a></h1>
<div class="section" id="id15">
<h2>Synopsis</h2>
-<pre class="literal-block">
-int MagickXMenuWidget( Display *display, MagickXWindows *windows, const char *title,
- const char ** selections, char *item );
-</pre>
+<pre class="literal-block">int MagickXMenuWidget( Display *display, MagickXWindows *windows, const char *title,
+ const char ** selections, char *item );</pre>
</div>
<div class="section" id="id16">
<h2>Description</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>
-<pre class="literal-block">
-int MagickXMenuWidget( Display *display, MagickXWindows *windows, const char *title,
- const char ** selections, char *item );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">int MagickXMenuWidget( Display *display, MagickXWindows *windows, const char *title,
+ const char ** selections, char *item );</pre>
+<dl class="simple">
<dt>selection_number:</dt>
-<dd>Specifies the number of the selection that the
-user choose.</dd>
+<dd><p>Specifies the number of the selection that the
+user choose.</p>
+</dd>
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>title:</dt>
-<dd>Specifies a character string that describes the menu selections.</dd>
+<dd><p>Specifies a character string that describes the menu selections.</p>
+</dd>
<dt>selections:</dt>
-<dd>Specifies a pointer to one or more strings that comprise
-the choices in the menu.</dd>
+<dd><p>Specifies a pointer to one or more strings that comprise
+the choices in the menu.</p>
+</dd>
<dt>item:</dt>
-<dd>Specifies a character array. The item selected from the menu
-is returned here.</dd>
+<dd><p>Specifies a character array. The item selected from the menu
+is returned here.</p>
+</dd>
</dl>
</div>
</div>
@@ -367,10 +376,8 @@ is returned here.</dd>
<h1><a class="toc-backref" href="#id34">XMonitorWidget</a></h1>
<div class="section" id="id17">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char *task,
- const magick_int64_t quantum, const magick_uint64_t span );
-</pre>
+<pre class="literal-block">void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char *task,
+ const magick_int64_t quantum, const magick_uint64_t span );</pre>
</div>
<div class="section" id="id18">
<h2>Description</h2>
@@ -378,23 +385,26 @@ void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char
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>
-<pre class="literal-block">
-void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char *task,
- const magick_int64_t quantum, const magick_uint64_t span );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">void MagickXMonitorWidget( Display *display, MagickXWindows *windows, const char *task,
+ const magick_int64_t quantum, const magick_uint64_t span );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>task:</dt>
-<dd>Identifies the task in progress.</dd>
+<dd><p>Identifies the task in progress.</p>
+</dd>
<dt>quantum:</dt>
-<dd>Specifies the quantum position within the span which represents
-how much progress has been made in completing a task.</dd>
+<dd><p>Specifies the quantum position within the span which represents
+how much progress has been made in completing a task.</p>
+</dd>
<dt>span:</dt>
-<dd>Specifies the span relative to completing a task.</dd>
+<dd><p>Specifies the span relative to completing a task.</p>
+</dd>
</dl>
</div>
</div>
@@ -402,31 +412,31 @@ how much progress has been made in completing a task.</dd>
<h1><a class="toc-backref" href="#id35">XNoticeWidget</a></h1>
<div class="section" id="id19">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXNoticeWidget( Display *display, MagickXWindows *windows, const char *reason,
- const char *description );
-</pre>
+<pre class="literal-block">void MagickXNoticeWidget( Display *display, MagickXWindows *windows, const char *reason,
+ const char *description );</pre>
</div>
<div class="section" id="id20">
<h2>Description</h2>
<p>Method MagickXNoticeWidget displays a Notice widget with a notice to the user.
The function returns when the user presses the &quot;Dismiss&quot; button.</p>
<p>The format of the MagickXNoticeWidget method is:</p>
-<pre class="literal-block">
-void MagickXNoticeWidget( Display *display, MagickXWindows *windows, const char *reason,
- const char *description );
-</pre>
-<dl class="docutils">
+<pre class="literal-block">void MagickXNoticeWidget( Display *display, MagickXWindows *windows, const char *reason,
+ const char *description );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>reason:</dt>
-<dd>Specifies the message to display before terminating the
-program.</dd>
+<dd><p>Specifies the message to display before terminating the
+program.</p>
+</dd>
<dt>description:</dt>
-<dd>Specifies any description to the message.</dd>
+<dd><p>Specifies any description to the message.</p>
+</dd>
</dl>
</div>
</div>
@@ -434,11 +444,9 @@ program.</dd>
<h1><a class="toc-backref" href="#id36">XPreferencesWidget</a></h1>
<div class="section" id="id21">
<h2>Synopsis</h2>
-<pre class="literal-block">
-unsigned int MagickXPreferencesWidget( Display *display,
+<pre class="literal-block">unsigned int MagickXPreferencesWidget( Display *display,
<a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
- MagickXWindows *windows );
-</pre>
+ MagickXWindows *windows );</pre>
</div>
<div class="section" id="id22">
<h2>Description</h2>
@@ -446,19 +454,20 @@ unsigned int MagickXPreferencesWidget( Display *display,
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>
-<pre class="literal-block">
-unsigned int MagickXPreferencesWidget( Display *display,
+<pre class="literal-block">unsigned int MagickXPreferencesWidget( Display *display,
<a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
- MagickXWindows *windows );
-</pre>
-<dl class="docutils">
+ MagickXWindows *windows );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>resource_info:</dt>
-<dd>Specifies a pointer to a X11 MagickXResourceInfo structure.</dd>
+<dd><p>Specifies a pointer to a X11 MagickXResourceInfo structure.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
</dl>
</div>
</div>
@@ -466,44 +475,49 @@ XOpenDisplay.</dd>
<h1><a class="toc-backref" href="#id37">XTextViewWidget</a></h1>
<div class="section" id="id23">
<h2>Synopsis</h2>
-<pre class="literal-block">
-void MagickXTextViewWidget( Display *display, const <a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
+<pre class="literal-block">void MagickXTextViewWidget( Display *display, const <a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
MagickXWindows *windows, const unsigned int mono,
- const char *title, const char ** textlist );
-</pre>
+ const char *title, const char ** textlist );</pre>
</div>
<div class="section" id="id24">
<h2>Description</h2>
<p>Method MagickXTextViewWidget displays text in a Text View widget.</p>
<p>The format of the MagickXTextViewWidget method is:</p>
-<pre class="literal-block">
-void MagickXTextViewWidget( Display *display, const <a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
+<pre class="literal-block">void MagickXTextViewWidget( Display *display, const <a class="reference external" href="../api/types.html#magickxresourceinfo">MagickXResourceInfo</a> *resource_info,
MagickXWindows *windows, const unsigned int mono,
- const char *title, const char ** textlist );
-</pre>
-<dl class="docutils">
+ const char *title, const char ** textlist );</pre>
+<dl class="simple">
<dt>display:</dt>
-<dd>Specifies a connection to an X server; returned from
-XOpenDisplay.</dd>
+<dd><p>Specifies a connection to an X server; returned from
+XOpenDisplay.</p>
+</dd>
<dt>resource_info:</dt>
-<dd>Specifies a pointer to a X11 MagickXResourceInfo structure.</dd>
+<dd><p>Specifies a pointer to a X11 MagickXResourceInfo structure.</p>
+</dd>
<dt>window:</dt>
-<dd>Specifies a pointer to a MagickXWindows structure.</dd>
+<dd><p>Specifies a pointer to a MagickXWindows structure.</p>
+</dd>
<dt>mono:</dt>
-<dd>Use mono-spaced font when displaying text.</dd>
+<dd><p>Use mono-spaced font when displaying text.</p>
+</dd>
<dt>title:</dt>
-<dd>This character string is displayed at the top of the widget
-window.</dd>
+<dd><p>This character string is displayed at the top of the widget
+window.</p>
+</dd>
<dt>textlist:</dt>
-<dd>This string list is displayed within the Text View widget.</dd>
+<dd><p>This string list is displayed within the Text View widget.</p>
+</dd>
</dl>
</div>
</div>
</div>
+
<hr class="docutils">
<div class="document">
- <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p>
+ <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p>
+</div>
+
</div>
</body>
</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-25 02:33:53 +0000