Files
gimp/devel-docs/libgimp/html/GimpPaletteSelectButton.html
2010-08-11 01:21:39 -04:00

299 lines
12 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>GimpPaletteSelectButton</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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="GimpGradientSelectButton.html" title="GimpGradientSelectButton">
<link rel="next" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton">
<meta name="generator" content="GTK-Doc V1.8 (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="GimpGradientSelectButton.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="GimpPatternSelectButton.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="#id2583223" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2701867" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2622310" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2703151" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2703171" class="shortcut">Properties</a>
&#160;|&#160;
<a href="#id2703212" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpPaletteSelectButton"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2583223"></a><span class="refentrytitle">GimpPaletteSelectButton</span>
</h2>
<p>GimpPaletteSelectButton</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GimpPaletteSelectButton.html#GimpPaletteSelectButton-struct">GimpPaletteSelectButton</a>;
GtkWidget* <a href="GimpPaletteSelectButton.html#gimp-palette-select-button-new">gimp_palette_select_button_new</a> (const gchar *title,
const gchar *palette_name);
const gchar* <a href="GimpPaletteSelectButton.html#gimp-palette-select-button-get-palette">gimp_palette_select_button_get_palette</a>
(<a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">GimpPaletteSelectButton</a> *button);
void <a href="GimpPaletteSelectButton.html#gimp-palette-select-button-set-palette">gimp_palette_select_button_set_palette</a>
(<a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">GimpPaletteSelectButton</a> *button,
const gchar *palette_name);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2622310"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkHBox
+----<a href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
+----GimpPaletteSelectButton
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2703151"></a><h2>Implemented Interfaces</h2>
<p>
GimpPaletteSelectButton implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2703171"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpPaletteSelectButton.html#GimpPaletteSelectButton--palette-name">palette-name</a>" gchararray : Read / Write
"<a href="GimpPaletteSelectButton.html#GimpPaletteSelectButton--title">title</a>" gchararray : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2703212"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpPaletteSelectButton.html#GimpPaletteSelectButton-palette-set">palette-set</a>" : Run First
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2701867"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2701883"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2701894"></a><h3>
<a name="GimpPaletteSelectButton-struct"></a>GimpPaletteSelectButton</h3>
<a class="indexterm" name="id2701905"></a><pre class="programlisting">typedef struct _GimpPaletteSelectButton GimpPaletteSelectButton;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2701921"></a><h3>
<a name="gimp-palette-select-button-new"></a>gimp_palette_select_button_new ()</h3>
<a class="indexterm" name="id2701934"></a><pre class="programlisting">GtkWidget* gimp_palette_select_button_new (const gchar *title,
const gchar *palette_name);</pre>
<p>
Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
a palette. This widget is suitable for placement in a table in a
plug-in dialog.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>title</code></em>&#160;:</span></td>
<td> Title of the dialog to use or <code class="literal">NULL</code> to use the default title.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>palette_name</code></em>&#160;:</span></td>
<td> Initial palette name.
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GtkWidget</span> that you can use in your UI.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2705213"></a><h3>
<a name="gimp-palette-select-button-get-palette"></a>gimp_palette_select_button_get_palette ()</h3>
<a class="indexterm" name="id2705226"></a><pre class="programlisting">const gchar* gimp_palette_select_button_get_palette
(<a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">GimpPaletteSelectButton</a> *button);</pre>
<p>
Retrieves the name of currently selected palette.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></td>
<td> A <a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton"><span class="type">GimpPaletteSelectButton</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> an internal copy of the palette name which must not be freed.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2705302"></a><h3>
<a name="gimp-palette-select-button-set-palette"></a>gimp_palette_select_button_set_palette ()</h3>
<a class="indexterm" name="id2705318"></a><pre class="programlisting">void gimp_palette_select_button_set_palette
(<a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">GimpPaletteSelectButton</a> *button,
const gchar *palette_name);</pre>
<p>
Sets the current palette for the palette select button.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></td>
<td> A <a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton"><span class="type">GimpPaletteSelectButton</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>palette_name</code></em>&#160;:</span></td>
<td> Palette name to set; <code class="literal">NULL</code> means no change.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2705413"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2705423"></a><h3>
<a name="GimpPaletteSelectButton--palette-name"></a>The "<code class="literal">palette-name</code>" property</h3>
<a class="indexterm" name="id2705439"></a><pre class="programlisting"> "palette-name" gchararray : Read / Write</pre>
<p>
The name of the currently selected palette.</p>
<p>
</p>
<p>Default value: NULL</p>
<p>Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2700852"></a><h3>
<a name="GimpPaletteSelectButton--title"></a>The "<code class="literal">title</code>" property</h3>
<a class="indexterm" name="id2700866"></a><pre class="programlisting"> "title" gchararray : Read / Write / Construct Only</pre>
<p>
The title to be used for the palette selection popup dialog.</p>
<p>
</p>
<p>Default value: "Palette Selection"</p>
<p>Since GIMP 2.4
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2700903"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2700913"></a><h3>
<a name="GimpPaletteSelectButton-palette-set"></a>The "palette-set" signal</h3>
<a class="indexterm" name="id2700920"></a><pre class="programlisting">void user_function (<a href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">GimpPaletteSelectButton</a> *widget,
gchar *palette_name,
gboolean dialog_closing,
gpointer user_data) : Run First</pre>
<p>
The ::palette-set signal is emitted when the user selects a palette.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>widget</code></em>&#160;:</span></td>
<td> the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>palette_name</code></em>&#160;:</span></td>
<td> the name of the currently selected palette.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>dialog_closing</code></em>&#160;:</span></td>
<td> whether the dialog was closed or not.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.4
</p>
</div>
</div>
</div>
</body>
</html>