← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpchainbutton.xml

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpchainbutton.xml
4
4
 
5
5
<refentry id="GimpChainButton">
6
6
<refmeta>
7
 
<refentrytitle id="top_of_page">GimpChainButton</refentrytitle>
 
7
<refentrytitle role="top_of_page">GimpChainButton</refentrytitle>
8
8
<manvolnum>3</manvolnum>
9
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
10
10
</refmeta>
15
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
16
</refnamediv>
17
17
 
18
 
<refsynopsisdiv id="synopsis">
19
 
<title id="synopsis.title">Synopsis</title>
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
20
20
 
21
21
<synopsis>
22
22
 
23
23
 
24
24
 
25
 
            <link linkend="GimpChainButton-struct">GimpChainButton</link>;
26
 
enum        <link linkend="GimpChainPosition">GimpChainPosition</link>;
27
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-chain-button-new">gimp_chain_button_new</link>           (<link linkend="GimpChainPosition">GimpChainPosition</link> position);
28
 
<link linkend="void">void</link>        <link linkend="gimp-chain-button-set-active">gimp_chain_button_set_active</link>    (<link linkend="GimpChainButton">GimpChainButton</link> *button,
29
 
                                             <link linkend="gboolean">gboolean</link> active);
30
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-chain-button-get-active">gimp_chain_button_get_active</link>    (<link linkend="GimpChainButton">GimpChainButton</link> *button);
 
25
                    <link linkend="GimpChainButton-struct">GimpChainButton</link>;
 
26
enum                <link linkend="GimpChainPosition">GimpChainPosition</link>;
 
27
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-chain-button-new">gimp_chain_button_new</link>               (<link linkend="GimpChainPosition">GimpChainPosition</link> position);
 
28
<link linkend="void">void</link>                <link linkend="gimp-chain-button-set-active">gimp_chain_button_set_active</link>        (<link linkend="GimpChainButton">GimpChainButton</link> *button,
 
29
                                                         <link linkend="gboolean">gboolean</link> active);
 
30
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-chain-button-get-active">gimp_chain_button_get_active</link>        (<link linkend="GimpChainButton">GimpChainButton</link> *button);
31
31
 
32
32
</synopsis>
33
33
</refsynopsisdiv>
34
34
 
35
 
<refsect1 id="object_hierarchy">
36
 
<title id="object_hierarchy.title">Object Hierarchy</title>
 
35
<refsect1 role="object_hierarchy">
 
36
<title role="object_hierarchy.title">Object Hierarchy</title>
37
37
<synopsis>
38
38
 
39
39
  <link linkend="GObject">GObject</link>
49
49
 
50
50
 
51
51
 
52
 
<refsect1 id="impl_interfaces">
53
 
<title id="impl_interfaces.title">Implemented Interfaces</title>
 
52
<refsect1 role="impl_interfaces">
 
53
<title role="impl_interfaces.title">Implemented Interfaces</title>
54
54
<para>
55
55
GimpChainButton implements
56
56
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
58
58
</refsect1>
59
59
 
60
60
 
61
 
 
62
 
<refsect1 id="signal_proto">
63
 
<title id="signal_proto.title">Signals</title>
64
 
<synopsis>
65
 
 
66
 
&quot;<link linkend="GimpChainButton-toggled">toggled</link>&quot;   <link linkend="void">void</link>        user_function      (<link linkend="GimpChainButton">GimpChainButton</link> *gimpchainbutton,
67
 
                                            <link linkend="gpointer">gpointer</link>         user_data)            : Run first
68
 
</synopsis>
69
 
</refsect1>
70
 
 
71
 
 
72
 
<refsect1 id="desc">
73
 
<title id="desc.title">Description</title>
 
61
<refsect1 role="properties">
 
62
<title role="properties.title">Properties</title>
 
63
<synopsis>
 
64
 
 
65
  &quot;<link linkend="GimpChainButton--position">position</link>&quot;                 <link linkend="GimpChainPosition">GimpChainPosition</link>     : Read / Write / Construct Only
 
66
</synopsis>
 
67
</refsect1>
 
68
 
 
69
<refsect1 role="signal_proto">
 
70
<title role="signal_proto.title">Signals</title>
 
71
<synopsis>
 
72
 
 
73
  &quot;<link linkend="GimpChainButton-toggled">toggled</link>&quot;                                        : Run First
 
74
</synopsis>
 
75
</refsect1>
 
76
 
 
77
 
 
78
<refsect1 role="desc">
 
79
<title role="desc.title">Description</title>
74
80
<para>
75
81
This widget provides a button showing either a linked or a broken
76
82
chain that can be used to link two entries, spinbuttons, colors
87
93
</para>
88
94
</refsect1>
89
95
 
90
 
<refsect1 id="details">
91
 
<title id="details.title">Details</title>
 
96
<refsect1 role="details">
 
97
<title role="details.title">Details</title>
92
98
<refsect2>
93
99
<title><anchor id="GimpChainButton-struct" role="struct"/>GimpChainButton</title>
94
100
<indexterm><primary>GimpChainButton</primary></indexterm><programlisting>typedef struct _GimpChainButton GimpChainButton;</programlisting>
110
116
</para></refsect2>
111
117
<refsect2>
112
118
<title><anchor id="gimp-chain-button-new" role="function"/>gimp_chain_button_new ()</title>
113
 
<indexterm><primary>gimp_chain_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_chain_button_new           (<link linkend="GimpChainPosition">GimpChainPosition</link> position);</programlisting>
 
119
<indexterm><primary>gimp_chain_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_chain_button_new               (<link linkend="GimpChainPosition">GimpChainPosition</link> position);</programlisting>
114
120
<para>
115
121
Creates a new <link linkend="GimpChainButton"><type>GimpChainButton</type></link> widget.
116
122
</para>
135
141
</variablelist></refsect2>
136
142
<refsect2>
137
143
<title><anchor id="gimp-chain-button-set-active" role="function"/>gimp_chain_button_set_active ()</title>
138
 
<indexterm><primary>gimp_chain_button_set_active</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_chain_button_set_active    (<link linkend="GimpChainButton">GimpChainButton</link> *button,
139
 
                                             <link linkend="gboolean">gboolean</link> active);</programlisting>
 
144
<indexterm><primary>gimp_chain_button_set_active</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_chain_button_set_active        (<link linkend="GimpChainButton">GimpChainButton</link> *button,
 
145
                                                         <link linkend="gboolean">gboolean</link> active);</programlisting>
140
146
<para>
141
147
Sets the state of the <link linkend="GimpChainButton"><type>GimpChainButton</type></link> to be either locked (<link linkend="TRUE:CAPS"><literal>TRUE</literal></link>) or
142
148
unlocked (<link linkend="FALSE:CAPS"><literal>FALSE</literal></link>) and changes the showed pixmap to reflect the new state.</para>
152
158
</variablelist></refsect2>
153
159
<refsect2>
154
160
<title><anchor id="gimp-chain-button-get-active" role="function"/>gimp_chain_button_get_active ()</title>
155
 
<indexterm><primary>gimp_chain_button_get_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_chain_button_get_active    (<link linkend="GimpChainButton">GimpChainButton</link> *button);</programlisting>
 
161
<indexterm><primary>gimp_chain_button_get_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_chain_button_get_active        (<link linkend="GimpChainButton">GimpChainButton</link> *button);</programlisting>
156
162
<para>
157
163
Checks the state of the <link linkend="GimpChainButton"><type>GimpChainButton</type></link>.</para>
158
164
<para>
166
172
</variablelist></refsect2>
167
173
 
168
174
</refsect1>
169
 
 
170
 
<refsect1 id="signals">
171
 
<title id="signals.title">Signal Details</title>
 
175
<refsect1 role="property_details">
 
176
<title role="property_details.title">Property Details</title>
 
177
<refsect2><title><anchor id="GimpChainButton--position"/>The &quot;<literal>position</literal>&quot; property</title>
 
178
<indexterm role="GIMP 2.4"><primary>GimpChainButton:position</primary></indexterm><programlisting>  &quot;position&quot;                 <link linkend="GimpChainPosition">GimpChainPosition</link>     : Read / Write / Construct Only</programlisting>
 
179
<para>
 
180
The position in which the chain button will be used.</para>
 
181
<para>
 
182
 
 
183
</para><para>Default value: GIMP_CHAIN_TOP</para>
 
184
<para>Since  GIMP 2.4
 
185
</para>
 
186
</refsect2>
 
187
 
 
188
</refsect1>
 
189
 
 
190
<refsect1 role="signals">
 
191
<title role="signals.title">Signal Details</title>
172
192
<refsect2><title><anchor id="GimpChainButton-toggled"/>The &quot;toggled&quot; signal</title>
173
 
<indexterm><primary>GimpChainButton::toggled</primary></indexterm><programlisting><link linkend="void">void</link>        user_function                  (<link linkend="GimpChainButton">GimpChainButton</link> *gimpchainbutton,
174
 
                                            <link linkend="gpointer">gpointer</link>         user_data)            : Run first</programlisting>
 
193
<indexterm><primary>GimpChainButton::toggled</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpChainButton">GimpChainButton</link> *gimpchainbutton,
 
194
                                                        <link linkend="gpointer">gpointer</link>         user_data)            : Run First</programlisting>
175
195
<para>
176
196
 
177
197
</para><variablelist role="params">