callisto-debian/gtk3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

New upstream version 3.24.14

Browse Source
This commit is contained in:
Simon McVittie
2020-02-29 14:17:40 +00:00
parent ffccf14831 fab213a5f9
commit 701099732f
543 changed files with 330694 additions and 808714 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
docs/reference/gtk/html/GtkAssistant.html
View File

@ -8,7 +8,7 @@
<link rel="up" href="WindowWidgets.html" title="Windows">
<link rel="prev" href="GtkAboutDialog.html" title="GtkAboutDialog">
<link rel="next" href="GtkInvisible.html" title="GtkInvisible">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<meta name="generator" content="GTK-Doc V1.32.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -41,8 +41,8 @@
<a name="GtkAssistant.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
@ -143,7 +143,7 @@
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="returnvalue">GtkAssistantPageType</span></a>
<a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType"><span class="returnvalue">GtkAssistantPageType</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkAssistant.html#gtk-assistant-get-page-type" title="gtk_assistant_get_page_type ()">gtk_assistant_get_page_type</a> <span class="c_punctuation">()</span>
@ -290,7 +290,7 @@
<tbody><tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="GtkAssistant.html#GtkAssistant--use-header-bar" title="The “use-header-bar” property">use-header-bar</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr></tbody>
</table></div>
</div>
@ -320,7 +320,7 @@
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a></td>
<td class="property_type"><a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a></td>
<td class="property_name"><a class="link" href="GtkAssistant.html#GtkAssistant--c-page-type" title="The “page-type” child property">page-type</a></td>
<td class="property_flags">Read / Write</td>
</tr>
@ -365,9 +365,9 @@
<a name="GtkAssistant.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
@ -402,21 +402,21 @@
<a name="GtkAssistant.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkAssistant.html#GtkAssistant-struct" title="struct GtkAssistant">GtkAssistant</a></td>
<td class="function_name"><a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistant-struct">GtkAssistant</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GtkAssistant.html#GtkAssistantClass" title="struct GtkAssistantClass">GtkAssistantClass</a></td>
<td class="function_name">GtkAssistantClass</td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">GtkAssistantPageType</a></td>
<td class="function_name"><a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType">GtkAssistantPageType</a></td>
</tr>
</tbody>
</table></div>
@ -450,12 +450,12 @@ operation splitted in several steps, guiding the user through its
pages and controlling the page flow to collect the necessary data.</p>
<p>The design of GtkAssistant is that it controls what buttons to show
and to make sensitive, based on what it knows about the page sequence
and the <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType">type</a> of each page,
and the <a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType">type</a> of each page,
in addition to state information like the page
<a class="link" href="GtkAssistant.html#gtk-assistant-set-page-complete" title="gtk_assistant_set_page_complete ()">completion</a>
and <a class="link" href="GtkAssistant.html#gtk-assistant-commit" title="gtk_assistant_commit ()">committed</a> status.</p>
<p>If you have a case that doesn’t quite fit in <a href="GtkAssistant.html#GtkAssistant-struct"><span class="type">GtkAssistants</span></a> way of
handling buttons, you can use the <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CUSTOM:CAPS"><span class="type">GTK_ASSISTANT_PAGE_CUSTOM</span></a> page
<p>If you have a case that doesn’t quite fit in <a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistant-struct"><span class="type">GtkAssistants</span></a> way of
handling buttons, you can use the <a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GTK-ASSISTANT-PAGE-CUSTOM:CAPS"><span class="type">GTK_ASSISTANT_PAGE_CUSTOM</span></a> page
type and handle buttons yourself.</p>
<div class="refsect2">
<a name="id-1.3.6.6.12.5"></a><h3>GtkAssistant as GtkBuildable</h3>
@ -874,7 +874,7 @@ to use the default one. </p></td>
<pre class="programlisting"><span class="returnvalue">void</span>
gtk_assistant_set_page_type (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>,
<em class="parameter"><code><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a> type</code></em>);</pre>
<em class="parameter"><code><a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a> type</code></em>);</pre>
<p>Sets the page type for <em class="parameter"><code>page</code></em>
.</p>
<p>The page type determines the page behavior in the <em class="parameter"><code>assistant</code></em>
@ -913,7 +913,7 @@ gtk_assistant_set_page_type (<em class="parameter"><code><a class="link" href="G
<hr>
<div class="refsect2">
<a name="gtk-assistant-get-page-type"></a><h3>gtk_assistant_get_page_type ()</h3>
<pre class="programlisting"><a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="returnvalue">GtkAssistantPageType</span></a>
<pre class="programlisting"><a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType"><span class="returnvalue">GtkAssistantPageType</span></a>
gtk_assistant_get_page_type (<em class="parameter"><code><a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a> *assistant</code></em>,
<em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *page</code></em>);</pre>
<p>Gets the page type of <em class="parameter"><code>page</code></em>
@ -1499,7 +1499,7 @@ gtk_assistant_next_page (<em class="parameter"><code><a class="link" href="GtkAs
<p>It is a programming error to call this function when
there is no next page.</p>
<p>This function is for use when creating pages of the
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CUSTOM:CAPS"><span class="type">GTK_ASSISTANT_PAGE_CUSTOM</span></a> type.</p>
<a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GTK-ASSISTANT-PAGE-CUSTOM:CAPS"><span class="type">GTK_ASSISTANT_PAGE_CUSTOM</span></a> type.</p>
<div class="refsect3">
<a name="gtk-assistant-next-page.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -1526,7 +1526,7 @@ gtk_assistant_previous_page (<em class="parameter"><code><a class="link" href="G
<p>It is a programming error to call this function when
no previous page is available.</p>
<p>This function is for use when creating pages of the
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CUSTOM:CAPS"><span class="type">GTK_ASSISTANT_PAGE_CUSTOM</span></a> type.</p>
<a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GTK-ASSISTANT-PAGE-CUSTOM:CAPS"><span class="type">GTK_ASSISTANT_PAGE_CUSTOM</span></a> type.</p>
<div class="refsect3">
<a name="gtk-assistant-previous-page.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -1546,133 +1546,6 @@ no previous page is available.</p>
</div>
</div>
<div class="refsect1">
<a name="GtkAssistant.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkAssistant-struct"></a><h3>struct GtkAssistant</h3>
<pre class="programlisting">struct GtkAssistant;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkAssistantClass"></a><h3>struct GtkAssistantClass</h3>
<pre class="programlisting">struct GtkAssistantClass {
GtkWindowClass parent_class;
void (* prepare) (GtkAssistant *assistant, GtkWidget *page);
void (* apply) (GtkAssistant *assistant);
void (* close) (GtkAssistant *assistant);
void (* cancel) (GtkAssistant *assistant);
};
</pre>
<div class="refsect3">
<a name="GtkAssistantClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkAssistantClass.prepare"></a>prepare</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when a new page is set as the assistant’s current page, before making the new page visible.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkAssistantClass.apply"></a>apply</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when the apply button is clicked.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkAssistantClass.close"></a>close</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted either when the close button or last page apply button is clicked.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GtkAssistantClass.cancel"></a>cancel</code></em> ()</p></td>
<td class="struct_member_description"><p>Signal emitted when the cancel button is clicked.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GtkAssistantPageType"></a><h3>enum GtkAssistantPageType</h3>
<p>An enum for determining the page role inside the <a class="link" href="GtkAssistant.html" title="GtkAssistant"><span class="type">GtkAssistant</span></a>. It's
used to handle buttons sensitivity and visibility.</p>
<p>Note that an assistant needs to end its page flow with a page of type
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CONFIRM:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></a>, <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-SUMMARY:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_SUMMARY</code></a> or
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-PROGRESS:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></a> to be correct.</p>
<p>The Cancel button will only be shown if the page isn’t “committed”.
See <a class="link" href="GtkAssistant.html#gtk-assistant-commit" title="gtk_assistant_commit ()"><code class="function">gtk_assistant_commit()</code></a> for details.</p>
<div class="refsect3">
<a name="GtkAssistantPageType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-ASSISTANT-PAGE-CONTENT:CAPS"></a>GTK_ASSISTANT_PAGE_CONTENT</p></td>
<td class="enum_member_description">
<p>The page has regular contents. Both the
Back and forward buttons will be shown.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-ASSISTANT-PAGE-INTRO:CAPS"></a>GTK_ASSISTANT_PAGE_INTRO</p></td>
<td class="enum_member_description">
<p>The page contains an introduction to the
assistant task. Only the Forward button will be shown if there is a
next page.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-ASSISTANT-PAGE-CONFIRM:CAPS"></a>GTK_ASSISTANT_PAGE_CONFIRM</p></td>
<td class="enum_member_description">
<p>The page lets the user confirm or deny the
changes. The Back and Apply buttons will be shown.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-ASSISTANT-PAGE-SUMMARY:CAPS"></a>GTK_ASSISTANT_PAGE_SUMMARY</p></td>
<td class="enum_member_description">
<p>The page informs the user of the changes
done. Only the Close button will be shown.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-ASSISTANT-PAGE-PROGRESS:CAPS"></a>GTK_ASSISTANT_PAGE_PROGRESS</p></td>
<td class="enum_member_description">
<p>Used for tasks that take a long time to
complete, blocks the assistant until the page is marked as complete.
Only the back button will be shown.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-ASSISTANT-PAGE-CUSTOM:CAPS"></a>GTK_ASSISTANT_PAGE_CUSTOM</p></td>
<td class="enum_member_description">
<p>Used for when other page types are not
appropriate. No buttons will be shown, and the application must
add its own buttons through <a class="link" href="GtkAssistant.html#gtk-assistant-add-action-widget" title="gtk_assistant_add_action_widget ()"><code class="function">gtk_assistant_add_action_widget()</code></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkAssistant.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkAssistant--use-header-bar"></a><h3>The <code class="literal">“use-header-bar”</code> property</h3>
@ -1681,7 +1554,8 @@ See <a class="link" href="GtkAssistant.html#gtk-assistant-commit" title="gtk_ass
instead of the action-area.</p>
<p>For technical reasons, this property is declared as an integer
property, but you should only set it to <code class="literal">TRUE</code> or <code class="literal">FALSE</code>.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Allowed values: [-1,1]</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="api-index-3-12.html#api-index-3.12">3.12</a></p>
@ -1695,6 +1569,7 @@ property, but you should only set it to <code class="literal">TRUE</code> or <co
<p>Setting the "complete" child property to <code class="literal">TRUE</code> marks a page as
complete (i.e.: all the required fields are filled out). GTK+ uses
this information to control the sensitivity of the navigation buttons.</p>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: 2.10</p>
@ -1704,6 +1579,7 @@ this information to control the sensitivity of the navigation buttons.</p>
<a name="GtkAssistant--c-has-padding"></a><h3>The <code class="literal">“has-padding”</code> child property</h3>
<pre class="programlisting"> “has-padding” <span class="type">gboolean</span></pre>
<p>Whether the assistant adds padding around the page.</p>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
@ -1717,14 +1593,16 @@ this information to control the sensitivity of the navigation buttons.</p>
<p>Since GTK+ 3.2, a header is no longer shown;
add your header decoration to the page content instead.</p>
</div>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write</p>
<p class="since">Since: 2.10</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkAssistant--c-page-type"></a><h3>The <code class="literal">“page-type”</code> child property</h3>
<pre class="programlisting"> “page-type” <a class="link" href="GtkAssistant.html#GtkAssistantPageType" title="enum GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a></pre>
<pre class="programlisting"> “page-type” <a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GtkAssistantPageType"><span class="type">GtkAssistantPageType</span></a></pre>
<p>The type of the assistant page.</p>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_ASSISTANT_PAGE_CONTENT</p>
<p class="since">Since: 2.10</p>
@ -1738,6 +1616,7 @@ this information to control the sensitivity of the navigation buttons.</p>
<p><code class="literal">GtkAssistant:sidebar-image</code> has been deprecated since version 3.2 and should not be used in newly-written code.</p>
<p>Since GTK+ 3.2, the sidebar image is no longer shown.</p>
</div>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write</p>
<p class="since">Since: 2.10</p>
</div>
@ -1746,6 +1625,7 @@ this information to control the sensitivity of the navigation buttons.</p>
<a name="GtkAssistant--c-title"></a><h3>The <code class="literal">“title”</code> child property</h3>
<pre class="programlisting"> “title” <span class="type">gchar</span> *</pre>
<p>The title of the page.</p>
<p>Owner: GtkAssistant</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: 2.10</p>
@ -1761,6 +1641,7 @@ this information to control the sensitivity of the navigation buttons.</p>
<p><code class="literal">GtkAssistant:content-padding</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>This style property is ignored.</p>
</div>
<p>Owner: GtkAssistant</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 1</p>
@ -1774,6 +1655,7 @@ this information to control the sensitivity of the navigation buttons.</p>
<p><code class="literal">GtkAssistant:header-padding</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>This style property is ignored.</p>
</div>
<p>Owner: GtkAssistant</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 6</p>
@ -1792,7 +1674,7 @@ after the current page, unless the current page is the last one.</p>
<p>A handler for the ::apply signal should carry out the actions for
which the wizard has collected data. If the action takes a long time
to complete, you might consider putting a page of type
<a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-PROGRESS:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></a> after the confirmation page and handle
<a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GTK-ASSISTANT-PAGE-PROGRESS:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_PROGRESS</code></a> after the confirmation page and handle
this operation within the <a class="link" href="GtkAssistant.html#GtkAssistant-prepare" title="The “prepare” signal"><span class="type">“prepare”</span></a> signal of the progress
page.</p>
<div class="refsect3">
@ -1860,7 +1742,7 @@ user_function (<a class="link" href="GtkAssistant.html" title="GtkAssistant"><sp
<span class="type">gpointer</span> user_data)</pre>
<p>The ::close signal is emitted either when the close button of
a summary page is clicked, or when the apply button in the last
page in the flow (of type <a class="link" href="GtkAssistant.html#GTK-ASSISTANT-PAGE-CONFIRM:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></a>) is clicked.</p>
page in the flow (of type <a href="https://developer.gnome.org/gtk4/GtkAssistant.html#GTK-ASSISTANT-PAGE-CONFIRM:CAPS"><code class="literal">GTK_ASSISTANT_PAGE_CONFIRM</code></a>) is clicked.</p>
<div class="refsect3">
<a name="GtkAssistant-close.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
@ -1939,6 +1821,6 @@ necessary before showing <em class="parameter"><code>page</code></em>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
<hr>Generated by GTK-Doc V1.32.1</div>
</body>
</html>