305 lines
17 KiB
HTML
305 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>Libxfce4ui Reference Manual: Xfce Titled Dialog</title>
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.78.0">
|
||
<link rel="home" href="index.html" title="Libxfce4ui Reference Manual">
|
||
<link rel="up" href="libxfce4ui-widgets.html" title="Part IV. Xfce UI Widget">
|
||
<link rel="prev" href="libxfce4ui-xfce-dialogs.html" title="Xfce Dialogs">
|
||
<link rel="next" href="libxfce4ui-sm.html" title="Part V. Xfce Session Management Support">
|
||
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
|
||
<link rel="stylesheet" href="style.css" type="text/css">
|
||
</head>
|
||
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
||
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
|
||
<td width="100%" align="left" class="shortcuts">
|
||
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
|
||
<a href="#libxfce4ui-xfce-titled-dialog.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
|
||
<a href="#libxfce4ui-xfce-titled-dialog.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
|
||
<a href="#libxfce4ui-xfce-titled-dialog.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
|
||
<a href="#libxfce4ui-xfce-titled-dialog.properties" class="shortcut">Properties</a></span>
|
||
</td>
|
||
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
|
||
<td><a accesskey="u" href="libxfce4ui-widgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
|
||
<td><a accesskey="p" href="libxfce4ui-xfce-dialogs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
|
||
<td><a accesskey="n" href="libxfce4ui-sm.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
|
||
</tr></table>
|
||
<div class="refentry">
|
||
<a name="libxfce4ui-xfce-titled-dialog"></a><div class="titlepage"></div>
|
||
<div class="refnamediv"><table width="100%"><tr>
|
||
<td valign="top">
|
||
<h2><span class="refentrytitle"><a name="libxfce4ui-xfce-titled-dialog.top_of_page"></a>Xfce Titled Dialog</span></h2>
|
||
<p>Xfce Titled Dialog — A <a href="http://developer.gnome.org/gtk2/GtkDialog.html"><span class="type">GtkDialog</span></a> with heading.</p>
|
||
</td>
|
||
<td class="gallery_image" valign="top" align="right"></td>
|
||
</tr></table></div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.functions"></a><h2>Functions</h2>
|
||
<div class="informaltable"><table width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="functions_return">
|
||
<col class="functions_name">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-new" title="xfce_titled_dialog_new ()">xfce_titled_dialog_new</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-new-with-buttons" title="xfce_titled_dialog_new_with_buttons ()">xfce_titled_dialog_new_with_buttons</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-get-subtitle" title="xfce_titled_dialog_get_subtitle ()">xfce_titled_dialog_get_subtitle</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="function_type">
|
||
<span class="returnvalue">void</span>
|
||
</td>
|
||
<td class="function_name">
|
||
<a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-set-subtitle" title="xfce_titled_dialog_set_subtitle ()">xfce_titled_dialog_set_subtitle</a> <span class="c_punctuation">()</span>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.properties"></a><h2>Properties</h2>
|
||
<div class="informaltable"><table border="0">
|
||
<colgroup>
|
||
<col width="150px" class="properties_type">
|
||
<col width="300px" class="properties_name">
|
||
<col width="200px" class="properties_flags">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="property_type">
|
||
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
|
||
<td class="property_name"><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog--subtitle" title="The “subtitle” property">subtitle</a></td>
|
||
<td class="property_flags">Read / Write</td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<a name="XfceTitledDialog"></a><div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.other"></a><h2>Types and Values</h2>
|
||
<div class="informaltable"><table width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="name">
|
||
<col class="description">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="datatype_keyword">struct</td>
|
||
<td class="function_name"><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog-struct" title="struct XfceTitledDialog">XfceTitledDialog</a></td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.object-hierarchy"></a><h2>Object Hierarchy</h2>
|
||
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
|
||
<span class="lineart">╰──</span> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
|
||
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
|
||
<span class="lineart">╰──</span> <a href="http://developer.gnome.org/gtk2/GtkWidget.html">GtkWidget</a>
|
||
<span class="lineart">╰──</span> <a href="http://developer.gnome.org/gtk2/GtkContainer.html">GtkContainer</a>
|
||
<span class="lineart">╰──</span> <a href="http://developer.gnome.org/gtk2/GtkBin.html">GtkBin</a>
|
||
<span class="lineart">╰──</span> <a href="http://developer.gnome.org/gtk2/GtkWindow.html">GtkWindow</a>
|
||
<span class="lineart">╰──</span> <a href="http://developer.gnome.org/gtk2/GtkDialog.html">GtkDialog</a>
|
||
<span class="lineart">╰──</span> XfceTitledDialog
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
|
||
<p>
|
||
XfceTitledDialog implements
|
||
<a href="/usr/share/gtk-doc/html/atk/AtkObject.html#AtkImplementorIface">AtkImplementorIface</a> and <a href="http://developer.gnome.org/gtk2/GtkBuildable.html">GtkBuildable</a>.</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.includes"></a><h2>Includes</h2>
|
||
<pre class="synopsis">#include <libxfce4ui/libxfce4ui.h>
|
||
</pre>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.description"></a><h2>Description</h2>
|
||
<p>
|
||
The <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> is a normal <a href="http://developer.gnome.org/gtk2/GtkDialog.html"><span class="type">GtkDialog</span></a> with a heading. The icon
|
||
and title used in the heading are the same as the dialog title and icon
|
||
See <a href="http://developer.gnome.org/gtk2/GtkWindow.html#gtk-window-set-icon-name"><code class="function">gtk_window_set_icon_name()</code></a>.
|
||
</p>
|
||
<p>
|
||
To give the user more detailed information about the use of the dialog,
|
||
an optional subtitle and be set using <a class="link" href="libxfce4ui-xfce-titled-dialog.html#xfce-titled-dialog-set-subtitle" title="xfce_titled_dialog_set_subtitle ()"><code class="function">xfce_titled_dialog_set_subtitle()</code></a>.
|
||
</p>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.functions_details"></a><h2>Functions</h2>
|
||
<div class="refsect2">
|
||
<a name="xfce-titled-dialog-new"></a><h3>xfce_titled_dialog_new ()</h3>
|
||
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
|
||
xfce_titled_dialog_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
|
||
<p>Allocates a new <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> instance.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.5.3.11.2.5"></a><h4>Returns</h4>
|
||
<p> the newly allocated <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="xfce-titled-dialog-new-with-buttons"></a><h3>xfce_titled_dialog_new_with_buttons ()</h3>
|
||
<pre class="programlisting"><a href="http://developer.gnome.org/gtk2/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
|
||
xfce_titled_dialog_new_with_buttons (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
|
||
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a> *parent</code></em>,
|
||
<em class="parameter"><code><a href="http://developer.gnome.org/gtk2/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a> flags</code></em>,
|
||
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *first_button_text</code></em>,
|
||
<em class="parameter"><code>...</code></em>);</pre>
|
||
<p>See the documentation of <a href="http://developer.gnome.org/gtk2/GtkDialog.html#gtk-dialog-new-with-buttons"><code class="function">gtk_dialog_new_with_buttons()</code></a> for details about the
|
||
parameters and the returned dialog.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.5.3.11.3.5"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>title</p></td>
|
||
<td class="parameter_description"><p>title of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>parent</p></td>
|
||
<td class="parameter_description"><p>transient parent window of the dialog, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>flags</p></td>
|
||
<td class="parameter_description"><p>from <a href="http://developer.gnome.org/gtk2/GtkDialog.html#GtkDialogFlags"><span class="type">GtkDialogFlags</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>first_button_text</p></td>
|
||
<td class="parameter_description"><p>stock ID or text to go in first, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="id-1.5.3.11.3.6"></a><h4>Returns</h4>
|
||
<p> the newly allocated <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="xfce-titled-dialog-get-subtitle"></a><h3>xfce_titled_dialog_get_subtitle ()</h3>
|
||
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
|
||
xfce_titled_dialog_get_subtitle (<em class="parameter"><code><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>);</pre>
|
||
<p>Returns the subtitle of the <em class="parameter"><code>titled_dialog</code></em>
|
||
, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
|
||
if no subtitle is displayed in the <em class="parameter"><code>titled_dialog</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.5.3.11.4.5"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody><tr>
|
||
<td class="parameter_name"><p>titled_dialog</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr></tbody>
|
||
</table></div>
|
||
</div>
|
||
<div class="refsect3">
|
||
<a name="id-1.5.3.11.4.6"></a><h4>Returns</h4>
|
||
<p> the subtitle of <em class="parameter"><code>titled_dialog</code></em>
|
||
, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
|
||
<p></p>
|
||
</div>
|
||
</div>
|
||
<hr>
|
||
<div class="refsect2">
|
||
<a name="xfce-titled-dialog-set-subtitle"></a><h3>xfce_titled_dialog_set_subtitle ()</h3>
|
||
<pre class="programlisting"><span class="returnvalue">void</span>
|
||
xfce_titled_dialog_set_subtitle (<em class="parameter"><code><a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a> *titled_dialog</code></em>,
|
||
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *subtitle</code></em>);</pre>
|
||
<p>Sets the subtitle displayed by <em class="parameter"><code>titled_dialog</code></em>
|
||
to <em class="parameter"><code>subtitle</code></em>
|
||
; if
|
||
<em class="parameter"><code>subtitle</code></em>
|
||
is <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> no subtitle will be displayed by the <em class="parameter"><code>titled_dialog</code></em>
|
||
.</p>
|
||
<div class="refsect3">
|
||
<a name="id-1.5.3.11.5.5"></a><h4>Parameters</h4>
|
||
<div class="informaltable"><table width="100%" border="0">
|
||
<colgroup>
|
||
<col width="150px" class="parameters_name">
|
||
<col class="parameters_description">
|
||
<col width="200px" class="parameters_annotations">
|
||
</colgroup>
|
||
<tbody>
|
||
<tr>
|
||
<td class="parameter_name"><p>titled_dialog</p></td>
|
||
<td class="parameter_description"><p>a <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
<tr>
|
||
<td class="parameter_name"><p>subtitle</p></td>
|
||
<td class="parameter_description"><p>the new subtitle for the <em class="parameter"><code>titled_dialog</code></em>
|
||
, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
|
||
<td class="parameter_annotations"> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.other_details"></a><h2>Types and Values</h2>
|
||
<div class="refsect2">
|
||
<a name="XfceTitledDialog-struct"></a><h3>struct XfceTitledDialog</h3>
|
||
<pre class="programlisting">struct XfceTitledDialog;</pre>
|
||
<p>
|
||
Structure for the <a class="link" href="libxfce4ui-xfce-titled-dialog.html#XfceTitledDialog"><span class="type">XfceTitledDialog</span></a>.
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.property-details"></a><h2>Property Details</h2>
|
||
<div class="refsect2">
|
||
<a name="XfceTitledDialog--subtitle"></a><h3>The <code class="literal">“subtitle”</code> property</h3>
|
||
<pre class="programlisting"> “subtitle” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
|
||
<p>The subtitle displayed below the main dialog title.</p>
|
||
<p>Flags: Read / Write</p>
|
||
<p>Default value: NULL</p>
|
||
</div>
|
||
</div>
|
||
<div class="refsect1">
|
||
<a name="libxfce4ui-xfce-titled-dialog.see-also"></a><h2>See Also</h2>
|
||
<p>
|
||
<a href="http://developer.gnome.org/gtk2/GtkDialog.html"><span class="type">GtkDialog</span></a>, <a href="http://developer.gnome.org/gtk2/GtkWindow.html"><span class="type">GtkWindow</span></a>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<hr>
|
||
Generated by GTK-Doc V1.21</div>
|
||
</body>
|
||
</html> |