← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpbrowser.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/gimpbrowser.xml
12
12
<refnamediv>
13
13
<refname>GimpBrowser</refname>
14
14
<refpurpose></refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpBrowser.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpBrowser-struct">GimpBrowser</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-browser-new">gimp_browser_new</link>                    (void);
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-browser-new">gimp_browser_new</link>                    (void);
24
23
<link linkend="void">void</link>                <link linkend="gimp-browser-add-search-types">gimp_browser_add_search_types</link>       (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
25
24
                                                         const <link linkend="gchar">gchar</link> *first_type_label,
26
25
                                                         <link linkend="gint">gint</link> first_type_id,
44
43
                                 +----<link linkend="GtkHPaned">GtkHPaned</link>
45
44
                                       +----GimpBrowser
46
45
</synopsis>
47
 
 
48
46
</refsect1>
49
47
 
50
48
 
53
51
<title role="impl_interfaces.title">Implemented Interfaces</title>
54
52
<para>
55
53
GimpBrowser implements
56
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
57
 
 
 
54
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
58
55
</refsect1>
59
56
 
60
57
 
70
67
<refsect1 id="GimpBrowser.description" role="desc">
71
68
<title role="desc.title">Description</title>
72
69
<para>
73
 
 
74
70
</para>
75
71
</refsect1>
76
72
 
78
74
<title role="details.title">Details</title>
79
75
<refsect2 id="GimpBrowser-struct" role="struct">
80
76
<title>GimpBrowser</title>
81
 
<indexterm zone="GimpBrowser-struct"><primary>GimpBrowser</primary></indexterm><programlisting>typedef struct _GimpBrowser GimpBrowser;</programlisting>
 
77
<indexterm zone="GimpBrowser-struct"><primary sortas="GimpBrowser">GimpBrowser</primary></indexterm><programlisting>typedef struct _GimpBrowser GimpBrowser;</programlisting>
82
78
<para>
83
 
 
84
79
</para></refsect2>
85
80
<refsect2 id="gimp-browser-new" role="function" condition="since:GIMP 2.4">
86
81
<title>gimp_browser_new ()</title>
87
 
<indexterm zone="gimp-browser-new" role="GIMP 2.4"><primary>gimp_browser_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_browser_new                    (void);</programlisting>
 
82
<indexterm zone="gimp-browser-new" role="GIMP 2.4"><primary sortas="gimp_browser_new">gimp_browser_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_browser_new                    (void);</programlisting>
88
83
<para>
89
84
Create a new <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget.</para>
90
85
<para>
91
 
 
92
86
</para><variablelist role="params">
93
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly created <link linkend="GimpBrowser"><type>GimpBrowser</type></link>.
 
87
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a newly created <link linkend="GimpBrowser"><type>GimpBrowser</type></link>.
94
88
 
95
89
</simpara></listitem></varlistentry>
96
 
</variablelist><para role="since">Since  GIMP 2.4
97
 
</para></refsect2>
 
90
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
98
91
<refsect2 id="gimp-browser-add-search-types" role="function" condition="since:GIMP 2.4">
99
92
<title>gimp_browser_add_search_types ()</title>
100
 
<indexterm zone="gimp-browser-add-search-types" role="GIMP 2.4"><primary>gimp_browser_add_search_types</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_browser_add_search_types       (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
 
93
<indexterm zone="gimp-browser-add-search-types" role="GIMP 2.4"><primary sortas="gimp_browser_add_search_types">gimp_browser_add_search_types</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_browser_add_search_types       (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
101
94
                                                         const <link linkend="gchar">gchar</link> *first_type_label,
102
95
                                                         <link linkend="gint">gint</link> first_type_id,
103
96
                                                         ...);</programlisting>
104
97
<para>
105
98
Populates the <link linkend="GtkComboBox"><type>GtkComboBox</type></link> with search types.</para>
106
99
<para>
107
 
 
108
100
</para><variablelist role="params">
109
 
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
101
<varlistentry><term><parameter>browser</parameter>&#160;:</term>
110
102
<listitem><simpara>          a <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget
111
103
</simpara></listitem></varlistentry>
112
 
<varlistentry><term><parameter>first_type_label</parameter>&nbsp;:</term>
 
104
<varlistentry><term><parameter>first_type_label</parameter>&#160;:</term>
113
105
<listitem><simpara> the label of the first search type
114
106
</simpara></listitem></varlistentry>
115
 
<varlistentry><term><parameter>first_type_id</parameter>&nbsp;:</term>
 
107
<varlistentry><term><parameter>first_type_id</parameter>&#160;:</term>
116
108
<listitem><simpara>    an integer that identifies the first search type
117
109
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
119
 
<listitem><simpara>              a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated list of more labels and ids.
 
110
<varlistentry><term><parameter>...</parameter>&#160;:</term>
 
111
<listitem><simpara>              a <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated list of more labels and ids.
120
112
</simpara></listitem></varlistentry>
121
 
</variablelist><para role="since">Since  GIMP 2.4
122
 
</para></refsect2>
 
113
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
123
114
<refsect2 id="gimp-browser-set-widget" role="function" condition="since:GIMP 2.4">
124
115
<title>gimp_browser_set_widget ()</title>
125
 
<indexterm zone="gimp-browser-set-widget" role="GIMP 2.4"><primary>gimp_browser_set_widget</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_browser_set_widget             (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
 
116
<indexterm zone="gimp-browser-set-widget" role="GIMP 2.4"><primary sortas="gimp_browser_set_widget">gimp_browser_set_widget</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_browser_set_widget             (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
126
117
                                                         <link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
127
118
<para>
128
119
Sets the widget to appear on the right side of the <parameter>browser</parameter>.</para>
129
120
<para>
130
 
 
131
121
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
122
<varlistentry><term><parameter>browser</parameter>&#160;:</term>
133
123
<listitem><simpara> a <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget
134
124
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
125
<varlistentry><term><parameter>widget</parameter>&#160;:</term>
136
126
<listitem><simpara>  a <link linkend="GtkWidget"><type>GtkWidget</type></link>
137
127
</simpara></listitem></varlistentry>
138
 
</variablelist><para role="since">Since  GIMP 2.4
139
 
</para></refsect2>
 
128
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
140
129
<refsect2 id="gimp-browser-show-message" role="function" condition="since:GIMP 2.4">
141
130
<title>gimp_browser_show_message ()</title>
142
 
<indexterm zone="gimp-browser-show-message" role="GIMP 2.4"><primary>gimp_browser_show_message</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_browser_show_message           (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
 
131
<indexterm zone="gimp-browser-show-message" role="GIMP 2.4"><primary sortas="gimp_browser_show_message">gimp_browser_show_message</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_browser_show_message           (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
143
132
                                                         const <link linkend="gchar">gchar</link> *message);</programlisting>
144
133
<para>
145
134
Displays <parameter>message</parameter> in the right side of the <parameter>browser</parameter>. Unless the right
146
135
side already contains a <link linkend="GtkLabel"><type>GtkLabel</type></link>, the widget previously added with
147
136
<link linkend="gimp-browser-set-widget"><function>gimp_browser_set_widget()</function></link> is removed and replaced by a <link linkend="GtkLabel"><type>GtkLabel</type></link>.</para>
148
137
<para>
149
 
 
150
138
</para><variablelist role="params">
151
 
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
139
<varlistentry><term><parameter>browser</parameter>&#160;:</term>
152
140
<listitem><simpara> a <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget
153
141
</simpara></listitem></varlistentry>
154
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
142
<varlistentry><term><parameter>message</parameter>&#160;:</term>
155
143
<listitem><simpara> text message
156
144
</simpara></listitem></varlistentry>
157
 
</variablelist><para role="since">Since  GIMP 2.4
158
 
</para></refsect2>
 
145
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
159
146
 
160
147
</refsect1>
161
148
 
162
149
<refsect1 id="GimpBrowser.signal-details" role="signals">
163
150
<title role="signals.title">Signal Details</title>
164
 
<refsect2 id="GimpBrowser-search"><title>The <literal>&quot;search&quot;</literal> signal</title>
165
 
<indexterm zone="GimpBrowser-search"><primary>GimpBrowser::search</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpBrowser">GimpBrowser</link> *gimpbrowser,
 
151
<refsect2 id="GimpBrowser-search" role="signal"><title>The <literal>&quot;search&quot;</literal> signal</title>
 
152
<indexterm zone="GimpBrowser-search"><primary sortas="GimpBrowser::search">GimpBrowser::search</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpBrowser">GimpBrowser</link> *gimpbrowser,
166
153
                                                        <link linkend="gchar">gchar</link>       *arg1,
167
154
                                                        <link linkend="gint">gint</link>         arg2,
168
155
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
169
156
<para>
170
 
 
171
157
</para><variablelist role="params">
172
 
<varlistentry><term><parameter>gimpbrowser</parameter>&nbsp;:</term>
 
158
<varlistentry><term><parameter>gimpbrowser</parameter>&#160;:</term>
173
159
<listitem><simpara>the object which received the signal.
174
160
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
176
 
<listitem><simpara>
177
 
</simpara></listitem></varlistentry>
178
 
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
179
 
<listitem><simpara>
180
 
 
181
 
</simpara></listitem></varlistentry>
182
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
161
<varlistentry><term><parameter>arg1</parameter>&#160;:</term>
 
162
<listitem><simpara>
 
163
</simpara></listitem></varlistentry>
 
164
<varlistentry><term><parameter>arg2</parameter>&#160;:</term>
 
165
<listitem><simpara>
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
183
168
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
184
169
</variablelist></refsect2>
185
170
</refsect1>