Files
gimp/devel-docs/libgimp/html/libgimp-gimppaletteselect.html
2010-08-11 01:23:49 -04:00

356 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>gimppaletteselect</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="prev" href="libgimp-gimpgradientselect.html" title="gimpgradientselect">
<link rel="next" href="libgimp-gimppatternselect.html" title="gimppatternselect">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part&#160;I.&#160;GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part&#160;II.&#160;GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimpgradientselect.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-selectors.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-gimppatternselect.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2679768" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2725670" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimppaletteselect"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2679768"></a><span class="refentrytitle">gimppaletteselect</span>
</h2>
<p>gimppaletteselect &#8212; Functions providing a palette selection dialog.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
void (<a class="link" href="libgimp-gimppaletteselect.html#GimpRunPaletteCallback">*GimpRunPaletteCallback</a>) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> dialog_closing,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a class="link" href="libgimp-gimppaletteselect.html#gimp-palette-select-new">gimp_palette_select_new</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_name,
<a class="link" href="libgimp-gimppaletteselect.html#GimpRunPaletteCallback">GimpRunPaletteCallback</a> callback,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
void <a class="link" href="libgimp-gimppaletteselect.html#gimp-palette-select-destroy">gimp_palette_select_destroy</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaletteselect.html#gimp-palettes-popup">gimp_palettes_popup</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *popup_title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *initial_palette);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaletteselect.html#gimp-palettes-close-popup">gimp_palettes_close_popup</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback);
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a class="link" href="libgimp-gimppaletteselect.html#gimp-palettes-set-popup">gimp_palettes_set_popup</a> (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2725670"></a><h2>Description</h2>
<p>
Functions providing a palette selection dialog.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2725687"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2725697"></a><h3>
<a name="GimpRunPaletteCallback"></a>GimpRunPaletteCallback ()</h3>
<a class="indexterm" name="id2725708"></a><pre class="programlisting">void (*GimpRunPaletteCallback) (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_name,
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> dialog_closing,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> user_data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_name</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dialog_closing</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2725972"></a><h3>
<a name="gimp-palette-select-new"></a>gimp_palette_select_new ()</h3>
<a class="indexterm" name="id2725984"></a><pre class="programlisting">const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a>* gimp_palette_select_new (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_name,
<a class="link" href="libgimp-gimppaletteselect.html#GimpRunPaletteCallback">GimpRunPaletteCallback</a> callback,
<a
href="../glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>title</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_name</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em>&#160;:</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2726104"></a><h3>
<a name="gimp-palette-select-destroy"></a>gimp_palette_select_destroy ()</h3>
<a class="indexterm" name="id2728554"></a><pre class="programlisting">void gimp_palette_select_destroy (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>palette_callback</code></em>&#160;:</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2728599"></a><h3>
<a name="gimp-palettes-popup"></a>gimp_palettes_popup ()</h3>
<a class="indexterm" name="id2728610"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_palettes_popup (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *popup_title,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *initial_palette);</pre>
<p>
Invokes the Gimp palette selection.
</p>
<p>
This procedure opens the palette selection dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_callback</code></em>&#160;:</span></p></td>
<td> The callback PDB proc to call when palette selection is made.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>popup_title</code></em>&#160;:</span></p></td>
<td> Title of the palette selection dialog.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>initial_palette</code></em>&#160;:</span></p></td>
<td> The name of the palette to set as the first selected.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2728718"></a><h3>
<a name="gimp-palettes-close-popup"></a>gimp_palettes_close_popup ()</h3>
<a class="indexterm" name="id2728729"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_palettes_close_popup (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback);</pre>
<p>
Close the palette selection dialog.
</p>
<p>
This procedure closes an opened palette selection dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_callback</code></em>&#160;:</span></p></td>
<td> The name of the callback registered for this pop-up.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2728793"></a><h3>
<a name="gimp-palettes-set-popup"></a>gimp_palettes_set_popup ()</h3>
<a class="indexterm" name="id2728804"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> gimp_palettes_set_popup (const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_callback,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *palette_name);</pre>
<p>
Sets the current palette in a palette selection dialog.
</p>
<p>
Sets the current palette in a palette selection dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_callback</code></em>&#160;:</span></p></td>
<td> The name of the callback registered for this pop-up.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>palette_name</code></em>&#160;:</span></p></td>
<td> The name of the palette to set as selected.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> TRUE on success.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2723642"></a><div class="refsect2" lang="en"><a name="id2723643"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2723644"></a></div>
</div>
</div>
</body>
</html>