← Back to branch summary

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

« back to all changes in this revision

Viewing changes to devel-docs/libgimp/html/libgimp-gimppalettes.html

  • 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/libgimp/html/libgimp-gimppalettes.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimppalettes</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
8
8
<link rel="up" href="libgimp-data.html" title="Data Objects">
9
9
<link rel="prev" href="libgimp-gimppalette.html" title="gimppalette">
10
10
<link rel="next" href="libgimp-gimppattern.html" title="gimppattern">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="part" href="gimpdefinitions.html" title="Part&#160;I.&#160;GIMP Constants">
14
 
<link rel="part" href="libgimp.html" title="Part&#160;II.&#160;GIMP Library">
 
13
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
15
14
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
16
 
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and all their Properties">
 
15
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
17
16
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
18
17
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
19
 
<link rel="part" href="libgimpui.html" title="Part&#160;III.&#160;GIMP User Interface Library">
 
18
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
20
19
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
 
20
<link rel="index" href="libgimp-index.html" title="Index">
 
21
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
22
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
23
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
21
24
</head>
22
25
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
23
26
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
28
31
<th width="100%" align="center">GIMP Library Reference Manual</th>
29
32
<td><a accesskey="n" href="libgimp-gimppattern.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
30
33
</tr>
31
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2538384" class="shortcut">Top</a>
 
34
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2581276" class="shortcut">Top</a>
32
35
                  &#160;|&#160;
33
 
                  <a href="#id2639362" class="shortcut">Description</a></nobr></td></tr>
 
36
                  <a href="#id2690206" class="shortcut">Description</a></nobr></td></tr>
34
37
</table>
35
38
<div class="refentry" lang="en">
36
39
<a name="libgimp-gimppalettes"></a><div class="titlepage"></div>
37
40
<div class="refnamediv"><table width="100%"><tr>
38
41
<td valign="top">
39
42
<h2>
40
 
<a name="id2538384"></a><span class="refentrytitle">gimppalettes</span>
 
43
<a name="id2581276"></a><span class="refentrytitle">gimppalettes</span>
41
44
</h2>
42
45
<p>gimppalettes &#8212; Operations related to palettes.</p>
43
46
</td>
49
52
 
50
53
 
51
54
 
52
 
gboolean    <a href="libgimp-gimppalettes.html#gimp-palettes-refresh">gimp_palettes_refresh</a>           (void);
53
 
gchar**     <a href="libgimp-gimppalettes.html#gimp-palettes-get-list">gimp_palettes_get_list</a>          (const gchar *filter,
54
 
                                             gint *num_palettes);
55
 
gchar*      <a href="libgimp-gimppalettes.html#gimp-palettes-get-palette">gimp_palettes_get_palette</a>       (gint *num_colors);
56
 
gboolean    <a href="libgimp-gimppalettes.html#gimp-palettes-set-palette">gimp_palettes_set_palette</a>       (const gchar *name);
57
 
gchar*      <a href="libgimp-gimppalettes.html#gimp-palettes-get-palette-entry">gimp_palettes_get_palette_entry</a> (const gchar *name,
58
 
                                             gint entry_num,
59
 
                                             gint *num_colors,
60
 
                                             <a
 
55
gboolean            <a href="libgimp-gimppalettes.html#gimp-palettes-refresh">gimp_palettes_refresh</a>               (void);
 
56
gchar**             <a href="libgimp-gimppalettes.html#gimp-palettes-get-list">gimp_palettes_get_list</a>              (const gchar *filter,
 
57
                                                         gint *num_palettes);
 
58
gchar*              <a href="libgimp-gimppalettes.html#gimp-palettes-get-palette">gimp_palettes_get_palette</a>           (gint *num_colors);
 
59
gboolean            <a href="libgimp-gimppalettes.html#gimp-palettes-set-palette">gimp_palettes_set_palette</a>           (const gchar *name);
 
60
gchar*              <a href="libgimp-gimppalettes.html#gimp-palettes-get-palette-entry">gimp_palettes_get_palette_entry</a>     (const gchar *name,
 
61
                                                         gint entry_num,
 
62
                                                         gint *num_colors,
 
63
                                                         <a
61
64
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
62
65
>GimpRGB</a> *color);
63
66
</pre>
64
67
</div>
65
68
<div class="refsect1" lang="en">
66
 
<a name="id2639362"></a><h2>Description</h2>
 
69
<a name="id2690206"></a><h2>Description</h2>
67
70
<p>
68
71
Operations related to palettes.
69
72
</p>
70
73
</div>
71
74
<div class="refsect1" lang="en">
72
 
<a name="id2639377"></a><h2>Details</h2>
 
75
<a name="id2690222"></a><h2>Details</h2>
73
76
<div class="refsect2" lang="en">
74
 
<a name="id2639388"></a><h3>
 
77
<a name="id2690232"></a><h3>
75
78
<a name="gimp-palettes-refresh"></a>gimp_palettes_refresh ()</h3>
76
 
<a class="indexterm" name="id2639399"></a><pre class="programlisting">gboolean    gimp_palettes_refresh           (void);</pre>
 
79
<a class="indexterm" name="id2690243"></a><pre class="programlisting">gboolean            gimp_palettes_refresh               (void);</pre>
77
80
<p>
78
81
Refreshes current palettes. This function always succeeds.
79
82
</p>
86
89
<div class="variablelist"><table border="0">
87
90
<col align="left" valign="top">
88
91
<tbody><tr>
89
 
<td>
90
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
92
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
91
93
<td> TRUE on success.
92
94
</td>
93
95
</tr></tbody>
95
97
</div>
96
98
<hr>
97
99
<div class="refsect2" lang="en">
98
 
<a name="id2638722"></a><h3>
 
100
<a name="id2690289"></a><h3>
99
101
<a name="gimp-palettes-get-list"></a>gimp_palettes_get_list ()</h3>
100
 
<a class="indexterm" name="id2638732"></a><pre class="programlisting">gchar**     gimp_palettes_get_list          (const gchar *filter,
101
 
                                             gint *num_palettes);</pre>
 
102
<a class="indexterm" name="id2690300"></a><pre class="programlisting">gchar**             gimp_palettes_get_list              (const gchar *filter,
 
103
                                                         gint *num_palettes);</pre>
102
104
<p>
103
105
Retrieves a list of all of the available palettes
104
106
</p>
105
107
<p>
106
108
This procedure returns a complete listing of available palettes.
107
109
Each name returned can be used as input to the command
108
 
'gimp_context_set_palette'.</p>
 
110
<a href="libgimp-gimpcontext.html#gimp-context-set-palette"><code class="function">gimp_context_set_palette()</code></a>.</p>
109
111
<p>
110
112
 
111
113
</p>
113
115
<col align="left" valign="top">
114
116
<tbody>
115
117
<tr>
116
 
<td>
117
 
<span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
 
118
<td><span class="term"><em class="parameter"><code>filter</code></em>&#160;:</span></td>
118
119
<td> An optional regular expression used to filter the list.
119
120
</td>
120
121
</tr>
121
122
<tr>
122
 
<td>
123
 
<span class="term"><em class="parameter"><code>num_palettes</code></em>&#160;:</span></td>
 
123
<td><span class="term"><em class="parameter"><code>num_palettes</code></em>&#160;:</span></td>
124
124
<td> The number of palettes in the list.
125
125
</td>
126
126
</tr>
127
127
<tr>
128
 
<td>
129
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
128
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
130
129
<td> The list of palette names.
131
130
</td>
132
131
</tr>
135
134
</div>
136
135
<hr>
137
136
<div class="refsect2" lang="en">
138
 
<a name="id2638819"></a><h3>
 
137
<a name="id2671605"></a><h3>
139
138
<a name="gimp-palettes-get-palette"></a>gimp_palettes_get_palette ()</h3>
140
 
<a class="indexterm" name="id2638832"></a><pre class="programlisting">gchar*      gimp_palettes_get_palette       (gint *num_colors);</pre>
 
139
<a class="indexterm" name="id2671619"></a><pre class="programlisting">gchar*              gimp_palettes_get_palette           (gint *num_colors);</pre>
141
140
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
142
141
<h3 class="title">Warning</h3>
143
142
<p><code class="literal">gimp_palettes_get_palette</code> is deprecated and should not be used in newly-written code.</p>
152
151
<col align="left" valign="top">
153
152
<tbody>
154
153
<tr>
155
 
<td>
156
 
<span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
 
154
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
157
155
<td> The palette num_colors.
158
156
</td>
159
157
</tr>
160
158
<tr>
161
 
<td>
162
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
159
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
163
160
<td> The palette name.
164
161
</td>
165
162
</tr>
168
165
</div>
169
166
<hr>
170
167
<div class="refsect2" lang="en">
171
 
<a name="id2638911"></a><h3>
 
168
<a name="id2671699"></a><h3>
172
169
<a name="gimp-palettes-set-palette"></a>gimp_palettes_set_palette ()</h3>
173
 
<a class="indexterm" name="id2638925"></a><pre class="programlisting">gboolean    gimp_palettes_set_palette       (const gchar *name);</pre>
 
170
<a class="indexterm" name="id2693496"></a><pre class="programlisting">gboolean            gimp_palettes_set_palette           (const gchar *name);</pre>
174
171
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
175
172
<h3 class="title">Warning</h3>
176
173
<p><code class="literal">gimp_palettes_set_palette</code> is deprecated and should not be used in newly-written code.</p>
184
181
<col align="left" valign="top">
185
182
<tbody>
186
183
<tr>
187
 
<td>
188
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
184
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
189
185
<td> The palette name.
190
186
</td>
191
187
</tr>
192
188
<tr>
193
 
<td>
194
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
189
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
195
190
<td> TRUE on success.
196
191
</td>
197
192
</tr>
200
195
</div>
201
196
<hr>
202
197
<div class="refsect2" lang="en">
203
 
<a name="id2631458"></a><h3>
 
198
<a name="id2693577"></a><h3>
204
199
<a name="gimp-palettes-get-palette-entry"></a>gimp_palettes_get_palette_entry ()</h3>
205
 
<a class="indexterm" name="id2631472"></a><pre class="programlisting">gchar*      gimp_palettes_get_palette_entry (const gchar *name,
206
 
                                             gint entry_num,
207
 
                                             gint *num_colors,
208
 
                                             <a
 
200
<a class="indexterm" name="id2693590"></a><pre class="programlisting">gchar*              gimp_palettes_get_palette_entry     (const gchar *name,
 
201
                                                         gint entry_num,
 
202
                                                         gint *num_colors,
 
203
                                                         <a
209
204
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
210
205
>GimpRGB</a> *color);</pre>
211
206
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
222
217
<col align="left" valign="top">
223
218
<tbody>
224
219
<tr>
225
 
<td>
226
 
<span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
220
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
227
221
<td> The palette name (\"\" means currently active palette).
228
222
</td>
229
223
</tr>
230
224
<tr>
231
 
<td>
232
 
<span class="term"><em class="parameter"><code>entry_num</code></em>&#160;:</span></td>
 
225
<td><span class="term"><em class="parameter"><code>entry_num</code></em>&#160;:</span></td>
233
226
<td> The entry to retrieve.
234
227
</td>
235
228
</tr>
236
229
<tr>
237
 
<td>
238
 
<span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
 
230
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
239
231
<td> The palette num_colors.
240
232
</td>
241
233
</tr>
242
234
<tr>
243
 
<td>
244
 
<span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
 
235
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
245
236
<td> The color requested.
246
237
</td>
247
238
</tr>
248
239
<tr>
249
 
<td>
250
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
240
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
251
241
<td> The palette name.
252
242
</td>
253
243
</tr>