← 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/gimpbrowser.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/gimpbrowser.xml
 
1
<?xml version="1.0" encoding="UTF-8" ?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
 
4
 
 
5
<refentry id="GimpBrowser">
 
6
<refmeta>
 
7
<refentrytitle role="top_of_page">GimpBrowser</refentrytitle>
 
8
<manvolnum>3</manvolnum>
 
9
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
 
10
</refmeta>
 
11
 
 
12
<refnamediv>
 
13
<refname>GimpBrowser</refname>
 
14
<refpurpose></refpurpose>
 
15
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
16
</refnamediv>
 
17
 
 
18
<refsynopsisdiv role="synopsis">
 
19
<title role="synopsis.title">Synopsis</title>
 
20
 
 
21
<synopsis>
 
22
 
 
23
 
 
24
 
 
25
                    <link linkend="GimpBrowser-struct">GimpBrowser</link>;
 
26
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-browser-new">gimp_browser_new</link>                    (void);
 
27
<link linkend="void">void</link>                <link linkend="gimp-browser-add-search-types">gimp_browser_add_search_types</link>       (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
 
28
                                                         const <link linkend="gchar">gchar</link> *first_type_label,
 
29
                                                         <link linkend="gint">gint</link> first_type_id,
 
30
                                                         ...);
 
31
<link linkend="void">void</link>                <link linkend="gimp-browser-set-widget">gimp_browser_set_widget</link>             (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
 
32
                                                         <link linkend="GtkWidget">GtkWidget</link> *widget);
 
33
<link linkend="void">void</link>                <link linkend="gimp-browser-show-message">gimp_browser_show_message</link>           (<link linkend="GimpBrowser">GimpBrowser</link> *browser,
 
34
                                                         const <link linkend="gchar">gchar</link> *message);
 
35
 
 
36
</synopsis>
 
37
</refsynopsisdiv>
 
38
 
 
39
<refsect1 role="object_hierarchy">
 
40
<title role="object_hierarchy.title">Object Hierarchy</title>
 
41
<synopsis>
 
42
 
 
43
  <link linkend="GObject">GObject</link>
 
44
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
45
         +----<link linkend="GtkObject">GtkObject</link>
 
46
               +----<link linkend="GtkWidget">GtkWidget</link>
 
47
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
48
                           +----<link linkend="GtkPaned">GtkPaned</link>
 
49
                                 +----<link linkend="GtkHPaned">GtkHPaned</link>
 
50
                                       +----GimpBrowser
 
51
</synopsis>
 
52
 
 
53
</refsect1>
 
54
 
 
55
 
 
56
 
 
57
<refsect1 role="impl_interfaces">
 
58
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
59
<para>
 
60
GimpBrowser implements
 
61
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
 
62
 
 
63
</refsect1>
 
64
 
 
65
 
 
66
 
 
67
<refsect1 role="signal_proto">
 
68
<title role="signal_proto.title">Signals</title>
 
69
<synopsis>
 
70
 
 
71
  &quot;<link linkend="GimpBrowser-search">search</link>&quot;                                         : Run Last
 
72
</synopsis>
 
73
</refsect1>
 
74
 
 
75
 
 
76
<refsect1 role="desc">
 
77
<title role="desc.title">Description</title>
 
78
<para>
 
79
 
 
80
</para>
 
81
</refsect1>
 
82
 
 
83
<refsect1 role="details">
 
84
<title role="details.title">Details</title>
 
85
<refsect2>
 
86
<title><anchor id="GimpBrowser-struct" role="struct"/>GimpBrowser</title>
 
87
<indexterm><primary>GimpBrowser</primary></indexterm><programlisting>typedef struct _GimpBrowser GimpBrowser;</programlisting>
 
88
<para>
 
89
 
 
90
</para></refsect2>
 
91
<refsect2>
 
92
<title><anchor id="gimp-browser-new" role="function" condition="since:GIMP 2.4"/>gimp_browser_new ()</title>
 
93
<indexterm role="GIMP 2.4"><primary>gimp_browser_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_browser_new                    (void);</programlisting>
 
94
<para>
 
95
Create a new <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget.</para>
 
96
<para>
 
97
 
 
98
</para><variablelist role="params">
 
99
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly created <link linkend="GimpBrowser"><type>GimpBrowser</type></link>.
 
100
 
 
101
</simpara></listitem></varlistentry>
 
102
</variablelist><para role="since">Since  GIMP 2.4
 
103
</para></refsect2>
 
104
<refsect2>
 
105
<title><anchor id="gimp-browser-add-search-types" role="function" condition="since:GIMP 2.4"/>gimp_browser_add_search_types ()</title>
 
106
<indexterm 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,
 
107
                                                         const <link linkend="gchar">gchar</link> *first_type_label,
 
108
                                                         <link linkend="gint">gint</link> first_type_id,
 
109
                                                         ...);</programlisting>
 
110
<para>
 
111
Populates the <link linkend="GtkComboBox"><type>GtkComboBox</type></link> with search types.</para>
 
112
<para>
 
113
 
 
114
</para><variablelist role="params">
 
115
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
116
<listitem><simpara>          a <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget
 
117
</simpara></listitem></varlistentry>
 
118
<varlistentry><term><parameter>first_type_label</parameter>&nbsp;:</term>
 
119
<listitem><simpara> the label of the first search type
 
120
</simpara></listitem></varlistentry>
 
121
<varlistentry><term><parameter>first_type_id</parameter>&nbsp;:</term>
 
122
<listitem><simpara>    an integer that identifies the first search type
 
123
</simpara></listitem></varlistentry>
 
124
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
125
<listitem><simpara>              a <link linkend="NULL:CAPS"><literal>NULL</literal></link>-terminated list of more labels and ids.
 
126
</simpara></listitem></varlistentry>
 
127
</variablelist><para role="since">Since  GIMP 2.4
 
128
</para></refsect2>
 
129
<refsect2>
 
130
<title><anchor id="gimp-browser-set-widget" role="function" condition="since:GIMP 2.4"/>gimp_browser_set_widget ()</title>
 
131
<indexterm 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,
 
132
                                                         <link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
 
133
<para>
 
134
Sets the widget to appear on the right side of the <parameter>browser</parameter>.</para>
 
135
<para>
 
136
 
 
137
</para><variablelist role="params">
 
138
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
139
<listitem><simpara> a <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget
 
140
</simpara></listitem></varlistentry>
 
141
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
142
<listitem><simpara>  a <link linkend="GtkWidget"><type>GtkWidget</type></link>
 
143
</simpara></listitem></varlistentry>
 
144
</variablelist><para role="since">Since  GIMP 2.4
 
145
</para></refsect2>
 
146
<refsect2>
 
147
<title><anchor id="gimp-browser-show-message" role="function" condition="since:GIMP 2.4"/>gimp_browser_show_message ()</title>
 
148
<indexterm 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,
 
149
                                                         const <link linkend="gchar">gchar</link> *message);</programlisting>
 
150
<para>
 
151
Displays <parameter>message</parameter> in the right side of the <parameter>browser</parameter>. Unless the right
 
152
side already contains a <link linkend="GtkLabel"><type>GtkLabel</type></link>, the widget previously added with
 
153
<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>
 
154
<para>
 
155
 
 
156
</para><variablelist role="params">
 
157
<varlistentry><term><parameter>browser</parameter>&nbsp;:</term>
 
158
<listitem><simpara> a <link linkend="GimpBrowser"><type>GimpBrowser</type></link> widget
 
159
</simpara></listitem></varlistentry>
 
160
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
161
<listitem><simpara> text message
 
162
</simpara></listitem></varlistentry>
 
163
</variablelist><para role="since">Since  GIMP 2.4
 
164
</para></refsect2>
 
165
 
 
166
</refsect1>
 
167
 
 
168
<refsect1 role="signals">
 
169
<title role="signals.title">Signal Details</title>
 
170
<refsect2><title><anchor id="GimpBrowser-search"/>The &quot;search&quot; signal</title>
 
171
<indexterm><primary>GimpBrowser::search</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpBrowser">GimpBrowser</link> *gimpbrowser,
 
172
                                                        <link linkend="gchar">gchar</link>       *arg1,
 
173
                                                        <link linkend="gint">gint</link>         arg2,
 
174
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
 
175
<para>
 
176
 
 
177
</para><variablelist role="params">
 
178
<varlistentry><term><parameter>gimpbrowser</parameter>&nbsp;:</term>
 
179
<listitem><simpara>the object which received the signal.
 
180
</simpara></listitem></varlistentry>
 
181
<varlistentry><term><parameter>arg1</parameter>&nbsp;:</term>
 
182
<listitem><simpara>
 
183
</simpara></listitem></varlistentry>
 
184
<varlistentry><term><parameter>arg2</parameter>&nbsp;:</term>
 
185
<listitem><simpara>
 
186
 
 
187
</simpara></listitem></varlistentry>
 
188
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
189
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
 
190
</variablelist></refsect2>
 
191
</refsect1>
 
192
 
 
193
 
 
194
 
 
195
</refentry>