← Back to branch summary

~ubuntu-branches/ubuntu/trusty/gimp/trusty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Ari Pollak
  • Date: 2009-08-14 09:57:17 UTC
  • mto: (1.1.21 upstream) (0.1.5 squeeze)
  • mto: This revision was merged to the branch mainline in revision 48.
  • Revision ID: james.westby@ubuntu.com-20090814095717-37dh2xqy5t0rurpk
Import upstream version 2.6.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpcellrenderertoggle.xml
12
12
<refnamediv>
13
13
<refname>GimpCellRendererToggle</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpCellRendererToggle.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpCellRendererToggle-struct">GimpCellRendererToggle</link>;
23
 
<link linkend="GtkCellRenderer">GtkCellRenderer</link>*    <link linkend="gimp-cell-renderer-toggle-new">gimp_cell_renderer_toggle_new</link>       (const <link linkend="gchar">gchar</link> *stock_id);
 
22
<link linkend="GtkCellRenderer">GtkCellRenderer</link> *   <link linkend="gimp-cell-renderer-toggle-new">gimp_cell_renderer_toggle_new</link>       (const <link linkend="gchar">gchar</link> *stock_id);
24
23
<link linkend="void">void</link>                <link linkend="gimp-cell-renderer-toggle-clicked">gimp_cell_renderer_toggle_clicked</link>   (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *cell,
25
24
                                                         const <link linkend="gchar">gchar</link> *path,
26
25
                                                         <link linkend="GdkModifierType">GdkModifierType</link> state);
37
36
                     +----<link linkend="GtkCellRendererToggle">GtkCellRendererToggle</link>
38
37
                           +----GimpCellRendererToggle
39
38
</synopsis>
40
 
 
41
39
</refsect1>
42
40
 
43
41
 
63
61
<refsect1 id="GimpCellRendererToggle.description" role="desc">
64
62
<title role="desc.title">Description</title>
65
63
<para>
66
 
 
67
64
</para>
68
65
</refsect1>
69
66
 
71
68
<title role="details.title">Details</title>
72
69
<refsect2 id="GimpCellRendererToggle-struct" role="struct">
73
70
<title>GimpCellRendererToggle</title>
74
 
<indexterm zone="GimpCellRendererToggle-struct"><primary>GimpCellRendererToggle</primary></indexterm><programlisting>typedef struct _GimpCellRendererToggle GimpCellRendererToggle;</programlisting>
 
71
<indexterm zone="GimpCellRendererToggle-struct"><primary sortas="GimpCellRendererToggle">GimpCellRendererToggle</primary></indexterm><programlisting>typedef struct _GimpCellRendererToggle GimpCellRendererToggle;</programlisting>
75
72
<para>
76
 
 
77
73
</para></refsect2>
78
74
<refsect2 id="gimp-cell-renderer-toggle-new" role="function" condition="since:GIMP 2.2">
79
75
<title>gimp_cell_renderer_toggle_new ()</title>
80
 
<indexterm zone="gimp-cell-renderer-toggle-new" role="GIMP 2.2"><primary>gimp_cell_renderer_toggle_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link>*    gimp_cell_renderer_toggle_new       (const <link linkend="gchar">gchar</link> *stock_id);</programlisting>
 
76
<indexterm zone="gimp-cell-renderer-toggle-new" role="GIMP 2.2"><primary sortas="gimp_cell_renderer_toggle_new">gimp_cell_renderer_toggle_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link> *   gimp_cell_renderer_toggle_new       (const <link linkend="gchar">gchar</link> *stock_id);</programlisting>
81
77
<para>
82
78
Creates a custom version of the <link linkend="GtkCellRendererToggle"><type>GtkCellRendererToggle</type></link>. Instead of
83
79
showing the standard toggle button, it shows a stock icon if the
84
80
cell is active and no icon otherwise. This cell renderer is for
85
81
example used in the Layers treeview to indicate and control the
86
 
layer's visibility by showing <link linkend="GIMP-STOCK-VISIBLE:CAPS"><literal>GIMP_STOCK_VISIBLE</literal></link>.</para>
 
82
layer's visibility by showing <link linkend="GIMP-STOCK-VISIBLE--CAPS"><literal>GIMP_STOCK_VISIBLE</literal></link>.</para>
87
83
<para>
88
 
 
89
84
</para><variablelist role="params">
90
 
<varlistentry><term><parameter>stock_id</parameter>&nbsp;:</term>
 
85
<varlistentry><term><parameter>stock_id</parameter>&#160;:</term>
91
86
<listitem><simpara> the stock_id of the icon to use for the active state
92
87
</simpara></listitem></varlistentry>
93
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>
 
88
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>
94
89
 
95
90
</simpara></listitem></varlistentry>
96
 
</variablelist><para role="since">Since  GIMP 2.2
97
 
</para></refsect2>
 
91
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
98
92
<refsect2 id="gimp-cell-renderer-toggle-clicked" role="function" condition="since:GIMP 2.2">
99
93
<title>gimp_cell_renderer_toggle_clicked ()</title>
100
 
<indexterm zone="gimp-cell-renderer-toggle-clicked" role="GIMP 2.2"><primary>gimp_cell_renderer_toggle_clicked</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_cell_renderer_toggle_clicked   (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *cell,
 
94
<indexterm zone="gimp-cell-renderer-toggle-clicked" role="GIMP 2.2"><primary sortas="gimp_cell_renderer_toggle_clicked">gimp_cell_renderer_toggle_clicked</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_cell_renderer_toggle_clicked   (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *cell,
101
95
                                                         const <link linkend="gchar">gchar</link> *path,
102
96
                                                         <link linkend="GdkModifierType">GdkModifierType</link> state);</programlisting>
103
97
<para>
104
98
Emits the "clicked" signal from a <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>.</para>
105
99
<para>
106
 
 
107
100
</para><variablelist role="params">
108
 
<varlistentry><term><parameter>cell</parameter>&nbsp;:</term>
 
101
<varlistentry><term><parameter>cell</parameter>&#160;:</term>
109
102
<listitem><simpara> a <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>
110
103
</simpara></listitem></varlistentry>
111
 
<varlistentry><term><parameter>path</parameter>&nbsp;:</term>
112
 
<listitem><simpara>
113
 
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><parameter>state</parameter>&nbsp;:</term>
115
 
<listitem><simpara>
116
 
</simpara></listitem></varlistentry>
117
 
</variablelist><para role="since">Since  GIMP 2.2
118
 
</para></refsect2>
 
104
<varlistentry><term><parameter>path</parameter>&#160;:</term>
 
105
<listitem><simpara>
 
106
</simpara></listitem></varlistentry>
 
107
<varlistentry><term><parameter>state</parameter>&#160;:</term>
 
108
<listitem><simpara>
 
109
</simpara></listitem></varlistentry>
 
110
</variablelist><para role="since">Since GIMP 2.2</para></refsect2>
119
111
 
120
112
</refsect1>
121
113
<refsect1 id="GimpCellRendererToggle.property-details" role="property_details">
122
114
<title role="property_details.title">Property Details</title>
123
 
<refsect2 id="GimpCellRendererToggle--stock-id"><title>The <literal>&quot;stock-id&quot;</literal> property</title>
124
 
<indexterm zone="GimpCellRendererToggle--stock-id"><primary>GimpCellRendererToggle:stock-id</primary></indexterm><programlisting>  &quot;stock-id&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
 
115
<refsect2 id="GimpCellRendererToggle--stock-id" role="property"><title>The <literal>&quot;stock-id&quot;</literal> property</title>
 
116
<indexterm zone="GimpCellRendererToggle--stock-id"><primary sortas="GimpCellRendererToggle:stock-id">GimpCellRendererToggle:stock-id</primary></indexterm><programlisting>  &quot;stock-id&quot;                 <link linkend="gchar">gchar</link>*                : Read / Write / Construct</programlisting>
125
117
<para></para><para>Default value: NULL</para>
126
118
</refsect2>
127
 
<refsect2 id="GimpCellRendererToggle--stock-size"><title>The <literal>&quot;stock-size&quot;</literal> property</title>
128
 
<indexterm zone="GimpCellRendererToggle--stock-size"><primary>GimpCellRendererToggle:stock-size</primary></indexterm><programlisting>  &quot;stock-size&quot;               <link linkend="gint">gint</link>                  : Read / Write / Construct</programlisting>
 
119
<refsect2 id="GimpCellRendererToggle--stock-size" role="property"><title>The <literal>&quot;stock-size&quot;</literal> property</title>
 
120
<indexterm zone="GimpCellRendererToggle--stock-size"><primary sortas="GimpCellRendererToggle:stock-size">GimpCellRendererToggle:stock-size</primary></indexterm><programlisting>  &quot;stock-size&quot;               <link linkend="gint">gint</link>                  : Read / Write / Construct</programlisting>
129
121
<para></para><para>Allowed values: &gt;= 0</para>
130
122
<para>Default value: 4</para>
131
123
</refsect2>
132
 
 
133
124
</refsect1>
134
125
 
135
126
<refsect1 id="GimpCellRendererToggle.signal-details" role="signals">
136
127
<title role="signals.title">Signal Details</title>
137
 
<refsect2 id="GimpCellRendererToggle-clicked"><title>The <literal>&quot;clicked&quot;</literal> signal</title>
138
 
<indexterm zone="GimpCellRendererToggle-clicked"><primary>GimpCellRendererToggle::clicked</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *gimpcellrenderertoggle,
 
128
<refsect2 id="GimpCellRendererToggle-clicked" role="signal"><title>The <literal>&quot;clicked&quot;</literal> signal</title>
 
129
<indexterm zone="GimpCellRendererToggle-clicked"><primary sortas="GimpCellRendererToggle::clicked">GimpCellRendererToggle::clicked</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *gimpcellrenderertoggle,
139
130
                                                        <link linkend="gchar">gchar</link>                  *arg1,
140
131
                                                        <link linkend="GdkModifierType">GdkModifierType</link>         arg2,
141
132
                                                        <link linkend="gpointer">gpointer</link>                user_data)                   : Run Last</programlisting>
142
133
<para>
143
 
 
144
134
</para><variablelist role="params">
145
 
<varlistentry><term><parameter>gimpcellrenderertoggle</parameter>&nbsp;:</term>
 
135
<varlistentry><term><parameter>gimpcellrenderertoggle</parameter>&#160;:</term>
146
136
<listitem><simpara>the object which received the signal.
147
137
</simpara></listitem></varlistentry>
148
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
149
 
<listitem><simpara>
150
 
</simpara></listitem></varlistentry>
151
 
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
152
 
<listitem><simpara>
153
 
 
154
 
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
138
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
 
139
<listitem><simpara>
 
140
</simpara></listitem></varlistentry>
 
141
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
 
142
<listitem><simpara>
 
143
</simpara></listitem></varlistentry>
 
144
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
156
145
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
157
146
</variablelist></refsect2>
158
147
</refsect1>