~ubuntu-branches/ubuntu/hoary/gimp/hoary

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimppalettes</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Library Reference Manual"><link rel="up" href="libgimp-data.html" title="Data Objects"><link rel="prev" href="libgimp-gimppalette.html" title="gimppalette"><link rel="next" href="libgimp-gimppattern.html" title="gimppattern"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
        .synopsis, .classsynopsis {
            background: #eeeeee;
            border: solid 1px #aaaaaa;
            padding: 0.5em;
        }
        .programlisting {
            background: #eeeeff;
            border: solid 1px #aaaaff;
            padding: 0.5em;
        }
        .variablelist {
            padding: 4px;
            margin-left: 3em;
        }
        .navigation {
            background: #ffeeee;
            border: solid 1px #ffaaaa;
            margin-top: 0.5em;
            margin-bottom: 0.5em;
        }
        .navigation a {
            color: #770000;
        }
        .navigation a:visited {
            color: #550000;
        }
        .navigation .title {
            font-size: 200%;
        }
      </style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimp-gimppalette.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimp-data.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">GIMP Library Reference Manual</th><td><a accesskey="n" href="libgimp-gimppattern.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimp-gimppalettes"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">gimppalettes</span></h2><p>gimppalettes &#8212; Operations related to palettes.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">



<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    <a href="libgimp-gimppalettes.html#gimp-palettes-refresh">gimp_palettes_refresh</a>           (void);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>**     <a href="libgimp-gimppalettes.html#gimp-palettes-get-list">gimp_palettes_get_list</a>          (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filter,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_palettes);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      <a href="libgimp-gimppalettes.html#gimp-palettes-get-palette">gimp_palettes_get_palette</a>       (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_colors);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    <a href="libgimp-gimppalettes.html#gimp-palettes-set-palette">gimp_palettes_set_palette</a>       (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      <a href="libgimp-gimppalettes.html#gimp-palettes-get-palette-entry">gimp_palettes_get_palette_entry</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> entry_num,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_colors,
                                             <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);
</pre></div><div class="refsect1" lang="en"><a name="id2644988"></a><h2>Description</h2><p>
Operations related to palettes.
</p></div><div class="refsect1" lang="en"><a name="id2644997"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2645003"></a><h3><a name="gimp-palettes-refresh"></a>gimp_palettes_refresh ()</h3><a class="indexterm" name="id2645011"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gimp_palettes_refresh           (void);</pre><p>
Refreshes current palettes. This function always succeeds.
</p><p>
This procedure retrieves all palettes currently in the user's
palette path and updates the palette dialogs accordingly.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2645048"></a><h3><a name="gimp-palettes-get-list"></a>gimp_palettes_get_list ()</h3><a class="indexterm" name="id2653140"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>**     gimp_palettes_get_list          (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *filter,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_palettes);</pre><p>
Retrieves a list of all of the available palettes
</p><p>
This procedure returns a complete listing of available palettes.
Each name returned can be used as input to the command
'gimp_context_set_palette'.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filter</tt></i> :</span></td><td> An optional regular expression used to filter the list.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_palettes</tt></i> :</span></td><td> The number of palettes in the list.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The list of palette names.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2653212"></a><h3><a name="gimp-palettes-get-palette"></a>gimp_palettes_get_palette ()</h3><a class="indexterm" name="id2653220"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      gimp_palettes_get_palette       (<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_colors);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_palettes_get_palette</tt> is deprecated and should not be used in newly-written code.</p></div><p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-palette"><tt class="function">gimp_context_get_palette()</tt></a>
instead.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>num_colors</tt></i> :</span></td><td> The palette num_colors.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The palette name.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2652274"></a><h3><a name="gimp-palettes-set-palette"></a>gimp_palettes_set_palette ()</h3><a class="indexterm" name="id2652282"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a>    gimp_palettes_set_palette       (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_palettes_set_palette</tt> is deprecated and should not be used in newly-written code.</p></div><p>
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-palette"><tt class="function">gimp_context_set_palette()</tt></a> instead.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The palette name.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2652342"></a><h3><a name="gimp-palettes-get-palette-entry"></a>gimp_palettes_get_palette_entry ()</h3><a class="indexterm" name="id2652351"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>*      gimp_palettes_get_palette_entry (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *name,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> entry_num,
                                             <a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *num_colors,
                                             <a
href="../libgimpcolor/libgimpcolor-GimpRGB.html#GimpRGB"
>GimpRGB</a> *color);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_palettes_get_palette_entry</tt> is deprecated and should not be used in newly-written code.</p></div><p>
This procedure is deprecated! Use <a href="libgimp-gimppalette.html#gimp-palette-entry-get-color"><tt class="function">gimp_palette_entry_get_color()</tt></a>
instead.</p><p>

</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The palette name (\"\" means currently active palette).
</td></tr><tr><td><span class="term"><i class="parameter"><tt>entry_num</tt></i> :</span></td><td> The entry to retrieve.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_colors</tt></i> :</span></td><td> The palette num_colors.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>color</tt></i> :</span></td><td> The color requested.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The palette name.
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimppalette.html"><b>&lt;&lt; gimppalette</b></a></td><td align="right"><a accesskey="n" href="libgimp-gimppattern.html"><b>gimppattern &gt;&gt;</b></a></td></tr></table></body></html>