Imported Upstream version 2.4.0~rc2

This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpChainButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="prev" href="GimpButton.html" title="GimpButton">
@ -33,24 +33,24 @@
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpColorArea.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2579084" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2599902" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2592449" class="shortcut">Description</a>
<a href="#id2608754" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2590376" class="shortcut">Object Hierarchy</a>
<a href="#id2603228" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2590431" class="shortcut">Implemented Interfaces</a>
<a href="#id2603283" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2590452" class="shortcut">Properties</a>
<a href="#id2603310" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2592424" class="shortcut">Signals</a></nobr></td></tr>
<a href="#id2608729" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpChainButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2579084"></a><span class="refentrytitle">GimpChainButton</span>
<a name="id2599902"></a><span class="refentrytitle">GimpChainButton</span>
</h2>
<p>GimpChainButton &#8212; Widget to visually connect two entry widgets.</p>
</td>
@ -62,68 +62,50 @@
<a href="GimpChainButton.html#GimpChainButton-struct">GimpChainButton</a>;
enum <a href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GimpChainButton.html#gimp-chain-button-new">gimp_chain_button_new</a> (<a href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> position);
void <a href="GimpChainButton.html#gimp-chain-button-set-active">gimp_chain_button_set_active</a> (<a href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> active);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="GimpChainButton.html#gimp-chain-button-get-active">gimp_chain_button_get_active</a> (<a href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button);
<a class="link" href="GimpChainButton.html#GimpChainButton-struct">GimpChainButton</a>;
enum <a class="link" href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a>;
GtkWidget* <a class="link" href="GimpChainButton.html#gimp-chain-button-new">gimp_chain_button_new</a> (<a class="link" href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> position);
void <a class="link" href="GimpChainButton.html#gimp-chain-button-set-active">gimp_chain_button_set_active</a> (<a class="link" href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button,
gboolean active);
gboolean <a class="link" href="GimpChainButton.html#gimp-chain-button-get-active">gimp_chain_button_get_active</a> (<a class="link" href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2590376"></a><h2>Object Hierarchy</h2>
<a name="id2603228"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="../gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="../gtk/GtkTable.html"
>GtkTable</a>
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkTable
+----GimpChainButton
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2590431"></a><h2>Implemented Interfaces</h2>
<a name="id2603283"></a><h2>Implemented Interfaces</h2>
<p>
GimpChainButton implements
AtkImplementorIface.</p>
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2590452"></a><h2>Properties</h2>
<a name="id2603310"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpChainButton.html#GimpChainButton--position">position</a>" <a href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> : Read / Write / Construct Only
"<a class="link" href="GimpChainButton.html#GimpChainButton--position">position</a>" <a class="link" href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2592424"></a><h2>Signals</h2>
<a name="id2608729"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpChainButton.html#GimpChainButton-toggled">toggled</a>" : Run First
"<a class="link" href="GimpChainButton.html#GimpChainButton-toggled">toggled</a>" : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2592449"></a><h2>Description</h2>
<a name="id2608754"></a><h2>Description</h2>
<p>
This widget provides a button showing either a linked or a broken
chain that can be used to link two entries, spinbuttons, colors
@ -132,28 +114,28 @@ example to connect X and Y ratios to provide the possibility of a
constrained aspect ratio.
</p>
<p>
The <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> only gives visual feedback, it does not really
The <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> only gives visual feedback, it does not really
connect widgets. You have to take care of locking the values yourself
by checking the state of the <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> whenever a value changes
by checking the state of the <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> whenever a value changes
in one of the connected widgets and adjusting the other value if
necessary.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2592492"></a><h2>Details</h2>
<a name="id2608797"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2592503"></a><h3>
<a name="id2608808"></a><h3>
<a name="GimpChainButton-struct"></a>GimpChainButton</h3>
<a class="indexterm" name="id2592514"></a><pre class="programlisting">typedef struct _GimpChainButton GimpChainButton;</pre>
<a class="indexterm" name="id2608819"></a><pre class="programlisting">typedef struct _GimpChainButton GimpChainButton;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592531"></a><h3>
<a name="id2608836"></a><h3>
<a name="GimpChainPosition"></a>enum GimpChainPosition</h3>
<a class="indexterm" name="id2592543"></a><pre class="programlisting">typedef enum
<a class="indexterm" name="id2608848"></a><pre class="programlisting">typedef enum
{
GIMP_CHAIN_TOP,
GIMP_CHAIN_LEFT,
@ -167,13 +149,11 @@ necessary.
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2592560"></a><h3>
<a name="id2608865"></a><h3>
<a name="gimp-chain-button-new"></a>gimp_chain_button_new ()</h3>
<a class="indexterm" name="id2587885"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* gimp_chain_button_new (<a href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> position);</pre>
<a class="indexterm" name="id2584698"></a><pre class="programlisting">GtkWidget* gimp_chain_button_new (<a class="link" href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> position);</pre>
<p>
Creates a new <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> widget.
Creates a new <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> widget.
</p>
<p>
This returns a button showing either a broken or a linked chain and
@ -189,15 +169,15 @@ for more than two widgets, but the look is optimized for two.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>position</code></em>&#160;:</span></p></td>
<td> The position you are going to use for the button
with respect to the widgets you want to chain.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> Pointer to the new <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>, which is inactive
by default. Use <a href="GimpChainButton.html#gimp-chain-button-set-active"><code class="function">gimp_chain_button_set_active()</code></a> to
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> Pointer to the new <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>, which is inactive
by default. Use <a class="link" href="GimpChainButton.html#gimp-chain-button-set-active"><code class="function">gimp_chain_button_set_active()</code></a> to
change its state.
</td>
</tr>
@ -206,19 +186,13 @@ for more than two widgets, but the look is optimized for two.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2587981"></a><h3>
<a name="id2584794"></a><h3>
<a name="gimp-chain-button-set-active"></a>gimp_chain_button_set_active ()</h3>
<a class="indexterm" name="id2587992"></a><pre class="programlisting">void gimp_chain_button_set_active (<a href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> active);</pre>
<a class="indexterm" name="id2584805"></a><pre class="programlisting">void gimp_chain_button_set_active (<a class="link" href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button,
gboolean active);</pre>
<p>
Sets the state of the <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> to be either locked (<a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a>) or
unlocked (<a
href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>) and changes the showed pixmap to reflect the new state.</p>
Sets the state of the <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> to be either locked (<code class="literal">TRUE</code>) or
unlocked (<code class="literal">FALSE</code>) and changes the showed pixmap to reflect the new state.</p>
<p>
</p>
@ -226,12 +200,12 @@ href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></td>
<td> Pointer to a <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.
<td><p><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></p></td>
<td> Pointer to a <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>active</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>active</code></em>&#160;:</span></p></td>
<td> The new state.
</td>
</tr>
@ -240,13 +214,11 @@ href="../glib/glib-Standard-Macros.html#FALSE:CAPS"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2588098"></a><h3>
<a name="id2584911"></a><h3>
<a name="gimp-chain-button-get-active"></a>gimp_chain_button_get_active ()</h3>
<a class="indexterm" name="id2588111"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_chain_button_get_active (<a href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button);</pre>
<a class="indexterm" name="id2584924"></a><pre class="programlisting">gboolean gimp_chain_button_get_active (<a class="link" href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *button);</pre>
<p>
Checks the state of the <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.</p>
Checks the state of the <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.</p>
<p>
</p>
@ -254,15 +226,13 @@ Checks the state of the <a href="GimpChainButton.html" title="GimpChainButton"><
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></td>
<td> Pointer to a <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.
<td><p><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></p></td>
<td> Pointer to a <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <a
href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if the <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> is active (locked).
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> <code class="literal">TRUE</code> if the <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a> is active (locked).
</td>
</tr>
</tbody>
@ -270,11 +240,11 @@ href="../glib/glib-Standard-Macros.html#TRUE:CAPS"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2579948"></a><h2>Property Details</h2>
<a name="id2582812"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2579958"></a><h3>
<a name="id2582823"></a><h3>
<a name="GimpChainButton--position"></a>The "<code class="literal">position</code>" property</h3>
<a class="indexterm" name="id2579972"></a><pre class="programlisting"> "position" <a href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> : Read / Write / Construct Only</pre>
<a class="indexterm" name="id2582836"></a><pre class="programlisting"> "position" <a class="link" href="GimpChainButton.html#GimpChainPosition">GimpChainPosition</a> : Read / Write / Construct Only</pre>
<p>
The position in which the chain button will be used.</p>
<p>
@ -286,14 +256,12 @@ The position in which the chain button will be used.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2580009"></a><h2>Signal Details</h2>
<a name="id2582874"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2580020"></a><h3>
<a name="id2582885"></a><h3>
<a name="GimpChainButton-toggled"></a>The "toggled" signal</h3>
<a class="indexterm" name="id2580028"></a><pre class="programlisting">void user_function (<a href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *gimpchainbutton,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data) : Run First</pre>
<a class="indexterm" name="id2582893"></a><pre class="programlisting">void user_function (<a class="link" href="GimpChainButton.html" title="GimpChainButton">GimpChainButton</a> *gimpchainbutton,
gpointer user_data) : Run First</pre>
<p>
</p>
@ -301,13 +269,13 @@ href="../glib/glib-Basic-Types.html#gpointer"
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gimpchainbutton</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>gimpchainbutton</code></em>&#160;:</span></p></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
@ -315,10 +283,10 @@ href="../glib/glib-Basic-Types.html#gpointer"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2580097"></a><h2>See Also</h2>
<a name="id2582962"></a><h2>See Also</h2>
<p>
You may want to use the convenience function <a href="libgimpwidgets-GimpWidgets.html#gimp-coordinates-new"><code class="function">gimp_coordinates_new()</code></a> to set
up two GimpSizeEntries (see <a href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a>) linked with a <a href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.
You may want to use the convenience function <a class="link" href="libgimpwidgets-GimpWidgets.html#gimp-coordinates-new"><code class="function">gimp_coordinates_new()</code></a> to set
up two GimpSizeEntries (see <a class="link" href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a>) linked with a <a class="link" href="GimpChainButton.html" title="GimpChainButton"><span class="type">GimpChainButton</span></a>.
</p>
</div>
</div>