Imported Upstream version 2.8.16

This commit is contained in:
Ari Pollak
2015-11-24 14:17:30 -05:00
parent bf2f572083
commit 66d1b776a9
842 changed files with 251623 additions and 240362 deletions

View File

@ -2,13 +2,13 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GIMP Library Reference Manual: GimpPatternSelectButton</title>
<title>GimpPatternSelectButton: GIMP Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" 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="GimpPaletteSelectButton.html" title="GimpPaletteSelect">
<link rel="prev" href="GimpPaletteSelectButton.html" title="GimpPaletteSelectButton">
<link rel="next" href="libgimp-gimpbrushselect.html" title="gimpbrushselect">
<meta name="generator" content="GTK-Doc V1.21 (XML mode)">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@ -31,7 +31,7 @@
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GimpPatternSelectButton.top_of_page"></a>GimpPatternSelectButton</span></h2>
<p>GimpPatternSelectButton — A button which pops up a pattern select dialog.</p>
<p>GimpPatternSelectButton</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
@ -45,14 +45,14 @@
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">GtkWidget</span> *
<a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-new" title="gimp_pattern_select_button_new ()">gimp_pattern_select_button_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
<td class="function_type">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GimpPatternSelectButton.html#gimp-pattern-select-button-get-pattern" title="gimp_pattern_select_button_get_pattern ()">gimp_pattern_select_button_get_pattern</a> <span class="c_punctuation">()</span>
@ -80,13 +80,13 @@
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--pattern-name" title="The “pattern-name” property">pattern-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton--title" title="The “title” property">title</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
@ -104,7 +104,7 @@
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GimpPatternSelectButton.html#GimpPatternSelectButton-pattern-set" title="The “pattern-set” signal">pattern-set</a></td>
<td class="signal_flags">Run First</td>
<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
@ -123,12 +123,12 @@
</div>
<div class="refsect1">
<a name="GimpPatternSelectButton.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> GtkObject
<span class="lineart">╰──</span> GtkWidget
<span class="lineart">╰──</span> GtkContainer
<span class="lineart">╰──</span> GtkBox
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gtk3/GtkObject.html">GtkObject</a>
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gtk3/GtkWidget.html">GtkWidget</a>
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gtk3/GtkContainer.html">GtkContainer</a>
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gtk3/GtkBox.html">GtkBox</a>
<span class="lineart">╰──</span> <a class="link" href="GimpSelectButton.html" title="GimpSelectButton">GimpSelectButton</a>
<span class="lineart">╰──</span> GimpPatternSelectButton
</pre>
@ -137,79 +137,27 @@
<a name="GimpPatternSelectButton.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GimpPatternSelectButton implements
AtkImplementorIface, GtkBuildable and GtkOrientable.</p>
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk3/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk3/gtk2-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GimpPatternSelectButton.description"></a><h2>Description</h2>
<p>A button which pops up a pattern select dialog.</p>
</div>
<div class="refsect1">
<a name="GimpPatternSelectButton.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gimp-pattern-select-button-new"></a><h3>gimp_pattern_select_button_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> *
gimp_pattern_select_button_new (<em class="parameter"><code>const <span class="type">gchar</span> *title</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>);</pre>
<p>Creates a new <span class="type">GtkWidget</span> that completely controls the selection of
a pattern. This widget is suitable for placement in a table in a
plug-in dialog.</p>
<div class="refsect3">
<a name="id-1.2.6.7.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>title</p></td>
<td class="parameter_description"><p>Title of the dialog to use or <code class="literal">NULL</code> to use the default title.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern_name</p></td>
<td class="parameter_description"><p>Initial pattern name or <code class="literal">NULL</code> to use current selection.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.7.10.2.6"></a><h4>Returns</h4>
<p> A <span class="type">GtkWidget</span> that you can use in your UI.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> *
gimp_pattern_select_button_new (<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *title</code></em>,
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="gimp-pattern-select-button-get-pattern"></a><h3>gimp_pattern_select_button_get_pattern ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
<pre class="programlisting">const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gimp_pattern_select_button_get_pattern
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>);</pre>
<p>Retrieves the name of currently selected pattern.</p>
<div class="refsect3">
<a name="id-1.2.6.7.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.6.7.10.3.6"></a><h4>Returns</h4>
<p> an internal copy of the pattern name which must not be freed.</p>
<p></p>
</div>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
@ -217,31 +165,8 @@ gimp_pattern_select_button_get_pattern
<pre class="programlisting"><span class="returnvalue">void</span>
gimp_pattern_select_button_set_pattern
(<em class="parameter"><code><a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *button</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *pattern_name</code></em>);</pre>
<p>Sets the current pattern for the pattern select button.</p>
<div class="refsect3">
<a name="id-1.2.6.7.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>button</p></td>
<td class="parameter_description"><p>A <a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern_name</p></td>
<td class="parameter_description"><p>Pattern name to set; <code class="literal">NULL</code> means no change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since GIMP 2.4</p>
<em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name</code></em>);</pre>
<p class="since">Since: GIMP 2.4</p>
</div>
</div>
<div class="refsect1">
@ -249,28 +174,26 @@ gimp_pattern_select_button_set_pattern
<div class="refsect2">
<a name="GimpPatternSelectButton-struct"></a><h3>GimpPatternSelectButton</h3>
<pre class="programlisting">typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="GimpPatternSelectButton.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GimpPatternSelectButton--pattern-name"></a><h3>The <code class="literal">“pattern-name”</code> property</h3>
<pre class="programlisting"> “pattern-name” <span class="type">gchar</span> *</pre>
<pre class="programlisting"> “pattern-name” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The name of the currently selected pattern.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
<hr>
<div class="refsect2">
<a name="GimpPatternSelectButton--title"></a><h3>The <code class="literal">“title”</code> property</h3>
<pre class="programlisting"> “title” <span class="type">gchar</span> *</pre>
<pre class="programlisting"> “title” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The title to be used for the pattern selection popup dialog.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: "Pattern Selection"</p>
<p class="since">Since GIMP 2.4</p>
<p class="since">Since: GIMP 2.4</p>
</div>
</div>
<div class="refsect1">
@ -279,73 +202,19 @@ gimp_pattern_select_button_set_pattern
<a name="GimpPatternSelectButton-pattern-set"></a><h3>The <code class="literal">“pattern-set”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GimpPatternSelectButton.html" title="GimpPatternSelectButton"><span class="type">GimpPatternSelectButton</span></a> *widget,
<span class="type">gchar</span> *pattern_name,
<span class="type">gint</span> width,
<span class="type">gint</span> height,
<span class="type">gint</span> bpp,
<span class="type">gpointer</span> mask_data,
<span class="type">gboolean</span> dialog_closing,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::pattern-set signal is emitted when the user selects a pattern.</p>
<div class="refsect3">
<a name="id-1.2.6.7.13.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>widget</p></td>
<td class="parameter_description"><p>the object which received the signal.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern_name</p></td>
<td class="parameter_description"><p>the name of the currently selected pattern.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>width</p></td>
<td class="parameter_description"><p>width of the pattern</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>height</p></td>
<td class="parameter_description"><p>height of the pattern</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>bpp</p></td>
<td class="parameter_description"><p>bpp of the pattern</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mask_data</p></td>
<td class="parameter_description"><p>pattern mask data</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dialog_closing</p></td>
<td class="parameter_description"><p>whether the dialog was closed or not.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run First</p>
<p class="since">Since GIMP 2.4</p>
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *pattern_name,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> bpp,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> mask_data,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> dialog_closing,
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
<p class="since">Since: GIMP 2.4</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>