228 lines
12 KiB
XML
228 lines
12 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="GimpPatternSelectButton">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">GimpPatternSelectButton</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpPatternSelectButton</refname>
|
|
<refpurpose></refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GimpPatternSelectButton-struct">GimpPatternSelectButton</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-pattern-select-button-new">gimp_pattern_select_button_new</link> (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *pattern_name);
|
|
const <link linkend="gchar">gchar</link>* <link linkend="gimp-pattern-select-button-get-pattern">gimp_pattern_select_button_get_pattern</link>
|
|
(<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button);
|
|
<link linkend="void">void</link> <link linkend="gimp-pattern-select-button-set-pattern">gimp_pattern_select_button_set_pattern</link>
|
|
(<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button,
|
|
const <link linkend="gchar">gchar</link> *pattern_name);
|
|
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 role="object_hierarchy">
|
|
<title role="object_hierarchy.title">Object Hierarchy</title>
|
|
<synopsis>
|
|
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
|
|
+----<link linkend="GtkObject">GtkObject</link>
|
|
+----<link linkend="GtkWidget">GtkWidget</link>
|
|
+----<link linkend="GtkContainer">GtkContainer</link>
|
|
+----<link linkend="GtkBox">GtkBox</link>
|
|
+----<link linkend="GtkHBox">GtkHBox</link>
|
|
+----<link linkend="GimpSelectButton">GimpSelectButton</link>
|
|
+----GimpPatternSelectButton
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 role="impl_interfaces">
|
|
<title role="impl_interfaces.title">Implemented Interfaces</title>
|
|
<para>
|
|
GimpPatternSelectButton implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="properties">
|
|
<title role="properties.title">Properties</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GimpPatternSelectButton--pattern-name">pattern-name</link>" <link linkend="gchararray">gchararray</link> : Read / Write
|
|
"<link linkend="GimpPatternSelectButton--title">title</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
<refsect1 role="signal_proto">
|
|
<title role="signal_proto.title">Signals</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GimpPatternSelectButton-pattern-set">pattern-set</link>" : Run First
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpPatternSelectButton-struct" role="struct"/>GimpPatternSelectButton</title>
|
|
<indexterm><primary>GimpPatternSelectButton</primary></indexterm><programlisting>typedef struct _GimpPatternSelectButton GimpPatternSelectButton;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-pattern-select-button-new" role="function" condition="since:GIMP 2.4"/>gimp_pattern_select_button_new ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_pattern_select_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_pattern_select_button_new (const <link linkend="gchar">gchar</link> *title,
|
|
const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GtkWidget"><type>GtkWidget</type></link> that completely controls the selection of
|
|
a pattern. This widget is suitable for placement in a table in a
|
|
plug-in dialog.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>title</parameter> :</term>
|
|
<listitem><simpara> Title of the dialog to use or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use the default title.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pattern_name</parameter> :</term>
|
|
<listitem><simpara> Initial pattern name or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to use current selection.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkWidget"><type>GtkWidget</type></link> that you can use in your UI.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-pattern-select-button-get-pattern" role="function" condition="since:GIMP 2.4"/>gimp_pattern_select_button_get_pattern ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_pattern_select_button_get_pattern</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_pattern_select_button_get_pattern
|
|
(<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button);</programlisting>
|
|
<para>
|
|
Retrieves the name of currently selected pattern.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>button</parameter> :</term>
|
|
<listitem><simpara> A <link linkend="GimpPatternSelectButton"><type>GimpPatternSelectButton</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an internal copy of the pattern name which must not be freed.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-pattern-select-button-set-pattern" role="function" condition="since:GIMP 2.4"/>gimp_pattern_select_button_set_pattern ()</title>
|
|
<indexterm role="GIMP 2.4"><primary>gimp_pattern_select_button_set_pattern</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pattern_select_button_set_pattern
|
|
(<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *button,
|
|
const <link linkend="gchar">gchar</link> *pattern_name);</programlisting>
|
|
<para>
|
|
Sets the current pattern for the pattern select button.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>button</parameter> :</term>
|
|
<listitem><simpara> A <link linkend="GimpPatternSelectButton"><type>GimpPatternSelectButton</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pattern_name</parameter> :</term>
|
|
<listitem><simpara> Pattern name to set; <link linkend="NULL:CAPS"><literal>NULL</literal></link> means no change.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1 role="property_details">
|
|
<title role="property_details.title">Property Details</title>
|
|
<refsect2><title><anchor id="GimpPatternSelectButton--pattern-name"/>The "<literal>pattern-name</literal>" property</title>
|
|
<indexterm role="GIMP 2.4"><primary>GimpPatternSelectButton:pattern-name</primary></indexterm><programlisting> "pattern-name" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
|
|
<para>
|
|
The name of the currently selected pattern.</para>
|
|
<para>
|
|
|
|
</para><para>Default value: NULL</para>
|
|
<para>Since GIMP 2.4
|
|
</para>
|
|
</refsect2>
|
|
<refsect2><title><anchor id="GimpPatternSelectButton--title"/>The "<literal>title</literal>" property</title>
|
|
<indexterm role="GIMP 2.4"><primary>GimpPatternSelectButton:title</primary></indexterm><programlisting> "title" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
|
|
<para>
|
|
The title to be used for the pattern selection popup dialog.</para>
|
|
<para>
|
|
|
|
</para><para>Default value: "Pattern Selection"</para>
|
|
<para>Since GIMP 2.4
|
|
</para>
|
|
</refsect2>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="signals">
|
|
<title role="signals.title">Signal Details</title>
|
|
<refsect2><title><anchor id="GimpPatternSelectButton-pattern-set"/>The "pattern-set" signal</title>
|
|
<indexterm role="GIMP 2.4"><primary>GimpPatternSelectButton::pattern-set</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPatternSelectButton">GimpPatternSelectButton</link> *widget,
|
|
<link linkend="gchar">gchar</link> *pattern_name,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
<link linkend="gint">gint</link> bpp,
|
|
<link linkend="gpointer">gpointer</link> mask_data,
|
|
<link linkend="gboolean">gboolean</link> dialog_closing,
|
|
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
|
|
<para>
|
|
The ::pattern-set signal is emitted when the user selects a pattern.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>widget</parameter> :</term>
|
|
<listitem><simpara> the object which received the signal.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>pattern_name</parameter> :</term>
|
|
<listitem><simpara> the name of the currently selected pattern.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>width</parameter> :</term>
|
|
<listitem><simpara> width of the pattern
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>height</parameter> :</term>
|
|
<listitem><simpara> height of the pattern
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>bpp</parameter> :</term>
|
|
<listitem><simpara> bpp of the pattern
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_data</parameter> :</term>
|
|
<listitem><simpara> pattern mask data
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dialog_closing</parameter> :</term>
|
|
<listitem><simpara> whether the dialog was closed or not.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>user_data</parameter> :</term>
|
|
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
|
</variablelist><para>Since GIMP 2.4
|
|
</para></refsect2>
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|