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

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/xml/gimpdrawablecombobox.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:
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="libgimp-gimpdrawablecombobox">
6
 
<refmeta>
7
 
<refentrytitle role="top_of_page">gimpdrawablecombobox</refentrytitle>
8
 
<manvolnum>3</manvolnum>
9
 
<refmiscinfo>LIBGIMP Library</refmiscinfo>
10
 
</refmeta>
11
 
 
12
 
<refnamediv>
13
 
<refname>gimpdrawablecombobox</refname>
14
 
<refpurpose>A widget providing a popup menu of drawables.</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="gboolean">gboolean</link>    (<link linkend="GimpDrawableConstraintFunc">*GimpDrawableConstraintFunc</link>)   (<link linkend="gint32">gint32</link> image_id,
26
 
                                             <link linkend="gint32">gint32</link> drawable_id,
27
 
                                             <link linkend="gpointer">gpointer</link> data);
28
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-drawable-combo-box-new">gimp_drawable_combo_box_new</link>     (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
29
 
                                             <link linkend="gpointer">gpointer</link> data);
30
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-channel-combo-box-new">gimp_channel_combo_box_new</link>      (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
31
 
                                             <link linkend="gpointer">gpointer</link> data);
32
 
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-layer-combo-box-new">gimp_layer_combo_box_new</link>        (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
33
 
                                             <link linkend="gpointer">gpointer</link> data);
34
 
</synopsis>
35
 
</refsynopsisdiv>
36
 
 
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
<refsect1 role="desc">
46
 
<title role="desc.title">Description</title>
47
 
<para>
48
 
A widget providing a popup menu of drawables.
49
 
</para>
50
 
</refsect1>
51
 
 
52
 
<refsect1 role="details">
53
 
<title role="details.title">Details</title>
54
 
<refsect2>
55
 
<title><anchor id="GimpDrawableConstraintFunc" role="function"/>GimpDrawableConstraintFunc ()</title>
56
 
<indexterm><primary>GimpDrawableConstraintFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    (*GimpDrawableConstraintFunc)   (<link linkend="gint32">gint32</link> image_id,
57
 
                                             <link linkend="gint32">gint32</link> drawable_id,
58
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
59
 
<para>
60
 
 
61
 
</para><variablelist role="params">
62
 
<varlistentry><term><parameter>image_id</parameter>&nbsp;:</term>
63
 
<listitem><simpara>
64
 
</simpara></listitem></varlistentry>
65
 
<varlistentry><term><parameter>drawable_id</parameter>&nbsp;:</term>
66
 
<listitem><simpara>
67
 
</simpara></listitem></varlistentry>
68
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
69
 
<listitem><simpara>
70
 
</simpara></listitem></varlistentry>
71
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
72
 
 
73
 
 
74
 
</simpara></listitem></varlistentry>
75
 
</variablelist></refsect2>
76
 
<refsect2>
77
 
<title><anchor id="gimp-drawable-combo-box-new" role="function" condition="since:GIMP 2.2"/>gimp_drawable_combo_box_new ()</title>
78
 
<indexterm role="GIMP 2.2"><primary>gimp_drawable_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_drawable_combo_box_new     (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
79
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
80
 
<para>
81
 
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
82
 
drawables. If a <parameter>constraint</parameter> function is specified, it is called for
83
 
each drawable and only if the function returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the drawable
84
 
is added to the combobox.
85
 
</para>
86
 
<para>
87
 
You should use <link linkend="gimp-int-combo-box-connect"><function>gimp_int_combo_box_connect()</function></link> to initialize and connect
88
 
the combo.  Use <link linkend="gimp-int-combo-box-set-active"><function>gimp_int_combo_box_set_active()</function></link> to get the active
89
 
drawable ID and <link linkend="gimp-int-combo-box-get-active"><function>gimp_int_combo_box_get_active()</function></link> to retrieve the ID
90
 
of the selected drawable.</para>
91
 
<para>
92
 
 
93
 
</para><variablelist role="params">
94
 
<varlistentry><term><parameter>constraint</parameter>&nbsp;:</term>
95
 
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
96
 
</simpara></listitem></varlistentry>
97
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
98
 
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
99
 
</simpara></listitem></varlistentry>
100
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
101
 
 
102
 
</simpara></listitem></varlistentry>
103
 
</variablelist><para>Since  GIMP 2.2
104
 
</para></refsect2>
105
 
<refsect2>
106
 
<title><anchor id="gimp-channel-combo-box-new" role="function" condition="since:GIMP 2.2"/>gimp_channel_combo_box_new ()</title>
107
 
<indexterm role="GIMP 2.2"><primary>gimp_channel_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_channel_combo_box_new      (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
108
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
109
 
<para>
110
 
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
111
 
channels. See <link linkend="gimp-drawable-combo-box"><function>gimp_drawable_combo_box()</function></link> for more info.</para>
112
 
<para>
113
 
 
114
 
</para><variablelist role="params">
115
 
<varlistentry><term><parameter>constraint</parameter>&nbsp;:</term>
116
 
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
117
 
</simpara></listitem></varlistentry>
118
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
119
 
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
122
 
 
123
 
</simpara></listitem></varlistentry>
124
 
</variablelist><para>Since  GIMP 2.2
125
 
</para></refsect2>
126
 
<refsect2>
127
 
<title><anchor id="gimp-layer-combo-box-new" role="function" condition="since:GIMP 2.2"/>gimp_layer_combo_box_new ()</title>
128
 
<indexterm role="GIMP 2.2"><primary>gimp_layer_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_layer_combo_box_new        (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
129
 
                                             <link linkend="gpointer">gpointer</link> data);</programlisting>
130
 
<para>
131
 
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
132
 
layers. See <link linkend="gimp-drawable-combo-box"><function>gimp_drawable_combo_box()</function></link> for more info.</para>
133
 
<para>
134
 
 
135
 
</para><variablelist role="params">
136
 
<varlistentry><term><parameter>constraint</parameter>&nbsp;:</term>
137
 
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
140
 
<listitem><simpara>       a pointer that is passed to <parameter>constraint</parameter>
141
 
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
143
 
 
144
 
</simpara></listitem></varlistentry>
145
 
</variablelist><para>Since  GIMP 2.2
146
 
</para></refsect2>
147
 
 
148
 
</refsect1>
149
 
 
150
 
 
151
 
 
152
 
 
153
 
</refentry>