Files
gimp/devel-docs/libgimp/html/libgimp-gimppatternmenu.html
2010-08-11 01:27:19 -04:00

212 lines
10 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimppatternmenu</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="prev" href="libgimp-gimppalettemenu.html" title="gimppalettemenu">
<link rel="next" href="GimpProcBrowserDialog.html" title="GimpProcBrowserDialog">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part I. 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 II. 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-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<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-gimppalettemenu.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpui.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="GimpProcBrowserDialog.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgimp-gimppatternmenu.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimp-gimppatternmenu.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="gimppatternmenu">
<a name="libgimp-gimppatternmenu"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimppatternmenu.top_of_page"></a>gimppatternmenu</span></h2>
<p>gimppatternmenu — A widget for selecting patterns.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libgimp-gimppatternmenu.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> * <a class="link" href="libgimp-gimppatternmenu.html#gimp-pattern-select-widget-new" title="gimp_pattern_select_widget_new ()">gimp_pattern_select_widget_new</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *pattern_name,
<a class="link" href="libgimp-gimppatternselect.html#GimpRunPatternCallback" title="GimpRunPatternCallback ()">GimpRunPatternCallback</a> callback,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
void <a class="link" href="libgimp-gimppatternmenu.html#gimp-pattern-select-widget-close" title="gimp_pattern_select_widget_close ()">gimp_pattern_select_widget_close</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget);
void <a class="link" href="libgimp-gimppatternmenu.html#gimp-pattern-select-widget-set" title="gimp_pattern_select_widget_set ()">gimp_pattern_select_widget_set</a> (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *pattern_name);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libgimp-gimppatternmenu.description"></a><h2>Description</h2>
<p>
A widget for selecting patterns.
</p>
</div>
<div class="refsect1" title="Details">
<a name="libgimp-gimppatternmenu.details"></a><h2>Details</h2>
<div class="refsect2" title="gimp_pattern_select_widget_new ()">
<a name="gimp-pattern-select-widget-new"></a><h3>gimp_pattern_select_widget_new ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> * gimp_pattern_select_widget_new (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *title,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *pattern_name,
<a class="link" href="libgimp-gimppatternselect.html#GimpRunPatternCallback" title="GimpRunPatternCallback ()">GimpRunPatternCallback</a> callback,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_pattern_select_widget_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates a new <a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
><span class="type">GtkWidget</span></a> that completely controls the selection of
a pattern. 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><p><span class="term"><em class="parameter"><code>title</code></em> :</span></p></td>
<td> Title of the dialog to use or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> to use the default title.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
<td> Initial pattern name or <a
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> to use current selection.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td> A function to call when the selected pattern changes.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td> A pointer to arbitary data to be used in the call to <em class="parameter"><code>callback</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
><span class="type">GtkWidget</span></a> that you can use in your UI.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_pattern_select_widget_close ()">
<a name="gimp-pattern-select-widget-close"></a><h3>gimp_pattern_select_widget_close ()</h3>
<pre class="programlisting">void gimp_pattern_select_widget_close (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_pattern_select_widget_close</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Closes the popup window associated with <em class="parameter"><code>widget</code></em>.</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>widget</code></em> :</span></p></td>
<td> A pattern select widget.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="gimp_pattern_select_widget_set ()">
<a name="gimp-pattern-select-widget-set"></a><h3>gimp_pattern_select_widget_set ()</h3>
<pre class="programlisting">void gimp_pattern_select_widget_set (<a
href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"
>GtkWidget</a> *widget,
const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *pattern_name);</pre>
<div class="warning" title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gimp_pattern_select_widget_set</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets the current pattern for the pattern select widget. Calls the
callback function if one was supplied in the call to
<a class="link" href="libgimp-gimppatternmenu.html#gimp-pattern-select-widget-new" title="gimp_pattern_select_widget_new ()"><code class="function">gimp_pattern_select_widget_new()</code></a>.</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>widget</code></em> :</span></p></td>
<td> A pattern select widget.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pattern_name</code></em> :</span></p></td>
<td> Pattern name to set. NULL means no change.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>