← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimppatternselectbutton.xml

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2010-07-12 15:08:08 UTC
  • mfrom: (1.1.23) (0.4.6 sid)
  • Revision ID: package-import@ubuntu.com-20100712150808-db9xqgtxrvpyl3g2
Tags: 2.6.10-1ubuntu1
Resync on Debian, dropping changes which are in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimp/xml/gimppatternselectbutton.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="GimpPatternSelectButton">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page" id="GimpPatternSelectButton.top_of_page">GimpPatternSelectButton</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>GimpPatternSelectButton</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="GimpPatternSelectButton.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>
21
 
                    <link linkend="GimpPatternSelectButton-struct">GimpPatternSelectButton</link>;
22
 
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-pattern-select-button-new">gimp_pattern_select_button_new</link>      (const <link linkend="gchar">gchar</link> *title,
23
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name);
24
 
const <link linkend="gchar">gchar</link> *       <link linkend="gimp-pattern-select-button-get-pattern">gimp_pattern_select_button_get_pattern</link>
25
 
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button);
26
 
<link linkend="void">void</link>                <link linkend="gimp-pattern-select-button-set-pattern">gimp_pattern_select_button_set_pattern</link>
27
 
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button,
28
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name);
29
 
</synopsis>
30
 
</refsynopsisdiv>
31
 
 
32
 
<refsect1 id="GimpPatternSelectButton.object-hierarchy" role="object_hierarchy">
33
 
<title role="object_hierarchy.title">Object Hierarchy</title>
34
 
<synopsis>
35
 
  <link linkend="GObject">GObject</link>
36
 
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
37
 
         +----<link linkend="GtkObject">GtkObject</link>
38
 
               +----<link linkend="GtkWidget">GtkWidget</link>
39
 
                     +----<link linkend="GtkContainer">GtkContainer</link>
40
 
                           +----<link linkend="GtkBox">GtkBox</link>
41
 
                                 +----<link linkend="GtkHBox">GtkHBox</link>
42
 
                                       +----<link linkend="GimpSelectButton">GimpSelectButton</link>
43
 
                                             +----GimpPatternSelectButton
44
 
</synopsis>
45
 
</refsect1>
46
 
 
47
 
 
48
 
 
49
 
<refsect1 id="GimpPatternSelectButton.implemented-interfaces" role="impl_interfaces">
50
 
<title role="impl_interfaces.title">Implemented Interfaces</title>
51
 
<para>
52
 
GimpPatternSelectButton implements
53
 
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
54
 
</refsect1>
55
 
 
56
 
 
57
 
<refsect1 id="GimpPatternSelectButton.properties" role="properties">
58
 
<title role="properties.title">Properties</title>
59
 
<synopsis>
60
 
  &quot;<link linkend="GimpPatternSelectButton--pattern-name">pattern-name</link>&quot;             <link linkend="gchar">gchar</link>*                : Read / Write
61
 
  &quot;<link linkend="GimpPatternSelectButton--title">title</link>&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only
62
 
</synopsis>
63
 
</refsect1>
64
 
 
65
 
<refsect1 id="GimpPatternSelectButton.signals" role="signal_proto">
66
 
<title role="signal_proto.title">Signals</title>
67
 
<synopsis>
68
 
  &quot;<link linkend="GimpPatternSelectButton-pattern-set">pattern-set</link>&quot;                                    : Run First
69
 
</synopsis>
70
 
</refsect1>
71
 
 
72
 
 
73
 
<refsect1 id="GimpPatternSelectButton.description" role="desc">
74
 
<title role="desc.title">Description</title>
75
 
<para>
76
 
</para>
77
 
</refsect1>
78
 
 
79
 
<refsect1 id="GimpPatternSelectButton.details" role="details">
80
 
<title role="details.title">Details</title>
81
 
<refsect2 id="GimpPatternSelectButton-struct" role="struct">
82
 
<title>GimpPatternSelectButton</title>
83
 
<indexterm zone="GimpPatternSelectButton-struct"><primary sortas="GimpPatternSelectButton">GimpPatternSelectButton</primary></indexterm><programlisting>typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</programlisting>
84
 
<para>
85
 
</para></refsect2>
86
 
<refsect2 id="gimp-pattern-select-button-new" role="function" condition="since:GIMP 2.4">
87
 
<title>gimp_pattern_select_button_new ()</title>
88
 
<indexterm zone="gimp-pattern-select-button-new" role="GIMP 2.4"><primary sortas="gimp_pattern_select_button_new">gimp_pattern_select_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_pattern_select_button_new      (const <link linkend="gchar">gchar</link> *title,
89
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
90
 
<para>
91
 
Creates a new <link linkend="GtkWidget"><type>GtkWidget</type></link> that completely controls the selection of
92
 
a pattern.  This widget is suitable for placement in a table in a
93
 
plug-in dialog.</para>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>title</parameter>&#160;:</term>
97
 
<listitem><simpara>        Title of the dialog to use or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to use the default title.
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
100
 
<listitem><simpara> Initial pattern name or <link linkend="NULL--CAPS"><literal>NULL</literal></link> to use current selection.
101
 
</simpara></listitem></varlistentry>
102
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
103
 
 
104
 
</simpara></listitem></varlistentry>
105
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
106
 
<refsect2 id="gimp-pattern-select-button-get-pattern" role="function" condition="since:GIMP 2.4">
107
 
<title>gimp_pattern_select_button_get_pattern ()</title>
108
 
<indexterm zone="gimp-pattern-select-button-get-pattern" role="GIMP 2.4"><primary sortas="gimp_pattern_select_button_get_pattern">gimp_pattern_select_button_get_pattern</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gimp_pattern_select_button_get_pattern
109
 
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button);</programlisting>
110
 
<para>
111
 
Retrieves the name of currently selected pattern.</para>
112
 
<para>
113
 
</para><variablelist role="params">
114
 
<varlistentry><term><parameter>button</parameter>&#160;:</term>
115
 
<listitem><simpara> A <link linkend="GimpPatternSelectButton"><type>GimpPatternSelectButton</type></link>
116
 
</simpara></listitem></varlistentry>
117
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> an internal copy of the pattern name which must not be freed.
118
 
 
119
 
</simpara></listitem></varlistentry>
120
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
121
 
<refsect2 id="gimp-pattern-select-button-set-pattern" role="function" condition="since:GIMP 2.4">
122
 
<title>gimp_pattern_select_button_set_pattern ()</title>
123
 
<indexterm zone="gimp-pattern-select-button-set-pattern" role="GIMP 2.4"><primary sortas="gimp_pattern_select_button_set_pattern">gimp_pattern_select_button_set_pattern</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_pattern_select_button_set_pattern
124
 
                                                        (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button,
125
 
                                                         const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
126
 
<para>
127
 
Sets the current pattern for the pattern select button.</para>
128
 
<para>
129
 
</para><variablelist role="params">
130
 
<varlistentry><term><parameter>button</parameter>&#160;:</term>
131
 
<listitem><simpara> A <link linkend="GimpPatternSelectButton"><type>GimpPatternSelectButton</type></link>
132
 
</simpara></listitem></varlistentry>
133
 
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
134
 
<listitem><simpara> Pattern name to set; <link linkend="NULL--CAPS"><literal>NULL</literal></link> means no change.
135
 
</simpara></listitem></varlistentry>
136
 
</variablelist><para role="since">Since GIMP 2.4</para></refsect2>
137
 
 
138
 
</refsect1>
139
 
<refsect1 id="GimpPatternSelectButton.property-details" role="property_details">
140
 
<title role="property_details.title">Property Details</title>
141
 
<refsect2 id="GimpPatternSelectButton--pattern-name" role="property"><title>The <literal>&quot;pattern-name&quot;</literal> property</title>
142
 
<indexterm zone="GimpPatternSelectButton--pattern-name" role="GIMP 2.4"><primary sortas="GimpPatternSelectButton:pattern-name">GimpPatternSelectButton:pattern-name</primary></indexterm><programlisting>  &quot;pattern-name&quot;             <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
143
 
<para>
144
 
The name of the currently selected pattern.</para>
145
 
<para>
146
 
</para><para>Default value: NULL</para>
147
 
<para>Since GIMP 2.4</para>
148
 
</refsect2>
149
 
<refsect2 id="GimpPatternSelectButton--title" role="property"><title>The <literal>&quot;title&quot;</literal> property</title>
150
 
<indexterm zone="GimpPatternSelectButton--title" role="GIMP 2.4"><primary sortas="GimpPatternSelectButton:title">GimpPatternSelectButton:title</primary></indexterm><programlisting>  &quot;title&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write / Construct Only</programlisting>
151
 
<para>
152
 
The title to be used for the pattern selection popup dialog.</para>
153
 
<para>
154
 
</para><para>Default value: "Pattern Selection"</para>
155
 
<para>Since GIMP 2.4</para>
156
 
</refsect2>
157
 
</refsect1>
158
 
 
159
 
<refsect1 id="GimpPatternSelectButton.signal-details" role="signals">
160
 
<title role="signals.title">Signal Details</title>
161
 
<refsect2 id="GimpPatternSelectButton-pattern-set" role="signal"><title>The <literal>&quot;pattern-set&quot;</literal> signal</title>
162
 
<indexterm zone="GimpPatternSelectButton-pattern-set" role="GIMP 2.4"><primary sortas="GimpPatternSelectButton::pattern-set">GimpPatternSelectButton::pattern-set</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *widget,
163
 
                                                        <link linkend="gchar">gchar</link>                   *pattern_name,
164
 
                                                        <link linkend="gint">gint</link>                     width,
165
 
                                                        <link linkend="gint">gint</link>                     height,
166
 
                                                        <link linkend="gint">gint</link>                     bpp,
167
 
                                                        <link linkend="gpointer">gpointer</link>                 mask_data,
168
 
                                                        <link linkend="gboolean">gboolean</link>                 dialog_closing,
169
 
                                                        <link linkend="gpointer">gpointer</link>                 user_data)           : Run First</programlisting>
170
 
<para>
171
 
The ::pattern-set signal is emitted when the user selects a pattern.</para>
172
 
<para>
173
 
</para><variablelist role="params">
174
 
<varlistentry><term><parameter>widget</parameter>&#160;:</term>
175
 
<listitem><simpara> the object which received the signal.
176
 
</simpara></listitem></varlistentry>
177
 
<varlistentry><term><parameter>pattern_name</parameter>&#160;:</term>
178
 
<listitem><simpara> the name of the currently selected pattern.
179
 
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><parameter>width</parameter>&#160;:</term>
181
 
<listitem><simpara> width of the pattern
182
 
</simpara></listitem></varlistentry>
183
 
<varlistentry><term><parameter>height</parameter>&#160;:</term>
184
 
<listitem><simpara> height of the pattern
185
 
</simpara></listitem></varlistentry>
186
 
<varlistentry><term><parameter>bpp</parameter>&#160;:</term>
187
 
<listitem><simpara> bpp of the pattern
188
 
</simpara></listitem></varlistentry>
189
 
<varlistentry><term><parameter>mask_data</parameter>&#160;:</term>
190
 
<listitem><simpara> pattern mask data
191
 
</simpara></listitem></varlistentry>
192
 
<varlistentry><term><parameter>dialog_closing</parameter>&#160;:</term>
193
 
<listitem><simpara> whether the dialog was closed or not.
194
 
</simpara></listitem></varlistentry>
195
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
196
 
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
197
 
</variablelist><para>Since GIMP 2.4</para></refsect2>
198
 
</refsect1>
199
 
 
200
 
 
201
 
 
202
 
</refentry>