Imported Upstream version 2.2.4
This commit is contained in:
Ari Pollak
140
devel-docs/libgimpwidgets/xml/gimpbutton.xml
Normal file
140
devel-docs/libgimpwidgets/xml/gimpbutton.xml
Normal file
@ -0,0 +1,140 @@
|
||||
<?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="GimpButton">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpButton</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpButton</refname><refpurpose>A <link linkend="GtkButton"><type>GtkButton</type></link> with a little extra functionality.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpButton-struct">GimpButton</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-button-new">gimp_button_new</link> (void);
|
||||
<link linkend="void">void</link> <link linkend="gimp-button-extended-clicked">gimp_button_extended_clicked</link> (<link linkend="GimpButton">GimpButton</link> *button,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> state);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkButton">GtkButton</link>
|
||||
+----GimpButton
|
||||
+----<link linkend="GimpColorButton">GimpColorButton</link>
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpButton implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpButton-extended-clicked">extended-clicked</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpButton">GimpButton</link> *gimpbutton,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
<link linkend="GimpButton"><type>GimpButton</type></link> adds an extra signal to the <link linkend="GtkButton"><type>GtkButton</type></link> widget that allows
|
||||
to distinguish a normal click from a click that was performed with
|
||||
modifier keys pressed.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpButton-struct"/>struct GimpButton</title>
|
||||
<indexterm><primary>GimpButton</primary></indexterm><programlisting>struct GimpButton;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-button-new"/>gimp_button_new ()</title>
|
||||
<indexterm><primary>gimp_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_button_new (void);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpButton"><type>GimpButton</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpButton"><type>GimpButton</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-button-extended-clicked"/>gimp_button_extended_clicked ()</title>
|
||||
<indexterm><primary>gimp_button_extended_clicked</primary></indexterm><programlisting><link linkend="void">void</link> gimp_button_extended_clicked (<link linkend="GimpButton">GimpButton</link> *button,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> state);</programlisting>
|
||||
<para>
|
||||
Emits the button's "extended_clicked" signal.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpButton"><type>GimpButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>state</parameter> :</term>
|
||||
<listitem><simpara> a state as found in <link linkend="GdkEventButton-"><type>GdkEventButton-</type></link>>state, e.g. <link linkend="GDK-SHIFT-MASK-CAPS"><type>GDK_SHIFT_MASK</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpButton-extended-clicked"/>The "extended-clicked" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpButton">GimpButton</link> *gimpbutton,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpbutton</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>the state of modifier keys when the button was clicked
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
110
devel-docs/libgimpwidgets/xml/gimpcellrenderercolor.xml
Normal file
110
devel-docs/libgimpwidgets/xml/gimpcellrenderercolor.xml
Normal file
@ -0,0 +1,110 @@
|
||||
<?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="GimpCellRendererColor">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpCellRendererColor</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpCellRendererColor</refname><refpurpose></refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpCellRendererColor-struct">GimpCellRendererColor</link>;
|
||||
<link linkend="GtkCellRenderer">GtkCellRenderer</link>* <link linkend="gimp-cell-renderer-color-new">gimp_cell_renderer_color_new</link>
|
||||
(void);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkCellRenderer">GtkCellRenderer</link>
|
||||
+----GimpCellRendererColor
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpCellRendererColor--color">color</link>" <link linkend="GimpRGB">GimpRGB</link> : Read / Write
|
||||
"<link linkend="GimpCellRendererColor--icon-size">icon-size</link>" <link linkend="gint">gint</link> : Read / Write / Construct
|
||||
"<link linkend="GimpCellRendererColor--opaque">opaque</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpCellRendererColor-struct"/>struct GimpCellRendererColor</title>
|
||||
<indexterm><primary>GimpCellRendererColor</primary></indexterm><programlisting>struct GimpCellRendererColor;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-cell-renderer-color-new"/>gimp_cell_renderer_color_new ()</title>
|
||||
<indexterm><primary>gimp_cell_renderer_color_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link>* gimp_cell_renderer_color_new
|
||||
(void);</programlisting>
|
||||
<para>
|
||||
Creates a <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> that displays a color.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpCellRendererColor"><type>GimpCellRendererColor</type></link>
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpCellRendererColor--color"/>"<literal>color</literal>" (<link linkend="GimpRGB">GimpRGB</link> : Read / Write)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpCellRendererColor--icon-size"/>"<literal>icon-size</literal>" (<link linkend="gint">gint</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpCellRendererColor--opaque"/>"<literal>opaque</literal>" (<link linkend="gboolean">gboolean</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
173
devel-docs/libgimpwidgets/xml/gimpcellrenderertoggle.xml
Normal file
173
devel-docs/libgimpwidgets/xml/gimpcellrenderertoggle.xml
Normal file
@ -0,0 +1,173 @@
|
||||
<?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="GimpCellRendererToggle">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpCellRendererToggle</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpCellRendererToggle</refname><refpurpose></refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpCellRendererToggle-struct">GimpCellRendererToggle</link>;
|
||||
<link linkend="GtkCellRenderer">GtkCellRenderer</link>* <link linkend="gimp-cell-renderer-toggle-new">gimp_cell_renderer_toggle_new</link>
|
||||
(const <link linkend="gchar">gchar</link> *stock_id);
|
||||
<link linkend="void">void</link> <link linkend="gimp-cell-renderer-toggle-clicked">gimp_cell_renderer_toggle_clicked</link>
|
||||
(<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *cell,
|
||||
const <link linkend="gchar">gchar</link> *path,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> state);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkCellRenderer">GtkCellRenderer</link>
|
||||
+----<link linkend="GtkCellRendererToggle">GtkCellRendererToggle</link>
|
||||
+----GimpCellRendererToggle
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpCellRendererToggle--stock-id">stock-id</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
|
||||
"<link linkend="GimpCellRendererToggle--stock-size">stock-size</link>" <link linkend="gint">gint</link> : Read / Write / Construct
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpCellRendererToggle-clicked">clicked</link>" <link linkend="void">void</link> user_function (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *gimpcellrenderertoggle,
|
||||
<link linkend="gchar">gchar</link> *arg1,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpCellRendererToggle-struct"/>struct GimpCellRendererToggle</title>
|
||||
<indexterm><primary>GimpCellRendererToggle</primary></indexterm><programlisting>struct GimpCellRendererToggle;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-cell-renderer-toggle-new"/>gimp_cell_renderer_toggle_new ()</title>
|
||||
<indexterm><primary>gimp_cell_renderer_toggle_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link>* gimp_cell_renderer_toggle_new
|
||||
(const <link linkend="gchar">gchar</link> *stock_id);</programlisting>
|
||||
<para>
|
||||
Creates a custom version of the <link linkend="GtkCellRendererToggle"><type>GtkCellRendererToggle</type></link>. Instead of
|
||||
showing the standard toggle button, it shows a stock icon if the
|
||||
cell is active and no icon otherwise. This cell renderer is for
|
||||
example used in the Layers treeview to indicate and control the
|
||||
layer's visibility by showing <literal>GIMP_STOCK_VISIBLE</literal>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stock_id</parameter> :</term>
|
||||
<listitem><simpara> the stock_id of the icon to use for the active state
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-cell-renderer-toggle-clicked"/>gimp_cell_renderer_toggle_clicked ()</title>
|
||||
<indexterm><primary>gimp_cell_renderer_toggle_clicked</primary></indexterm><programlisting><link linkend="void">void</link> gimp_cell_renderer_toggle_clicked
|
||||
(<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *cell,
|
||||
const <link linkend="gchar">gchar</link> *path,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> state);</programlisting>
|
||||
<para>
|
||||
Emits the "clicked" signal from a <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>cell</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpCellRendererToggle"><type>GimpCellRendererToggle</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>state</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpCellRendererToggle--stock-id"/>"<literal>stock-id</literal>" (<link linkend="gchararray">gchararray</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpCellRendererToggle--stock-size"/>"<literal>stock-size</literal>" (<link linkend="gint">gint</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpCellRendererToggle-clicked"/>The "clicked" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpCellRendererToggle">GimpCellRendererToggle</link> *gimpcellrenderertoggle,
|
||||
<link linkend="gchar">gchar</link> *arg1,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcellrenderertoggle</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg2</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
192
devel-docs/libgimpwidgets/xml/gimpchainbutton.xml
Normal file
192
devel-docs/libgimpwidgets/xml/gimpchainbutton.xml
Normal file
@ -0,0 +1,192 @@
|
||||
<?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="GimpChainButton">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpChainButton</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpChainButton</refname><refpurpose>Widget to visually connect two entry widgets.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpChainButton-struct">GimpChainButton</link>;
|
||||
enum <link linkend="GimpChainPosition">GimpChainPosition</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-chain-button-new">gimp_chain_button_new</link> (<link linkend="GimpChainPosition">GimpChainPosition</link> position);
|
||||
<link linkend="void">void</link> <link linkend="gimp-chain-button-set-active">gimp_chain_button_set_active</link> (<link linkend="GimpChainButton">GimpChainButton</link> *button,
|
||||
<link linkend="gboolean">gboolean</link> active);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-chain-button-get-active">gimp_chain_button_get_active</link> (<link linkend="GimpChainButton">GimpChainButton</link> *button);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkTable">GtkTable</link>
|
||||
+----GimpChainButton
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpChainButton implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpChainButton-toggled">toggled</link>" <link linkend="void">void</link> user_function (<link linkend="GimpChainButton">GimpChainButton</link> *gimpchainbutton,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This widget provides a button showing either a linked or a broken
|
||||
chain that can be used to link two entries, spinbuttons, colors
|
||||
or other GUI elements and show that they may be locked. Use it for
|
||||
example to connect X and Y ratios to provide the possibility of a
|
||||
constrained aspect ratio.
|
||||
</para>
|
||||
<para>
|
||||
The <link linkend="GimpChainButton"><type>GimpChainButton</type></link> only gives visual feedback, it does not really
|
||||
connect widgets. You have to take care of locking the values yourself
|
||||
by checking the state of the <link linkend="GimpChainButton"><type>GimpChainButton</type></link> whenever a value changes
|
||||
in one of the connected widgets and adjusting the other value if
|
||||
necessary.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpChainButton-struct"/>struct GimpChainButton</title>
|
||||
<indexterm><primary>GimpChainButton</primary></indexterm><programlisting>struct GimpChainButton;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpChainPosition"/>enum GimpChainPosition</title>
|
||||
<indexterm><primary>GimpChainPosition</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_CHAIN_TOP,
|
||||
GIMP_CHAIN_LEFT,
|
||||
GIMP_CHAIN_BOTTOM,
|
||||
GIMP_CHAIN_RIGHT
|
||||
} GimpChainPosition;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-chain-button-new"/>gimp_chain_button_new ()</title>
|
||||
<indexterm><primary>gimp_chain_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_chain_button_new (<link linkend="GimpChainPosition">GimpChainPosition</link> position);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpChainButton"><type>GimpChainButton</type></link> widget.
|
||||
</para>
|
||||
<para>
|
||||
This returns a button showing either a broken or a linked chain and
|
||||
small clamps attached to both sides that visually group the two widgets
|
||||
you want to connect. This widget looks best when attached
|
||||
to a table taking up two columns (or rows respectively) next
|
||||
to the widgets that it is supposed to connect. It may work
|
||||
for more than two widgets, but the look is optimized for two.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>position</parameter> :</term>
|
||||
<listitem><simpara> The position you are going to use for the button
|
||||
with respect to the widgets you want to chain.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpChainButton"><type>GimpChainButton</type></link>, which is inactive
|
||||
by default. Use <link linkend="gimp-chain-button-set-active"><function>gimp_chain_button_set_active()</function></link> to
|
||||
change its state.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-chain-button-set-active"/>gimp_chain_button_set_active ()</title>
|
||||
<indexterm><primary>gimp_chain_button_set_active</primary></indexterm><programlisting><link linkend="void">void</link> gimp_chain_button_set_active (<link linkend="GimpChainButton">GimpChainButton</link> *button,
|
||||
<link linkend="gboolean">gboolean</link> active);</programlisting>
|
||||
<para>
|
||||
Sets the state of the <link linkend="GimpChainButton"><type>GimpChainButton</type></link> to be either locked (<literal>TRUE</literal>) or
|
||||
unlocked (<literal>FALSE</literal>) and changes the showed pixmap to reflect the new state.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpChainButton"><type>GimpChainButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>active</parameter> :</term>
|
||||
<listitem><simpara> The new state.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-chain-button-get-active"/>gimp_chain_button_get_active ()</title>
|
||||
<indexterm><primary>gimp_chain_button_get_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_chain_button_get_active (<link linkend="GimpChainButton">GimpChainButton</link> *button);</programlisting>
|
||||
<para>
|
||||
Checks the state of the <link linkend="GimpChainButton"><type>GimpChainButton</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpChainButton"><type>GimpChainButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the <link linkend="GimpChainButton"><type>GimpChainButton</type></link> is active (locked).
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpChainButton-toggled"/>The "toggled" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpChainButton">GimpChainButton</link> *gimpchainbutton,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpchainbutton</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
You may want to use the convenience function <link linkend="gimp-coordinates-new"><function>gimp_coordinates_new()</function></link> to set
|
||||
up two GimpSizeEntries (see <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>) linked with a <link linkend="GimpChainButton"><type>GimpChainButton</type></link>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
234
devel-docs/libgimpwidgets/xml/gimpcolorarea.xml
Normal file
234
devel-docs/libgimpwidgets/xml/gimpcolorarea.xml
Normal file
@ -0,0 +1,234 @@
|
||||
<?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="GimpColorArea">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorArea</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorArea</refname><refpurpose>Displays a GimpRGB color, optionally with alpha-channel.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorArea-struct">GimpColorArea</link>;
|
||||
enum <link linkend="GimpColorAreaType">GimpColorAreaType</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-area-new">gimp_color_area_new</link> (const <link linkend="GimpRGB">GimpRGB</link> *color,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> drag_mask);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-area-set-color">gimp_color_area_set_color</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-area-get-color">gimp_color_area_get_color</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-area-has-alpha">gimp_color_area_has_alpha</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-area-set-type">gimp_color_area_set_type</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-area-set-draw-border">gimp_color_area_set_draw_border</link> (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
<link linkend="gboolean">gboolean</link> draw_border);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkDrawingArea">GtkDrawingArea</link>
|
||||
+----GimpColorArea
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorArea implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorArea-color-changed">color-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpColorArea">GimpColorArea</link> *gimpcolorarea,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorArea-struct"/>struct GimpColorArea</title>
|
||||
<indexterm><primary>GimpColorArea</primary></indexterm><programlisting>struct GimpColorArea;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorAreaType"/>enum GimpColorAreaType</title>
|
||||
<indexterm><primary>GimpColorAreaType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_COLOR_AREA_FLAT = 0,
|
||||
GIMP_COLOR_AREA_SMALL_CHECKS,
|
||||
GIMP_COLOR_AREA_LARGE_CHECKS
|
||||
} GimpColorAreaType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-area-new"/>gimp_color_area_new ()</title>
|
||||
<indexterm><primary>gimp_color_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_area_new (const <link linkend="GimpRGB">GimpRGB</link> *color,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type,
|
||||
<link linkend="GdkModifierType">GdkModifierType</link> drag_mask);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
|
||||
</para>
|
||||
<para>
|
||||
This returns a preview area showing the color. It handles color
|
||||
DND. If the color changes, the "color_changed" signal is emitted.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> A pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> The type of color area to create.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>drag_mask</parameter> :</term>
|
||||
<listitem><simpara> The event_mask that should trigger drags.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpColorArea"><type>GimpColorArea</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-area-set-color"/>gimp_color_area_set_color ()</title>
|
||||
<indexterm><primary>gimp_color_area_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_set_color (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Sets <parameter>area</parameter> to a different <parameter>color</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct that defines the new color.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-area-get-color"/>gimp_color_area_get_color ()</title>
|
||||
<indexterm><primary>gimp_color_area_get_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_get_color (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Retrieves the current color of the <parameter>area</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct that is used to return the color.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-area-has-alpha"/>gimp_color_area_has_alpha ()</title>
|
||||
<indexterm><primary>gimp_color_area_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_area_has_alpha (<link linkend="GimpColorArea">GimpColorArea</link> *area);</programlisting>
|
||||
<para>
|
||||
Checks whether the <parameter>area</parameter> shows transparency information. This is determined
|
||||
via the <parameter>area</parameter>'s <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if <parameter>area</parameter> shows transparency information, <literal>FALSE</literal> otherwise.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-area-set-type"/>gimp_color_area_set_type ()</title>
|
||||
<indexterm><primary>gimp_color_area_set_type</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_set_type (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
|
||||
<para>
|
||||
Allows to change the type of <parameter>area</parameter>. The <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link> determines
|
||||
whether the widget shows transparency information and chooses the size of
|
||||
the checkerboard used to do that.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-area-set-draw-border"/>gimp_color_area_set_draw_border ()</title>
|
||||
<indexterm><primary>gimp_color_area_set_draw_border</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_area_set_draw_border (<link linkend="GimpColorArea">GimpColorArea</link> *area,
|
||||
<link linkend="gboolean">gboolean</link> draw_border);</programlisting>
|
||||
<para>
|
||||
The <parameter>area</parameter> can draw a thin border in the foreground color around
|
||||
itself. This function allows to toggle this behaviour on and
|
||||
off. The default is not draw a border.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorArea"><type>GimpColorArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>draw_border</parameter> :</term>
|
||||
<listitem><simpara> whether to draw a border or not
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorArea-color-changed"/>The "color-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorArea">GimpColorArea</link> *gimpcolorarea,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolorarea</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
263
devel-docs/libgimpwidgets/xml/gimpcolorbutton.xml
Normal file
263
devel-docs/libgimpwidgets/xml/gimpcolorbutton.xml
Normal file
@ -0,0 +1,263 @@
|
||||
<?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="GimpColorButton">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorButton</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorButton</refname><refpurpose>Widget for selecting a color from a simple button.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorButton-struct">GimpColorButton</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-button-new">gimp_color_button_new</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-button-set-color">gimp_color_button_set_color</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-button-get-color">gimp_color_button_get_color</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-button-set-update">gimp_color_button_set_update</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
<link linkend="gboolean">gboolean</link> continuous);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-button-get-update">gimp_color_button_get_update</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-button-has-alpha">gimp_color_button_has_alpha</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-button-set-type">gimp_color_button_set_type</link> (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkButton">GtkButton</link>
|
||||
+----<link linkend="GimpButton">GimpButton</link>
|
||||
+----GimpColorButton
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorButton implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorButton-color-changed">color-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpColorButton">GimpColorButton</link> *gimpcolorbutton,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This widget provides a simple button with a preview showing the
|
||||
color.
|
||||
</para>
|
||||
<para>
|
||||
On click a GtkColorSelectionDialog is opened. Additionally the button
|
||||
supports Drag and Drop and has a right-click menu that allows to choose
|
||||
the color from the current FG or BG color. If the user changes the
|
||||
color, the "color_changed" signal is emitted.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorButton-struct"/>struct GimpColorButton</title>
|
||||
<indexterm><primary>GimpColorButton</primary></indexterm><programlisting>struct GimpColorButton;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-new"/>gimp_color_button_new ()</title>
|
||||
<indexterm><primary>gimp_color_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_button_new (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
|
||||
</para>
|
||||
<para>
|
||||
This returns a button with a preview showing the color.
|
||||
When the button is clicked a GtkColorSelectionDialog is opened.
|
||||
If the user changes the color the new color is written into the
|
||||
array that was used to pass the initial color and the "color_changed"
|
||||
signal is emitted.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> String that will be used as title for the color_selector.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> Width of the colorpreview in pixels.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> Height of the colorpreview in pixels.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> A pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> color.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-set-color"/>gimp_color_button_set_color ()</title>
|
||||
<indexterm><primary>gimp_color_button_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_set_color (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Sets the <parameter>button</parameter> to the given <parameter>color</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> Pointer to the new <link linkend="GimpRGB"><type>GimpRGB</type></link> color.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-get-color"/>gimp_color_button_get_color ()</title>
|
||||
<indexterm><primary>gimp_color_button_get_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_get_color (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Retrieves the currently set color from the <parameter>button</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> struct used to return the color.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-set-update"/>gimp_color_button_set_update ()</title>
|
||||
<indexterm><primary>gimp_color_button_set_update</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_set_update (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
<link linkend="gboolean">gboolean</link> continuous);</programlisting>
|
||||
<para>
|
||||
When set to <link linkend="TRUE-CAPS"><type>TRUE</type></link>, the <parameter>button</parameter> will emit the "color_changed"
|
||||
continuously while the color is changed in the color selection
|
||||
dialog.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>continuous</parameter> :</term>
|
||||
<listitem><simpara> The new setting of the <parameter>continuous_update</parameter> property.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-get-update"/>gimp_color_button_get_update ()</title>
|
||||
<indexterm><primary>gimp_color_button_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_button_get_update (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
|
||||
<para>
|
||||
Returns the color button's <parameter>continuous_update</parameter> property.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorButton"><type>GimpColorButton</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <parameter>continuous_update</parameter> property.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-has-alpha"/>gimp_color_button_has_alpha ()</title>
|
||||
<indexterm><primary>gimp_color_button_has_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_button_has_alpha (<link linkend="GimpColorButton">GimpColorButton</link> *button);</programlisting>
|
||||
<para>
|
||||
Checks whether the <parameter>buttons</parameter> shows transparency information.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the <parameter>button</parameter> shows transparency information, <literal>FALSE</literal>
|
||||
otherwise.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-button-set-type"/>gimp_color_button_set_type ()</title>
|
||||
<indexterm><primary>gimp_color_button_set_type</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_button_set_type (<link linkend="GimpColorButton">GimpColorButton</link> *button,
|
||||
<link linkend="GimpColorAreaType">GimpColorAreaType</link> type);</programlisting>
|
||||
<para>
|
||||
Sets the <parameter>button</parameter> to the given <parameter>type</parameter>. See also <link linkend="gimp-color-area-set-type"><function>gimp_color_area_set_type()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>button</parameter> :</term>
|
||||
<listitem><simpara> Pointer to a <link linkend="GimpColorButton"><type>GimpColorButton</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> the new <link linkend="GimpColorAreaType"><type>GimpColorAreaType</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorButton-color-changed"/>The "color-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorButton">GimpColorButton</link> *gimpcolorbutton,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolorbutton</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="libgimpcolor-gimpcolorspace"><type>libgimpcolor-gimpcolorspace</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
296
devel-docs/libgimpwidgets/xml/gimpcolordisplay.xml
Normal file
296
devel-docs/libgimpwidgets/xml/gimpcolordisplay.xml
Normal file
@ -0,0 +1,296 @@
|
||||
<?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="GimpColorDisplay">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorDisplay</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorDisplay</refname><refpurpose>Pluggable GIMP display color correction modules.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorDisplay-struct">GimpColorDisplay</link>;
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link>* <link linkend="gimp-color-display-new">gimp_color_display_new</link> (<link linkend="GType">GType</link> display_type);
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link>* <link linkend="gimp-color-display-clone">gimp_color_display_clone</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-set-enabled">gimp_color_display_set_enabled</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display,
|
||||
<link linkend="gboolean">gboolean</link> enabled);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-display-get-enabled">gimp_color_display_get_enabled</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-convert">gimp_color_display_convert</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display,
|
||||
<link linkend="guchar">guchar</link> *buf,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="gint">gint</link> bpp,
|
||||
<link linkend="gint">gint</link> bpl);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-load-state">gimp_color_display_load_state</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display,
|
||||
<link linkend="GimpParasite">GimpParasite</link> *state);
|
||||
<link linkend="GimpParasite">GimpParasite</link>* <link linkend="gimp-color-display-save-state">gimp_color_display_save_state</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-display-configure">gimp_color_display_configure</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-configure-reset">gimp_color_display_configure_reset</link>
|
||||
(<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-changed">gimp_color_display_changed</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----GimpColorDisplay
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorDisplay--enabled">enabled</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorDisplay-changed">changed</link>" <link linkend="void">void</link> user_function (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *gimpcolordisplay,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Functions and definitions for creating pluggable GIMP
|
||||
display color correction modules.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorDisplay-struct"/>struct GimpColorDisplay</title>
|
||||
<indexterm><primary>GimpColorDisplay</primary></indexterm><programlisting>struct GimpColorDisplay;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-new"/>gimp_color_display_new ()</title>
|
||||
<indexterm><primary>gimp_color_display_new</primary></indexterm><programlisting><link linkend="GimpColorDisplay">GimpColorDisplay</link>* gimp_color_display_new (<link linkend="GType">GType</link> display_type);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display_type</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-clone"/>gimp_color_display_clone ()</title>
|
||||
<indexterm><primary>gimp_color_display_clone</primary></indexterm><programlisting><link linkend="GimpColorDisplay">GimpColorDisplay</link>* gimp_color_display_clone (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-set-enabled"/>gimp_color_display_set_enabled ()</title>
|
||||
<indexterm><primary>gimp_color_display_set_enabled</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_set_enabled (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display,
|
||||
<link linkend="gboolean">gboolean</link> enabled);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>enabled</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-get-enabled"/>gimp_color_display_get_enabled ()</title>
|
||||
<indexterm><primary>gimp_color_display_get_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_display_get_enabled (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-convert"/>gimp_color_display_convert ()</title>
|
||||
<indexterm><primary>gimp_color_display_convert</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_convert (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display,
|
||||
<link linkend="guchar">guchar</link> *buf,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="gint">gint</link> bpp,
|
||||
<link linkend="gint">gint</link> bpl);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>bpp</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>bpl</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-load-state"/>gimp_color_display_load_state ()</title>
|
||||
<indexterm><primary>gimp_color_display_load_state</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_load_state (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display,
|
||||
<link linkend="GimpParasite">GimpParasite</link> *state);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>state</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-save-state"/>gimp_color_display_save_state ()</title>
|
||||
<indexterm><primary>gimp_color_display_save_state</primary></indexterm><programlisting><link linkend="GimpParasite">GimpParasite</link>* gimp_color_display_save_state (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-configure"/>gimp_color_display_configure ()</title>
|
||||
<indexterm><primary>gimp_color_display_configure</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_display_configure (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-configure-reset"/>gimp_color_display_configure_reset ()</title>
|
||||
<indexterm><primary>gimp_color_display_configure_reset</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_configure_reset
|
||||
(<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-changed"/>gimp_color_display_changed ()</title>
|
||||
<indexterm><primary>gimp_color_display_changed</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_changed (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpColorDisplay--enabled"/>"<literal>enabled</literal>" (<link linkend="gboolean">gboolean</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorDisplay-changed"/>The "changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *gimpcolordisplay,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolordisplay</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GModule"><type>GModule</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GTypeModule"><type>GTypeModule</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="libgimp-gimpmodule"><type>libgimp-gimpmodule</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
318
devel-docs/libgimpwidgets/xml/gimpcolordisplaystack.xml
Normal file
318
devel-docs/libgimpwidgets/xml/gimpcolordisplaystack.xml
Normal file
@ -0,0 +1,318 @@
|
||||
<?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="GimpColorDisplayStack">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorDisplayStack</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorDisplayStack</refname><refpurpose></refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorDisplayStack-struct">GimpColorDisplayStack</link>;
|
||||
<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link>* <link linkend="gimp-color-display-stack-new">gimp_color_display_stack_new</link>
|
||||
(void);
|
||||
<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link>* <link linkend="gimp-color-display-stack-clone">gimp_color_display_stack_clone</link>
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-stack-changed">gimp_color_display_stack_changed</link>
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-stack-add">gimp_color_display_stack_add</link> (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-stack-remove">gimp_color_display_stack_remove</link> (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-stack-reorder-up">gimp_color_display_stack_reorder_up</link>
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-stack-reorder-down">gimp_color_display_stack_reorder_down</link>
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-display-stack-convert">gimp_color_display_stack_convert</link>
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="guchar">guchar</link> *buf,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="gint">gint</link> bpp,
|
||||
<link linkend="gint">gint</link> bpl);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----GimpColorDisplayStack
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorDisplayStack-added">added</link>" <link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *arg1,
|
||||
<link linkend="gint">gint</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpColorDisplayStack-changed">changed</link>" <link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpColorDisplayStack-removed">removed</link>" <link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpColorDisplayStack-reordered">reordered</link>" <link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *arg1,
|
||||
<link linkend="gint">gint</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorDisplayStack-struct"/>struct GimpColorDisplayStack</title>
|
||||
<indexterm><primary>GimpColorDisplayStack</primary></indexterm><programlisting>struct GimpColorDisplayStack;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-new"/>gimp_color_display_stack_new ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_new</primary></indexterm><programlisting><link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link>* gimp_color_display_stack_new
|
||||
(void);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-clone"/>gimp_color_display_stack_clone ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_clone</primary></indexterm><programlisting><link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link>* gimp_color_display_stack_clone
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-changed"/>gimp_color_display_stack_changed ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_changed</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_stack_changed
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-add"/>gimp_color_display_stack_add ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_add</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_stack_add (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-remove"/>gimp_color_display_stack_remove ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_remove</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_stack_remove (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-reorder-up"/>gimp_color_display_stack_reorder_up ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_reorder_up</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_stack_reorder_up
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-reorder-down"/>gimp_color_display_stack_reorder_down ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_reorder_down</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_stack_reorder_down
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>display</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-display-stack-convert"/>gimp_color_display_stack_convert ()</title>
|
||||
<indexterm><primary>gimp_color_display_stack_convert</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_display_stack_convert
|
||||
(<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *stack,
|
||||
<link linkend="guchar">guchar</link> *buf,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="gint">gint</link> bpp,
|
||||
<link linkend="gint">gint</link> bpl);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>stack</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>bpp</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>bpl</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorDisplayStack-added"/>The "added" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *arg1,
|
||||
<link linkend="gint">gint</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolordisplaystack</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg2</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2><refsect2><title><anchor id="GimpColorDisplayStack-changed"/>The "changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolordisplaystack</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2><refsect2><title><anchor id="GimpColorDisplayStack-removed"/>The "removed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolordisplaystack</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2><refsect2><title><anchor id="GimpColorDisplayStack-reordered"/>The "reordered" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorDisplayStack">GimpColorDisplayStack</link> *gimpcolordisplaystack,
|
||||
<link linkend="GimpColorDisplay">GimpColorDisplay</link> *arg1,
|
||||
<link linkend="gint">gint</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolordisplaystack</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg2</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
154
devel-docs/libgimpwidgets/xml/gimpcolorhexentry.xml
Normal file
154
devel-docs/libgimpwidgets/xml/gimpcolorhexentry.xml
Normal file
@ -0,0 +1,154 @@
|
||||
<?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="GimpColorHexEntry">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorHexEntry</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorHexEntry</refname><refpurpose>Widget for entering a color's hex triplet.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorHexEntry-struct">GimpColorHexEntry</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-hex-entry-new">gimp_color_hex_entry_new</link> (void);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-hex-entry-set-color">gimp_color_hex_entry_set_color</link> (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-hex-entry-get-color">gimp_color_hex_entry_get_color</link> (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkEntry">GtkEntry</link>
|
||||
+----GimpColorHexEntry
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorHexEntry implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkEditable">GtkEditable</link> and <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorHexEntry-color-changed">color-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *gimpcolorhexentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Widget for entering a color's hex triplet.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorHexEntry-struct"/>struct GimpColorHexEntry</title>
|
||||
<indexterm><primary>GimpColorHexEntry</primary></indexterm><programlisting>struct GimpColorHexEntry;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-hex-entry-new"/>gimp_color_hex_entry_new ()</title>
|
||||
<indexterm><primary>gimp_color_hex_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_hex_entry_new (void);</programlisting>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-hex-entry-set-color"/>gimp_color_hex_entry_set_color ()</title>
|
||||
<indexterm><primary>gimp_color_hex_entry_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_hex_entry_set_color (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Sets the color displayed by a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link>. If the new color
|
||||
is different to the previously set color, the "color_changed"
|
||||
signal is emitted.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>entry</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-hex-entry-get-color"/>gimp_color_hex_entry_get_color ()</title>
|
||||
<indexterm><primary>gimp_color_hex_entry_get_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_hex_entry_get_color (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *entry,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Retrieves the color value displayed by a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>entry</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpColorHexEntry"><type>GimpColorHexEntry</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorHexEntry-color-changed"/>The "color-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorHexEntry">GimpColorHexEntry</link> *gimpcolorhexentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolorhexentry</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
130
devel-docs/libgimpwidgets/xml/gimpcolornotebook.xml
Normal file
130
devel-docs/libgimpwidgets/xml/gimpcolornotebook.xml
Normal file
@ -0,0 +1,130 @@
|
||||
<?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="GimpColorNotebook">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorNotebook</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorNotebook</refname><refpurpose>A <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorNotebook-struct">GimpColorNotebook</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-notebook-set-has-page">gimp_color_notebook_set_has_page</link>
|
||||
(<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
|
||||
<link linkend="GType">GType</link> page_type,
|
||||
<link linkend="gboolean">gboolean</link> has_page);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----<link linkend="GimpColorSelector">GimpColorSelector</link>
|
||||
+----GimpColorNotebook
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorNotebook implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Style Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorNotebook--tab-border">tab-border</link>" <link linkend="gint">gint</link> : Read
|
||||
"<link linkend="GimpColorNotebook--tab-icon-size">tab-icon-size</link>" <link linkend="GtkIconSize">GtkIconSize</link> : Read
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
The <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link> widget is an implementation of a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link>.
|
||||
It serves as a container for <link linkend="GimpColorSelectors"><type>GimpColorSelectors</type></link>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorNotebook-struct"/>struct GimpColorNotebook</title>
|
||||
<indexterm><primary>GimpColorNotebook</primary></indexterm><programlisting>struct GimpColorNotebook;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-notebook-set-has-page"/>gimp_color_notebook_set_has_page ()</title>
|
||||
<indexterm><primary>gimp_color_notebook_set_has_page</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_notebook_set_has_page
|
||||
(<link linkend="GimpColorNotebook">GimpColorNotebook</link> *notebook,
|
||||
<link linkend="GType">GType</link> page_type,
|
||||
<link linkend="gboolean">gboolean</link> has_page);</programlisting>
|
||||
<para>
|
||||
This function adds and removed pages to / from a <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link>.
|
||||
The <parameter>page_type</parameter> passed must be a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> subtype.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>notebook</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorNotebook"><type>GimpColorNotebook</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>page_type</parameter> :</term>
|
||||
<listitem><simpara> The <link linkend="GType"><type>GType</type></link> of the notebook page to add or remove.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>has_page</parameter> :</term>
|
||||
<listitem><simpara> Whether the page should be added or removed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new page widget, if <parameter>has_page</parameter> was <link linkend="TRUE-CAPS"><type>TRUE</type></link>, or <link linkend="NULL-CAPS"><type>NULL</type></link>
|
||||
if <parameter>has_page</parameter> was <link linkend="FALSE-CAPS"><type>FALSE</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Style Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpColorNotebook--tab-border"/>"<literal>tab-border</literal>" (<link linkend="gint">gint</link> : Read)</term>
|
||||
<listitem>
|
||||
<para>Width of the border around the tab contents.</para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpColorNotebook--tab-icon-size"/>"<literal>tab-icon-size</literal>" (<link linkend="GtkIconSize">GtkIconSize</link> : Read)</term>
|
||||
<listitem>
|
||||
<para>Size for icons displayed in the tab.</para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
137
devel-docs/libgimpwidgets/xml/gimpcolorscale.xml
Normal file
137
devel-docs/libgimpwidgets/xml/gimpcolorscale.xml
Normal file
@ -0,0 +1,137 @@
|
||||
<?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="GimpColorScale">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorScale</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorScale</refname><refpurpose>Fancy colored sliders.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorScale-struct">GimpColorScale</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-scale-new">gimp_color_scale_new</link> (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-scale-set-channel">gimp_color_scale_set_channel</link> (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-scale-set-color">gimp_color_scale_set_color</link> (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *rgb,
|
||||
const <link linkend="GimpHSV">GimpHSV</link> *hsv);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkRange">GtkRange</link>
|
||||
+----<link linkend="GtkScale">GtkScale</link>
|
||||
+----GimpColorScale
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorScale implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorScale-struct"/>struct GimpColorScale</title>
|
||||
<indexterm><primary>GimpColorScale</primary></indexterm><programlisting>struct GimpColorScale;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-scale-new"/>gimp_color_scale_new ()</title>
|
||||
<indexterm><primary>gimp_color_scale_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_scale_new (<link linkend="GtkOrientation">GtkOrientation</link> orientation,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>orientation</parameter> :</term>
|
||||
<listitem><simpara> the scale's orientation (horizontal or vertical)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara> the scale's color channel
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-scale-set-channel"/>gimp_color_scale_set_channel ()</title>
|
||||
<indexterm><primary>gimp_color_scale_set_channel</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_scale_set_channel (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);</programlisting>
|
||||
<para>
|
||||
Changes the color channel displayed by the <parameter>scale</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>scale</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara> the new color channel
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-scale-set-color"/>gimp_color_scale_set_color ()</title>
|
||||
<indexterm><primary>gimp_color_scale_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_scale_set_color (<link linkend="GimpColorScale">GimpColorScale</link> *scale,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *rgb,
|
||||
const <link linkend="GimpHSV">GimpHSV</link> *hsv);</programlisting>
|
||||
<para>
|
||||
Changes the color value of the <parameter>scale</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>scale</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rgb</parameter> :</term>
|
||||
<listitem><simpara> the new color as <link linkend="GimpRGB"><type>GimpRGB</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>hsv</parameter> :</term>
|
||||
<listitem><simpara> the new color as <link linkend="GimpHSV"><type>GimpHSV</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
80
devel-docs/libgimpwidgets/xml/gimpcolorscales.xml
Normal file
80
devel-docs/libgimpwidgets/xml/gimpcolorscales.xml
Normal file
@ -0,0 +1,80 @@
|
||||
<?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="GimpColorScales">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorScales</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorScales</refname><refpurpose>A <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorScales-struct">GimpColorScales</link>;
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----<link linkend="GimpColorSelector">GimpColorSelector</link>
|
||||
+----GimpColorScales
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorScales implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
The <link linkend="GimpColorScales"><type>GimpColorScales</type></link> widget is an implementation of a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link>.
|
||||
It shows a group of <link linkend="GimpColorScale"><type>GimpColorScale</type></link> widgets that allow to adjust the
|
||||
HSV and RGB color channels.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorScales-struct"/>struct GimpColorScales</title>
|
||||
<indexterm><primary>GimpColorScales</primary></indexterm><programlisting>struct GimpColorScales;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
82
devel-docs/libgimpwidgets/xml/gimpcolorselect.xml
Normal file
82
devel-docs/libgimpwidgets/xml/gimpcolorselect.xml
Normal file
@ -0,0 +1,82 @@
|
||||
<?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="GimpColorSelect">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorSelect</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorSelect</refname><refpurpose>A <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorSelect-struct">GimpColorSelect</link>;
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----<link linkend="GimpColorSelector">GimpColorSelector</link>
|
||||
+----GimpColorSelect
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorSelect implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
The <link linkend="GimpColorSelect"><type>GimpColorSelect</type></link> widget is an implementation of a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link>.
|
||||
It shows a square area that allows to interactively change two color channels
|
||||
and a smaller area to change the third channel. You can select which channel
|
||||
should be the third by calling <link linkend="gimp-color-selector-set-channel"><function>gimp_color_selector_set_channel()</function></link>. The widget
|
||||
will then change the other two channels accordingly.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorSelect-struct"/>struct GimpColorSelect</title>
|
||||
<indexterm><primary>GimpColorSelect</primary></indexterm><programlisting>struct GimpColorSelect;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
255
devel-docs/libgimpwidgets/xml/gimpcolorselection.xml
Normal file
255
devel-docs/libgimpwidgets/xml/gimpcolorselection.xml
Normal file
@ -0,0 +1,255 @@
|
||||
<?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="GimpColorSelection">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorSelection</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorSelection</refname><refpurpose>Widget for doing a color selection.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorSelection-struct">GimpColorSelection</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-selection-new">gimp_color_selection_new</link> (void);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-set-show-alpha">gimp_color_selection_set_show_alpha</link>
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
<link linkend="gboolean">gboolean</link> show_alpha);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-color-selection-get-show-alpha">gimp_color_selection_get_show_alpha</link>
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-set-color">gimp_color_selection_set_color</link> (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-get-color">gimp_color_selection_get_color</link> (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-set-old-color">gimp_color_selection_set_old_color</link>
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-get-old-color">gimp_color_selection_get_old_color</link>
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-reset">gimp_color_selection_reset</link> (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selection-color-changed">gimp_color_selection_color_changed</link>
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----GimpColorSelection
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorSelection implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorSelection-color-changed">color-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorSelection-struct"/>struct GimpColorSelection</title>
|
||||
<indexterm><primary>GimpColorSelection</primary></indexterm><programlisting>struct GimpColorSelection;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-new"/>gimp_color_selection_new ()</title>
|
||||
<indexterm><primary>gimp_color_selection_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_selection_new (void);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The new <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-set-show-alpha"/>gimp_color_selection_set_show_alpha ()</title>
|
||||
<indexterm><primary>gimp_color_selection_set_show_alpha</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_set_show_alpha
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
<link linkend="gboolean">gboolean</link> show_alpha);</programlisting>
|
||||
<para>
|
||||
Sets the <parameter>show_alpha</parameter> property of the <parameter>selection</parameter> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>show_alpha</parameter> :</term>
|
||||
<listitem><simpara> The new <parameter>show_alpha</parameter> setting.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-get-show-alpha"/>gimp_color_selection_get_show_alpha ()</title>
|
||||
<indexterm><primary>gimp_color_selection_get_show_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_color_selection_get_show_alpha
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
|
||||
<para>
|
||||
Returns the <parameter>selection</parameter>'s <parameter>show_alpha</parameter> property.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE-CAPS"><type>TRUE</type></link> if the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> has alpha controls.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-set-color"/>gimp_color_selection_set_color ()</title>
|
||||
<indexterm><primary>gimp_color_selection_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_set_color (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color to the new <parameter>color</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>color</parameter> to set as current color.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-get-color"/>gimp_color_selection_get_color ()</title>
|
||||
<indexterm><primary>gimp_color_selection_get_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_get_color (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
This function returns the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> Return location for the <parameter>selection</parameter>'s current <parameter>color</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-set-old-color"/>gimp_color_selection_set_old_color ()</title>
|
||||
<indexterm><primary>gimp_color_selection_set_old_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_set_old_color
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s old color.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>color</parameter> to set as old color.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-get-old-color"/>gimp_color_selection_get_old_color ()</title>
|
||||
<indexterm><primary>gimp_color_selection_get_old_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_get_old_color
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection,
|
||||
<link linkend="GimpRGB">GimpRGB</link> *color);</programlisting>
|
||||
<para>
|
||||
This function returns the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s old color.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>color</parameter> :</term>
|
||||
<listitem><simpara> Return location for the <parameter>selection</parameter>'s old <parameter>color</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-reset"/>gimp_color_selection_reset ()</title>
|
||||
<indexterm><primary>gimp_color_selection_reset</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_reset (<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
|
||||
<para>
|
||||
Sets the <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link>'s current color to its old color.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selection-color-changed"/>gimp_color_selection_color_changed ()</title>
|
||||
<indexterm><primary>gimp_color_selection_color_changed</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selection_color_changed
|
||||
(<link linkend="GimpColorSelection">GimpColorSelection</link> *selection);</programlisting>
|
||||
<para>
|
||||
Emits the "color_changed" signal.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selection</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GimpColorSelection"><type>GimpColorSelection</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorSelection-color-changed"/>The "color-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorSelection">GimpColorSelection</link> *gimpcolorselection,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolorselection</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
379
devel-docs/libgimpwidgets/xml/gimpcolorselector.xml
Normal file
379
devel-docs/libgimpwidgets/xml/gimpcolorselector.xml
Normal file
@ -0,0 +1,379 @@
|
||||
<?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="GimpColorSelector">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpColorSelector</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpColorSelector</refname><refpurpose>Pluggable GIMP color selector modules.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpColorSelector-struct">GimpColorSelector</link>;
|
||||
#define <link linkend="GIMP-COLOR-SELECTOR-SIZE-CAPS">GIMP_COLOR_SELECTOR_SIZE</link>
|
||||
#define <link linkend="GIMP-COLOR-SELECTOR-BAR-SIZE-CAPS">GIMP_COLOR_SELECTOR_BAR_SIZE</link>
|
||||
enum <link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-selector-new">gimp_color_selector_new</link> (<link linkend="GType">GType</link> selector_type,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *rgb,
|
||||
const <link linkend="GimpHSV">GimpHSV</link> *hsv,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-set-toggles-visible">gimp_color_selector_set_toggles_visible</link>
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="gboolean">gboolean</link> visible);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-set-toggles-sensitive">gimp_color_selector_set_toggles_sensitive</link>
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="gboolean">gboolean</link> sensitive);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-set-show-alpha">gimp_color_selector_set_show_alpha</link>
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="gboolean">gboolean</link> show_alpha);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-set-color">gimp_color_selector_set_color</link> (<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *rgb,
|
||||
const <link linkend="GimpHSV">GimpHSV</link> *hsv);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-set-channel">gimp_color_selector_set_channel</link> (<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-color-changed">gimp_color_selector_color_changed</link>
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector);
|
||||
<link linkend="void">void</link> <link linkend="gimp-color-selector-channel-changed">gimp_color_selector_channel_changed</link>
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----GimpColorSelector
|
||||
+----<link linkend="GimpColorNotebook">GimpColorNotebook</link>
|
||||
+----<link linkend="GimpColorScales">GimpColorScales</link>
|
||||
+----<link linkend="GimpColorSelect">GimpColorSelect</link>
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpColorSelector implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpColorSelector-channel-changed">channel-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpColorSelector">GimpColorSelector</link> *gimpcolorselector,
|
||||
<link linkend="gint">gint</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpColorSelector-color-changed">color-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpColorSelector">GimpColorSelector</link> *gimpcolorselector,
|
||||
<link linkend="gpointer">gpointer</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Functions and definitions for creating pluggable GIMP color
|
||||
selector modules.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorSelector-struct"/>struct GimpColorSelector</title>
|
||||
<indexterm><primary>GimpColorSelector</primary></indexterm><programlisting>struct GimpColorSelector;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GIMP-COLOR-SELECTOR-SIZE-CAPS"/>GIMP_COLOR_SELECTOR_SIZE</title>
|
||||
<indexterm><primary>GIMP_COLOR_SELECTOR_SIZE</primary></indexterm><programlisting>#define GIMP_COLOR_SELECTOR_SIZE 150
|
||||
</programlisting>
|
||||
<para>
|
||||
The suggested size for a color area in a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GIMP-COLOR-SELECTOR-BAR-SIZE-CAPS"/>GIMP_COLOR_SELECTOR_BAR_SIZE</title>
|
||||
<indexterm><primary>GIMP_COLOR_SELECTOR_BAR_SIZE</primary></indexterm><programlisting>#define GIMP_COLOR_SELECTOR_BAR_SIZE 15
|
||||
</programlisting>
|
||||
<para>
|
||||
The suggested width for a color bar in a <link linkend="GimpColorSelector"><type>GimpColorSelector</type></link> implementation.
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpColorSelectorChannel"/>enum GimpColorSelectorChannel</title>
|
||||
<indexterm><primary>GimpColorSelectorChannel</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_COLOR_SELECTOR_HUE,
|
||||
GIMP_COLOR_SELECTOR_SATURATION,
|
||||
GIMP_COLOR_SELECTOR_VALUE,
|
||||
GIMP_COLOR_SELECTOR_RED,
|
||||
GIMP_COLOR_SELECTOR_GREEN,
|
||||
GIMP_COLOR_SELECTOR_BLUE,
|
||||
GIMP_COLOR_SELECTOR_ALPHA
|
||||
} GimpColorSelectorChannel;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="enum">
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_HUE</literal></term>
|
||||
<listitem><simpara>the hue channel
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_SATURATION</literal></term>
|
||||
<listitem><simpara>the saturation channel
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_VALUE</literal></term>
|
||||
<listitem><simpara>the value channel
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_RED</literal></term>
|
||||
<listitem><simpara>the red channel
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_GREEN</literal></term>
|
||||
<listitem><simpara>the green channel
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_BLUE</literal></term>
|
||||
<listitem><simpara>the blue channel
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><literal>GIMP_COLOR_SELECTOR_ALPHA</literal></term>
|
||||
<listitem><simpara>the alpha channel
|
||||
|
||||
</simpara></listitem>
|
||||
</varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-new"/>gimp_color_selector_new ()</title>
|
||||
<indexterm><primary>gimp_color_selector_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_selector_new (<link linkend="GType">GType</link> selector_type,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *rgb,
|
||||
const <link linkend="GimpHSV">GimpHSV</link> *hsv,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector_type</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rgb</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>hsv</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-set-toggles-visible"/>gimp_color_selector_set_toggles_visible ()</title>
|
||||
<indexterm><primary>gimp_color_selector_set_toggles_visible</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_set_toggles_visible
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="gboolean">gboolean</link> visible);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>visible</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-set-toggles-sensitive"/>gimp_color_selector_set_toggles_sensitive ()</title>
|
||||
<indexterm><primary>gimp_color_selector_set_toggles_sensitive</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_set_toggles_sensitive
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="gboolean">gboolean</link> sensitive);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>sensitive</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-set-show-alpha"/>gimp_color_selector_set_show_alpha ()</title>
|
||||
<indexterm><primary>gimp_color_selector_set_show_alpha</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_set_show_alpha
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="gboolean">gboolean</link> show_alpha);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>show_alpha</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-set-color"/>gimp_color_selector_set_color ()</title>
|
||||
<indexterm><primary>gimp_color_selector_set_color</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_set_color (<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
const <link linkend="GimpRGB">GimpRGB</link> *rgb,
|
||||
const <link linkend="GimpHSV">GimpHSV</link> *hsv);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rgb</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>hsv</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-set-channel"/>gimp_color_selector_set_channel ()</title>
|
||||
<indexterm><primary>gimp_color_selector_set_channel</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_set_channel (<link linkend="GimpColorSelector">GimpColorSelector</link> *selector,
|
||||
<link linkend="GimpColorSelectorChannel">GimpColorSelectorChannel</link> channel);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>channel</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-color-changed"/>gimp_color_selector_color_changed ()</title>
|
||||
<indexterm><primary>gimp_color_selector_color_changed</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_color_changed
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-color-selector-channel-changed"/>gimp_color_selector_channel_changed ()</title>
|
||||
<indexterm><primary>gimp_color_selector_channel_changed</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_selector_channel_changed
|
||||
(<link linkend="GimpColorSelector">GimpColorSelector</link> *selector);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>selector</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpColorSelector-channel-changed"/>The "channel-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorSelector">GimpColorSelector</link> *gimpcolorselector,
|
||||
<link linkend="gint">gint</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolorselector</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2><refsect2><title><anchor id="GimpColorSelector-color-changed"/>The "color-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpColorSelector">GimpColorSelector</link> *gimpcolorselector,
|
||||
<link linkend="gpointer">gpointer</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcolorselector</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg2</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GModule"><type>GModule</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GTypeModule"><type>GTypeModule</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="libgimp-gimpmodule"><type>libgimp-gimpmodule</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
276
devel-docs/libgimpwidgets/xml/gimpcontroller.xml
Normal file
276
devel-docs/libgimpwidgets/xml/gimpcontroller.xml
Normal file
@ -0,0 +1,276 @@
|
||||
<?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="GimpController">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpController</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpController</refname><refpurpose>Pluggable GIMP input controller modules.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
enum <link linkend="GimpControllerEventType">GimpControllerEventType</link>;
|
||||
struct <link linkend="GimpControllerEventAny">GimpControllerEventAny</link>;
|
||||
struct <link linkend="GimpControllerEventTrigger">GimpControllerEventTrigger</link>;
|
||||
struct <link linkend="GimpControllerEventValue">GimpControllerEventValue</link>;
|
||||
union <link linkend="GimpControllerEvent">GimpControllerEvent</link>;
|
||||
struct <link linkend="GimpController-struct">GimpController</link>;
|
||||
<link linkend="GimpController">GimpController</link>* <link linkend="gimp-controller-new">gimp_controller_new</link> (<link linkend="GType">GType</link> controller_type);
|
||||
<link linkend="gint">gint</link> <link linkend="gimp-controller-get-n-events">gimp_controller_get_n_events</link> (<link linkend="GimpController">GimpController</link> *controller);
|
||||
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-name">gimp_controller_get_event_name</link> (<link linkend="GimpController">GimpController</link> *controller,
|
||||
<link linkend="gint">gint</link> event_id);
|
||||
const <link linkend="gchar">gchar</link>* <link linkend="gimp-controller-get-event-blurb">gimp_controller_get_event_blurb</link>
|
||||
(<link linkend="GimpController">GimpController</link> *controller,
|
||||
<link linkend="gint">gint</link> event_id);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-controller-event">gimp_controller_event</link> (<link linkend="GimpController">GimpController</link> *controller,
|
||||
const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----GimpController
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpController--name">name</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
|
||||
"<link linkend="GimpController--state">state</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpController-event">event</link>" <link linkend="gboolean">gboolean</link> user_function (<link linkend="GimpController">GimpController</link> *gimpcontroller,
|
||||
<link linkend="gpointer">gpointer</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
An abstract interface for implementing arbitrary input controllers.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpControllerEventType"/>enum GimpControllerEventType</title>
|
||||
<indexterm><primary>GimpControllerEventType</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_CONTROLLER_EVENT_TRIGGER,
|
||||
GIMP_CONTROLLER_EVENT_VALUE
|
||||
} GimpControllerEventType;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpControllerEventAny"/>struct GimpControllerEventAny</title>
|
||||
<indexterm><primary>GimpControllerEventAny</primary></indexterm><programlisting>struct GimpControllerEventAny {
|
||||
|
||||
GimpControllerEventType type;
|
||||
GimpController *source;
|
||||
gint event_id;
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpControllerEventTrigger"/>struct GimpControllerEventTrigger</title>
|
||||
<indexterm><primary>GimpControllerEventTrigger</primary></indexterm><programlisting>struct GimpControllerEventTrigger {
|
||||
|
||||
GimpControllerEventType type;
|
||||
GimpController *source;
|
||||
gint event_id;
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpControllerEventValue"/>struct GimpControllerEventValue</title>
|
||||
<indexterm><primary>GimpControllerEventValue</primary></indexterm><programlisting>struct GimpControllerEventValue {
|
||||
|
||||
GimpControllerEventType type;
|
||||
GimpController *source;
|
||||
gint event_id;
|
||||
GValue value;
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpControllerEvent"/>union GimpControllerEvent</title>
|
||||
<indexterm><primary>GimpControllerEvent</primary></indexterm><programlisting>union GimpControllerEvent
|
||||
{
|
||||
GimpControllerEventType type;
|
||||
GimpControllerEventAny any;
|
||||
GimpControllerEventTrigger trigger;
|
||||
GimpControllerEventValue value;
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpController-struct"/>struct GimpController</title>
|
||||
<indexterm><primary>GimpController</primary></indexterm><programlisting>struct GimpController;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-controller-new"/>gimp_controller_new ()</title>
|
||||
<indexterm><primary>gimp_controller_new</primary></indexterm><programlisting><link linkend="GimpController">GimpController</link>* gimp_controller_new (<link linkend="GType">GType</link> controller_type);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>controller_type</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-controller-get-n-events"/>gimp_controller_get_n_events ()</title>
|
||||
<indexterm><primary>gimp_controller_get_n_events</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_controller_get_n_events (<link linkend="GimpController">GimpController</link> *controller);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>controller</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-controller-get-event-name"/>gimp_controller_get_event_name ()</title>
|
||||
<indexterm><primary>gimp_controller_get_event_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_name (<link linkend="GimpController">GimpController</link> *controller,
|
||||
<link linkend="gint">gint</link> event_id);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>controller</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>event_id</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-controller-get-event-blurb"/>gimp_controller_get_event_blurb ()</title>
|
||||
<indexterm><primary>gimp_controller_get_event_blurb</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gimp_controller_get_event_blurb
|
||||
(<link linkend="GimpController">GimpController</link> *controller,
|
||||
<link linkend="gint">gint</link> event_id);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>controller</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>event_id</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-controller-event"/>gimp_controller_event ()</title>
|
||||
<indexterm><primary>gimp_controller_event</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_controller_event (<link linkend="GimpController">GimpController</link> *controller,
|
||||
const <link linkend="GimpControllerEvent">GimpControllerEvent</link> *event);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>controller</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>event</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpController--name"/>"<literal>name</literal>" (<link linkend="gchararray">gchararray</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpController--state"/>"<literal>state</literal>" (<link linkend="gchararray">gchararray</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpController-event"/>The "event" signal</title>
|
||||
<programlisting><link linkend="gboolean">gboolean</link> user_function (<link linkend="GimpController">GimpController</link> *gimpcontroller,
|
||||
<link linkend="gpointer">gpointer</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpcontroller</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
258
devel-docs/libgimpwidgets/xml/gimpdialog.xml
Normal file
258
devel-docs/libgimpwidgets/xml/gimpdialog.xml
Normal file
@ -0,0 +1,258 @@
|
||||
<?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="GimpDialog">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpDialog</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpDialog</refname><refpurpose>Constructors for <link linkend="GtkDialog"><type>GtkDialog</type></link>'s and action_areas as well as other
|
||||
dialog-related stuff.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpDialog-struct">GimpDialog</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-dialog-new">gimp_dialog_new</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
const <link linkend="gchar">gchar</link> *role,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
...);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-dialog-new-valist">gimp_dialog_new_valist</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
const <link linkend="gchar">gchar</link> *role,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="va-list">va_list</link> args);
|
||||
<link linkend="void">void</link> <link linkend="gimp-dialog-add-buttons-valist">gimp_dialog_add_buttons_valist</link> (<link linkend="GimpDialog">GimpDialog</link> *dialog,
|
||||
<link linkend="va-list">va_list</link> args);
|
||||
<link linkend="gint">gint</link> <link linkend="gimp-dialog-run">gimp_dialog_run</link> (<link linkend="GimpDialog">GimpDialog</link> *dialog);
|
||||
<link linkend="void">void</link> <link linkend="gimp-dialogs-show-help-button">gimp_dialogs_show_help_button</link> (<link linkend="gboolean">gboolean</link> show);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkWindow">GtkWindow</link>
|
||||
+----<link linkend="GtkDialog">GtkDialog</link>
|
||||
+----GimpDialog
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpDialog implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpDialog--help-func">help-func</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
|
||||
"<link linkend="GimpDialog--help-id">help-id</link>" <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpDialog-struct"/>struct GimpDialog</title>
|
||||
<indexterm><primary>GimpDialog</primary></indexterm><programlisting>struct GimpDialog;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-dialog-new"/>gimp_dialog_new ()</title>
|
||||
<indexterm><primary>gimp_dialog_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_dialog_new (const <link linkend="gchar">gchar</link> *title,
|
||||
const <link linkend="gchar">gchar</link> *role,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
...);</programlisting>
|
||||
<para>
|
||||
Creates a new <parameter>GimpDialog</parameter> widget.
|
||||
</para>
|
||||
<para>
|
||||
This function simply packs the action_area arguments passed in "..."
|
||||
into a <parameter>va_list</parameter> variable and passes everything to <link linkend="gimp-dialog-new-valist"><function>gimp_dialog_new_valist()</function></link>.
|
||||
</para>
|
||||
<para>
|
||||
For a description of the format of the <parameter>va_list</parameter> describing the
|
||||
action_area buttons see <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The dialog's title which will be set with
|
||||
<link linkend="gtk-window-set-title"><function>gtk_window_set_title()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>role</parameter> :</term>
|
||||
<listitem><simpara> The dialog's <parameter>role</parameter> which will be set with
|
||||
<link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>parent</parameter> widget of this dialog.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>flags</parameter> (see the <link linkend="GtkDialog"><type>GtkDialog</type></link> documentation).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called if the user presses "F1".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> The help_id which will be passed to <parameter>help_func</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> destribing the
|
||||
action_area buttons.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-dialog-new-valist"/>gimp_dialog_new_valist ()</title>
|
||||
<indexterm><primary>gimp_dialog_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_dialog_new_valist (const <link linkend="gchar">gchar</link> *title,
|
||||
const <link linkend="gchar">gchar</link> *role,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GtkDialogFlags">GtkDialogFlags</link> flags,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="va-list">va_list</link> args);</programlisting>
|
||||
<para>
|
||||
Creates a new <parameter>GimpDialog</parameter> widget. If a GtkWindow is specified as
|
||||
<parameter>parent</parameter> then the dialog will be made transient for this window.
|
||||
</para>
|
||||
<para>
|
||||
For a description of the format of the <parameter>va_list</parameter> describing the
|
||||
action_area buttons see <link linkend="gtk-dialog-new-with-buttons"><function>gtk_dialog_new_with_buttons()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The dialog's title which will be set with
|
||||
<link linkend="gtk-window-set-title"><function>gtk_window_set_title()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>role</parameter> :</term>
|
||||
<listitem><simpara> The dialog's <parameter>role</parameter> which will be set with
|
||||
<link linkend="gtk-window-set-role"><function>gtk_window_set_role()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>parent</parameter> widget of this dialog or <literal>NULL</literal>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>flags</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>flags</parameter> (see the <link linkend="GtkDialog"><type>GtkDialog</type></link> documentation).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called if the user presses "F1".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> The help_id which will be passed to <parameter>help_func</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>args</parameter> :</term>
|
||||
<listitem><simpara> A <parameter>va_list</parameter> destribing the action_area buttons.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GimpDialog"><type>GimpDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-dialog-add-buttons-valist"/>gimp_dialog_add_buttons_valist ()</title>
|
||||
<indexterm><primary>gimp_dialog_add_buttons_valist</primary></indexterm><programlisting><link linkend="void">void</link> gimp_dialog_add_buttons_valist (<link linkend="GimpDialog">GimpDialog</link> *dialog,
|
||||
<link linkend="va-list">va_list</link> args);</programlisting>
|
||||
<para>
|
||||
This function is essentially the same as <link linkend="gtk-dialog-add-buttons"><function>gtk_dialog_add_buttons()</function></link>
|
||||
except it takes a va_list instead of '...'</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>dialog</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>dialog</parameter> to add buttons to.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>args</parameter> :</term>
|
||||
<listitem><simpara> The buttons as va_list.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-dialog-run"/>gimp_dialog_run ()</title>
|
||||
<indexterm><primary>gimp_dialog_run</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_dialog_run (<link linkend="GimpDialog">GimpDialog</link> *dialog);</programlisting>
|
||||
<para>
|
||||
This function does exactly the same as <link linkend="gtk-dialog-run"><function>gtk_dialog_run()</function></link> except it
|
||||
does not make the dialog modal while the <link linkend="GMainLoop"><type>GMainLoop</type></link> is running.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>dialog</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpDialog"><type>GimpDialog</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> response ID
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-dialogs-show-help-button"/>gimp_dialogs_show_help_button ()</title>
|
||||
<indexterm><primary>gimp_dialogs_show_help_button</primary></indexterm><programlisting><link linkend="void">void</link> gimp_dialogs_show_help_button (<link linkend="gboolean">gboolean</link> show);</programlisting>
|
||||
<para>
|
||||
This function is for internal use only.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>show</parameter> :</term>
|
||||
<listitem><simpara> whether a help button should be added when creating a GimpDialog
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpDialog--help-func"/>"<literal>help-func</literal>" (<link linkend="gpointer">gpointer</link> : Read / Write / Construct Only)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpDialog--help-id"/>"<literal>help-id</literal>" (<link linkend="gchararray">gchararray</link> : Read / Write / Construct Only)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
189
devel-docs/libgimpwidgets/xml/gimpfileentry.xml
Normal file
189
devel-docs/libgimpwidgets/xml/gimpfileentry.xml
Normal file
@ -0,0 +1,189 @@
|
||||
<?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="GimpFileEntry">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpFileEntry</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpFileEntry</refname><refpurpose>Widget for entering a filename.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpFileEntry-struct">GimpFileEntry</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-file-entry-new">gimp_file_entry_new</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
const <link linkend="gchar">gchar</link> *filename,
|
||||
<link linkend="gboolean">gboolean</link> dir_only,
|
||||
<link linkend="gboolean">gboolean</link> check_valid);
|
||||
<link linkend="gchar">gchar</link>* <link linkend="gimp-file-entry-get-filename">gimp_file_entry_get_filename</link> (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry);
|
||||
<link linkend="void">void</link> <link linkend="gimp-file-entry-set-filename">gimp_file_entry_set_filename</link> (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry,
|
||||
const <link linkend="gchar">gchar</link> *filename);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</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>
|
||||
+----GimpFileEntry
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpFileEntry implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpFileEntry-filename-changed">filename-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpFileEntry">GimpFileEntry</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This widget is used to enter filenames or directories.
|
||||
</para>
|
||||
<para>
|
||||
There is a <link linkend="GtkEntry"><type>GtkEntry</type></link> for entering the filename manually and a "..."
|
||||
button which will pop up a <link linkend="GtkFileSelection"><type>GtkFileSelection</type></link> dialog.
|
||||
</para>
|
||||
<para>
|
||||
You can restrict the <link linkend="GimpFileSelection"><type>GimpFileSelection</type></link> to directories. In this case
|
||||
the filename listbox of the <link linkend="GtkFileSelection"><type>GtkFileSelection</type></link> dialog will be hidden.
|
||||
</para>
|
||||
<para>
|
||||
If you specify <parameter>check_valid</parameter> as <link linkend="TRUE-CAPS"><type>TRUE</type></link> in <link linkend="gimp-file-entry-new"><function>gimp_file_entry_new()</function></link>
|
||||
the entered filename will be checked for validity and a pixmap will be
|
||||
shown which indicates if the file exists or not.
|
||||
</para>
|
||||
<para>
|
||||
Whenever the user changes the filename, the "filename_changed" signal
|
||||
will be emitted.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpFileEntry-struct"/>struct GimpFileEntry</title>
|
||||
<indexterm><primary>GimpFileEntry</primary></indexterm><programlisting>struct GimpFileEntry;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-file-entry-new"/>gimp_file_entry_new ()</title>
|
||||
<indexterm><primary>gimp_file_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_file_entry_new (const <link linkend="gchar">gchar</link> *title,
|
||||
const <link linkend="gchar">gchar</link> *filename,
|
||||
<link linkend="gboolean">gboolean</link> dir_only,
|
||||
<link linkend="gboolean">gboolean</link> check_valid);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The title of the <link linkend="GtkFileEntry"><type>GtkFileEntry</type></link> dialog.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>filename</parameter> :</term>
|
||||
<listitem><simpara> The initial filename.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>dir_only</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the file entry should accept directories only.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>check_valid</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the widget should check if the entered file
|
||||
really exists.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-file-entry-get-filename"/>gimp_file_entry_get_filename ()</title>
|
||||
<indexterm><primary>gimp_file_entry_get_filename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_file_entry_get_filename (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry);</programlisting>
|
||||
<para>
|
||||
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>entry</parameter> :</term>
|
||||
<listitem><simpara> The file entry you want to know the filename from.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The file or directory the user has entered.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-file-entry-set-filename"/>gimp_file_entry_set_filename ()</title>
|
||||
<indexterm><primary>gimp_file_entry_set_filename</primary></indexterm><programlisting><link linkend="void">void</link> gimp_file_entry_set_filename (<link linkend="GimpFileEntry">GimpFileEntry</link> *entry,
|
||||
const <link linkend="gchar">gchar</link> *filename);</programlisting>
|
||||
<para>
|
||||
If you specified <parameter>check_valid</parameter> as <literal>TRUE</literal> in <link linkend="gimp-file-entry-new"><function>gimp_file_entry_new()</function></link>
|
||||
the <link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> will immediately check the validity of the file
|
||||
name.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>entry</parameter> :</term>
|
||||
<listitem><simpara> The file entry you want to set the filename for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>filename</parameter> :</term>
|
||||
<listitem><simpara> The new filename.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpFileEntry-filename-changed"/>The "filename-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpFileEntry">GimpFileEntry</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
This signal is emitted whenever the user changes the filename.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GimpPathEditor"><type>GimpPathEditor</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
120
devel-docs/libgimpwidgets/xml/gimpframe.xml
Normal file
120
devel-docs/libgimpwidgets/xml/gimpframe.xml
Normal file
@ -0,0 +1,120 @@
|
||||
<?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="GimpFrame">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpFrame</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpFrame</refname><refpurpose>A widget providing a HIG-compliant subclass of <link linkend="GtkFrame"><type>GtkFrame</type></link>.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpFrame-struct">GimpFrame</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-frame-new">gimp_frame_new</link> (const <link linkend="gchar">gchar</link> *label);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkFrame">GtkFrame</link>
|
||||
+----GimpFrame
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpFrame implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Style Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpFrame--label-bold">label-bold</link>" <link linkend="gboolean">gboolean</link> : Read
|
||||
"<link linkend="GimpFrame--label-spacing">label-spacing</link>" <link linkend="gint">gint</link> : Read
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A widget providing a HIG-compliant subclass of <link linkend="GtkFrame"><type>GtkFrame</type></link>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpFrame-struct"/>struct GimpFrame</title>
|
||||
<indexterm><primary>GimpFrame</primary></indexterm><programlisting>struct GimpFrame;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-frame-new"/>gimp_frame_new ()</title>
|
||||
<indexterm><primary>gimp_frame_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_frame_new (const <link linkend="gchar">gchar</link> *label);</programlisting>
|
||||
<para>
|
||||
Creates a <link linkend="GimpFrame"><type>GimpFrame</type></link> widget. A <link linkend="GimpFrame"><type>GimpFrame</type></link> is a HIG-compliant
|
||||
variant of <link linkend="GtkFrame"><type>GtkFrame</type></link>. It doesn't render a frame at all but
|
||||
otherwise behaves like a frame. The frame's title is rendered in
|
||||
bold and the frame content is indented four spaces as suggested by
|
||||
the GNOME HIG (see http://developer.gnome.org/projects/gup/hig/).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>label</parameter> :</term>
|
||||
<listitem><simpara> text to set as the frame's title label (or <literal>NULL</literal> for no title)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpFrame"><type>GimpFrame</type></link> widget
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Style Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpFrame--label-bold"/>"<literal>label-bold</literal>" (<link linkend="gboolean">gboolean</link> : Read)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpFrame--label-spacing"/>"<literal>label-spacing</literal>" (<link linkend="gint">gint</link> : Read)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
217
devel-docs/libgimpwidgets/xml/gimphelpui.xml
Normal file
217
devel-docs/libgimpwidgets/xml/gimphelpui.xml
Normal file
@ -0,0 +1,217 @@
|
||||
<?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="libgimpwidgets-GimpHelpUI">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpHelpUI</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpHelpUI</refname><refpurpose>Functions for setting <link linkend="GtkTooltips"><type>GtkTooltips</type></link> and help identifier used by GIMP help
|
||||
system.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
<link linkend="void">void</link> (<link linkend="GimpHelpFunc">*GimpHelpFunc</link>) (const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="gpointer">gpointer</link> help_data);
|
||||
#define <link linkend="GIMP-HELP-ID-CAPS">GIMP_HELP_ID</link>
|
||||
<link linkend="void">void</link> <link linkend="gimp-help-enable-tooltips">gimp_help_enable_tooltips</link> (void);
|
||||
<link linkend="void">void</link> <link linkend="gimp-help-disable-tooltips">gimp_help_disable_tooltips</link> (void);
|
||||
<link linkend="void">void</link> <link linkend="gimp-standard-help-func">gimp_standard_help_func</link> (const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="gpointer">gpointer</link> help_data);
|
||||
<link linkend="void">void</link> <link linkend="gimp-help-connect">gimp_help_connect</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="gpointer">gpointer</link> help_data);
|
||||
<link linkend="void">void</link> <link linkend="gimp-help-set-help-data">gimp_help_set_help_data</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
|
||||
const <link linkend="gchar">gchar</link> *tooltip,
|
||||
const <link linkend="gchar">gchar</link> *help_id);
|
||||
<link linkend="void">void</link> <link linkend="gimp-context-help">gimp_context_help</link> (<link linkend="GtkWidget">GtkWidget</link> *widget);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpHelpFunc"/>GimpHelpFunc ()</title>
|
||||
<indexterm><primary>GimpHelpFunc</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpHelpFunc) (const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="gpointer">gpointer</link> help_data);</programlisting>
|
||||
<para>
|
||||
This is the prototype for all functions you pass as <parameter>help_func</parameter> to the
|
||||
various GIMP dialog constructors like <link linkend="gimp-dialog-new"><function>gimp_dialog_new()</function></link>,
|
||||
<link linkend="gimp-query-int-box"><function>gimp_query_int_box()</function></link> etc.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Help IDs are textual identifiers the help system uses to figure which
|
||||
page to display.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
All these dialog constructors functions call <link linkend="gimp-help-connect"><function>gimp_help_connect()</function></link>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
In most cases it will be ok to use <link linkend="gimp-standard-help-func"><function>gimp_standard_help_func()</function></link> which does
|
||||
nothing but passing the <parameter>help_id</parameter> string to <link linkend="gimp-help"><function>gimp_help()</function></link>. If your
|
||||
plug-in needs some more sophisticated help handling you can provide
|
||||
your own <parameter>help_func</parameter> which has to call <link linkend="gimp-help"><function>gimp_help()</function></link> to actually display
|
||||
the help.
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GIMP-HELP-ID-CAPS"/>GIMP_HELP_ID</title>
|
||||
<indexterm><primary>GIMP_HELP_ID</primary></indexterm><programlisting>#define GIMP_HELP_ID (gimp_help_id_quark ())
|
||||
</programlisting>
|
||||
<para>
|
||||
Since: GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-help-enable-tooltips"/>gimp_help_enable_tooltips ()</title>
|
||||
<indexterm><primary>gimp_help_enable_tooltips</primary></indexterm><programlisting><link linkend="void">void</link> gimp_help_enable_tooltips (void);</programlisting>
|
||||
<para>
|
||||
This function calls <link linkend="gtk-tooltips-enable"><function>gtk_tooltips_enable()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-help-disable-tooltips"/>gimp_help_disable_tooltips ()</title>
|
||||
<indexterm><primary>gimp_help_disable_tooltips</primary></indexterm><programlisting><link linkend="void">void</link> gimp_help_disable_tooltips (void);</programlisting>
|
||||
<para>
|
||||
This function calls <link linkend="gtk-tooltips-disable"><function>gtk_tooltips_disable()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-standard-help-func"/>gimp_standard_help_func ()</title>
|
||||
<indexterm><primary>gimp_standard_help_func</primary></indexterm><programlisting><link linkend="void">void</link> gimp_standard_help_func (const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="gpointer">gpointer</link> help_data);</programlisting>
|
||||
<para>
|
||||
This is the standard GIMP help function which does nothing but calling
|
||||
<link linkend="gimp-help"><function>gimp_help()</function></link>. It is the right function to use in almost all cases.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> A unique help identifier.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_data</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>help_data</parameter> passed to <link linkend="gimp-help-connect"><function>gimp_help_connect()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-help-connect"/>gimp_help_connect ()</title>
|
||||
<indexterm><primary>gimp_help_connect</primary></indexterm><programlisting><link linkend="void">void</link> gimp_help_connect (<link linkend="GtkWidget">GtkWidget</link> *widget,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
<link linkend="gpointer">gpointer</link> help_data);</programlisting>
|
||||
<para>
|
||||
Note that this function is automatically called by all libgimp dialog
|
||||
constructors. You only have to call it for windows/dialogs you created
|
||||
"manually".</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>widget</parameter> :</term>
|
||||
<listitem><simpara> The widget you want to connect the help accelerator for. Will
|
||||
be a <link linkend="GtkWindow"><type>GtkWindow</type></link> in most cases.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called if the user presses "F1".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>help_id</parameter> which will be passed to <parameter>help_func</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_data</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>help_data</parameter> pointer which will be passed to <parameter>help_func</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-help-set-help-data"/>gimp_help_set_help_data ()</title>
|
||||
<indexterm><primary>gimp_help_set_help_data</primary></indexterm><programlisting><link linkend="void">void</link> gimp_help_set_help_data (<link linkend="GtkWidget">GtkWidget</link> *widget,
|
||||
const <link linkend="gchar">gchar</link> *tooltip,
|
||||
const <link linkend="gchar">gchar</link> *help_id);</programlisting>
|
||||
<para>
|
||||
The reason why we don't use <link linkend="gtk-tooltips-set-tip"><function>gtk_tooltips_set_tip()</function></link> is that it's
|
||||
impossible to set a <parameter>private_tip</parameter> (aka <parameter>help_id</parameter>) without a visible
|
||||
<parameter>tooltip</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
This function can be called with <link linkend="NULL-CAPS"><type>NULL</type></link> for <parameter>tooltip</parameter>. Use this feature
|
||||
if you want to set a help link for a widget which shouldn't have
|
||||
a visible tooltip.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>widget</parameter> :</term>
|
||||
<listitem><simpara> The <link linkend="GtkWidget"><type>GtkWidget</type></link> you want to set a <parameter>tooltip</parameter> and/or <parameter>help_id</parameter> for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>tooltip</parameter> :</term>
|
||||
<listitem><simpara> The text for this widget's tooltip (or <literal>NULL</literal>).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>help_id</parameter> for the <link linkend="GtkTipsQuery"><type>GtkTipsQuery</type></link> tooltips inspector.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-context-help"/>gimp_context_help ()</title>
|
||||
<indexterm><primary>gimp_context_help</primary></indexterm><programlisting><link linkend="void">void</link> gimp_context_help (<link linkend="GtkWidget">GtkWidget</link> *widget);</programlisting>
|
||||
<para>
|
||||
This function invokes the context help inspector.
|
||||
</para>
|
||||
<para>
|
||||
The mouse cursor will turn turn into a question mark and the user can
|
||||
click on any widget of the application which started the inspector.
|
||||
</para>
|
||||
<para>
|
||||
If the widget the user clicked on has a <parameter>help_id</parameter> string attached
|
||||
(see <link linkend="gimp-help-set-help-data"><function>gimp_help_set_help_data()</function></link>), the corresponding help page will
|
||||
be displayed. Otherwise the help system will ascend the widget hierarchy
|
||||
until it finds an attached <parameter>help_id</parameter> string (which should be the
|
||||
case at least for every window/dialog).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>widget</parameter> :</term>
|
||||
<listitem><simpara> Any <link linkend="GtkWidget"><type>GtkWidget</type></link> on the screen.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
293
devel-docs/libgimpwidgets/xml/gimpintcombobox.xml
Normal file
293
devel-docs/libgimpwidgets/xml/gimpintcombobox.xml
Normal file
@ -0,0 +1,293 @@
|
||||
<?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="GimpIntComboBox">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpIntComboBox</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpIntComboBox</refname><refpurpose>A widget providing a popup menu of integer values (e.g. enums).</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpIntComboBox-struct">GimpIntComboBox</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-combo-box-new">gimp_int_combo_box_new</link> (const <link linkend="gchar">gchar</link> *first_label,
|
||||
<link linkend="gint">gint</link> first_value,
|
||||
...);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-combo-box-new-valist">gimp_int_combo_box_new_valist</link> (const <link linkend="gchar">gchar</link> *first_label,
|
||||
<link linkend="gint">gint</link> first_value,
|
||||
<link linkend="va-list">va_list</link> values);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-combo-box-new-array">gimp_int_combo_box_new_array</link> (<link linkend="gint">gint</link> n_values,
|
||||
const <link linkend="gchar">gchar</link> *labels[]);
|
||||
<link linkend="void">void</link> <link linkend="gimp-int-combo-box-prepend">gimp_int_combo_box_prepend</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
...);
|
||||
<link linkend="void">void</link> <link linkend="gimp-int-combo-box-append">gimp_int_combo_box_append</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
...);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-int-combo-box-set-active">gimp_int_combo_box_set_active</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
<link linkend="gint">gint</link> value);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-int-combo-box-get-active">gimp_int_combo_box_get_active</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
<link linkend="gint">gint</link> *value);
|
||||
<link linkend="gulong">gulong</link> <link linkend="gimp-int-combo-box-connect">gimp_int_combo_box_connect</link> (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
<link linkend="gint">gint</link> value,
|
||||
<link linkend="GCallback">GCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkComboBox">GtkComboBox</link>
|
||||
+----GimpIntComboBox
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpIntComboBox implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A widget providing a popup menu of integer values (e.g. enums).
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpIntComboBox-struct"/>struct GimpIntComboBox</title>
|
||||
<indexterm><primary>GimpIntComboBox</primary></indexterm><programlisting>struct GimpIntComboBox;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-new"/>gimp_int_combo_box_new ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_combo_box_new (const <link linkend="gchar">gchar</link> *first_label,
|
||||
<link linkend="gint">gint</link> first_value,
|
||||
...);</programlisting>
|
||||
<para>
|
||||
Creates a GtkComboBox that has integer values associated with each
|
||||
item. The items to fill the combo box with are specified as a <literal>NULL</literal>
|
||||
terminated list of label/value pairs.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>first_label</parameter> :</term>
|
||||
<listitem><simpara> the label of the first item
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>first_value</parameter> :</term>
|
||||
<listitem><simpara> the value of the first item
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> a <literal>NULL</literal> terminated list of more label, value pairs
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-new-valist"/>gimp_int_combo_box_new_valist ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_new_valist</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_combo_box_new_valist (const <link linkend="gchar">gchar</link> *first_label,
|
||||
<link linkend="gint">gint</link> first_value,
|
||||
<link linkend="va-list">va_list</link> values);</programlisting>
|
||||
<para>
|
||||
A variant of <link linkend="gimp-int-combo-box-new"><function>gimp_int_combo_box_new()</function></link> that takes a va_list of
|
||||
label/value pairs. Probably only useful for language bindings.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>first_label</parameter> :</term>
|
||||
<listitem><simpara> the label of the first item
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>first_value</parameter> :</term>
|
||||
<listitem><simpara> the value of the first item
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>values</parameter> :</term>
|
||||
<listitem><simpara> a va_list with more values
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-new-array"/>gimp_int_combo_box_new_array ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_new_array</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_combo_box_new_array (<link linkend="gint">gint</link> n_values,
|
||||
const <link linkend="gchar">gchar</link> *labels[]);</programlisting>
|
||||
<para>
|
||||
A variant of <link linkend="gimp-int-combo-box-new"><function>gimp_int_combo_box_new()</function></link> that takes an array of labels.
|
||||
The array indices are used as values.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>n_values</parameter> :</term>
|
||||
<listitem><simpara> the number of values
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>labels</parameter> :</term>
|
||||
<listitem><simpara> an array of labels (array length must be <parameter>n_values</parameter>)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-prepend"/>gimp_int_combo_box_prepend ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_prepend</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_combo_box_prepend (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
...);</programlisting>
|
||||
<para>
|
||||
This function provides a convenient way to prepend items to a
|
||||
<link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>. It prepends a row to the <parameter>combo_box</parameter>'s list store
|
||||
and calls <link linkend="gtk-list-store-set"><function>gtk_list_store_set()</function></link> for you.
|
||||
</para>
|
||||
<para>
|
||||
The column number must be taken from the enum <link linkend="GimpIntStoreColumns"><type>GimpIntStoreColumns</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>combo_box</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> pairs of column number and value, terminated with -1
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-append"/>gimp_int_combo_box_append ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_append</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_combo_box_append (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
...);</programlisting>
|
||||
<para>
|
||||
This function provides a convenient way to append items to a
|
||||
<link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>. It appends a row to the <parameter>combo_box</parameter>'s list store
|
||||
and calls <link linkend="gtk-list-store-set"><function>gtk_list_store_set()</function></link> for you.
|
||||
</para>
|
||||
<para>
|
||||
The column number must be taken from the enum <link linkend="GimpIntStoreColumns"><type>GimpIntStoreColumns</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>combo_box</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> pairs of column number and value, terminated with -1
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-set-active"/>gimp_int_combo_box_set_active ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_set_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_int_combo_box_set_active (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
<link linkend="gint">gint</link> value);</programlisting>
|
||||
<para>
|
||||
Looks up the item that belongs to the given <parameter>value</parameter> and makes it the
|
||||
selected item in the <parameter>combo_box</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>combo_box</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> an integer value
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> on success or <literal>FALSE</literal> if there was no item for
|
||||
this value.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-get-active"/>gimp_int_combo_box_get_active ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_get_active</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_int_combo_box_get_active (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
<link linkend="gint">gint</link> *value);</programlisting>
|
||||
<para>
|
||||
Retrieves the value of the selected (active) item in the <parameter>combo_box</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>combo_box</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> return location for the integer value
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if <parameter>value</parameter> has been set or <literal>FALSE</literal> if no item was
|
||||
active.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-combo-box-connect"/>gimp_int_combo_box_connect ()</title>
|
||||
<indexterm><primary>gimp_int_combo_box_connect</primary></indexterm><programlisting><link linkend="gulong">gulong</link> gimp_int_combo_box_connect (<link linkend="GimpIntComboBox">GimpIntComboBox</link> *combo_box,
|
||||
<link linkend="gint">gint</link> value,
|
||||
<link linkend="GCallback">GCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
A convenience function that sets the inital <parameter>value</parameter> of a
|
||||
<link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> and connects <parameter>callback</parameter> to the "changed"
|
||||
signal.
|
||||
</para>
|
||||
<para>
|
||||
This function also calls the <parameter>callback</parameter> once after setting the
|
||||
initial <parameter>value</parameter>. This is often convenient when working with combo
|
||||
boxes that select a default active item (like for example
|
||||
gimp_drawable_combo_box_new). If you pass an invalid initial
|
||||
<parameter>value</parameter>, the <parameter>callback</parameter> will be called with the default item active.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>combo_box</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> the value to set
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> a callback to connect to the <parameter>combo_box</parameter>'s "changed" signal
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> a pointer passed as data to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the signal handler ID as returned by <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
133
devel-docs/libgimpwidgets/xml/gimpintstore.xml
Normal file
133
devel-docs/libgimpwidgets/xml/gimpintstore.xml
Normal file
@ -0,0 +1,133 @@
|
||||
<?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="GimpIntStore">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpIntStore</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpIntStore</refname><refpurpose>A model for integer based name-value pairs (e.g. enums)</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpIntStore-struct">GimpIntStore</link>;
|
||||
enum <link linkend="GimpIntStoreColumns">GimpIntStoreColumns</link>;
|
||||
<link linkend="GtkListStore">GtkListStore</link>* <link linkend="gimp-int-store-new">gimp_int_store_new</link> (void);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-int-store-lookup-by-value">gimp_int_store_lookup_by_value</link> (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
|
||||
<link linkend="gint">gint</link> value,
|
||||
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkListStore">GtkListStore</link>
|
||||
+----GimpIntStore
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpIntStore implements
|
||||
<link linkend="GtkTreeModel">GtkTreeModel</link>, <link linkend="GtkTreeDragSource">GtkTreeDragSource</link>, <link linkend="GtkTreeDragDest">GtkTreeDragDest</link> and <link linkend="GtkTreeSortable">GtkTreeSortable</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A model for integer based name-value pairs (e.g. enums)
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpIntStore-struct"/>struct GimpIntStore</title>
|
||||
<indexterm><primary>GimpIntStore</primary></indexterm><programlisting>struct GimpIntStore;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpIntStoreColumns"/>enum GimpIntStoreColumns</title>
|
||||
<indexterm><primary>GimpIntStoreColumns</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_INT_STORE_VALUE,
|
||||
GIMP_INT_STORE_LABEL,
|
||||
GIMP_INT_STORE_STOCK_ID,
|
||||
GIMP_INT_STORE_PIXBUF,
|
||||
GIMP_INT_STORE_USER_DATA,
|
||||
GIMP_INT_STORE_NUM_COLUMNS
|
||||
} GimpIntStoreColumns;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-store-new"/>gimp_int_store_new ()</title>
|
||||
<indexterm><primary>gimp_int_store_new</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link>* gimp_int_store_new (void);</programlisting>
|
||||
<para>
|
||||
Creates a <link linkend="GtkListStore"><type>GtkListStore</type></link> with a number of useful columns.
|
||||
<link linkend="GimpIntStore"><type>GimpIntStore</type></link> is especially useful if the items you want to store
|
||||
are identified using an integer value.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpIntStore"><type>GimpIntStore</type></link>.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-store-lookup-by-value"/>gimp_int_store_lookup_by_value ()</title>
|
||||
<indexterm><primary>gimp_int_store_lookup_by_value</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_int_store_lookup_by_value (<link linkend="GtkTreeModel">GtkTreeModel</link> *model,
|
||||
<link linkend="gint">gint</link> value,
|
||||
<link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
|
||||
<para>
|
||||
Iterate over the <parameter>model</parameter> looking for <parameter>value</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>model</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpIntStore"><type>GimpIntStore</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> an integer value to lookup in the <parameter>model</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>iter</parameter> :</term>
|
||||
<listitem><simpara> return location for the iter of the given <parameter>value</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the value has been located and <parameter>iter</parameter> is
|
||||
valid, <literal>FALSE</literal> otherwise.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
164
devel-docs/libgimpwidgets/xml/gimpmemsizeentry.xml
Normal file
164
devel-docs/libgimpwidgets/xml/gimpmemsizeentry.xml
Normal file
@ -0,0 +1,164 @@
|
||||
<?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="GimpMemsizeEntry">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpMemsizeEntry</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpMemsizeEntry</refname><refpurpose>A composite widget that allows to enter a memory size.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpMemsizeEntry-struct">GimpMemsizeEntry</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-memsize-entry-new">gimp_memsize_entry_new</link> (<link linkend="guint64">guint64</link> value,
|
||||
<link linkend="guint64">guint64</link> lower,
|
||||
<link linkend="guint64">guint64</link> upper);
|
||||
<link linkend="void">void</link> <link linkend="gimp-memsize-entry-set-value">gimp_memsize_entry_set_value</link> (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry,
|
||||
<link linkend="guint64">guint64</link> value);
|
||||
<link linkend="guint64">guint64</link> <link linkend="gimp-memsize-entry-get-value">gimp_memsize_entry_get_value</link> (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</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>
|
||||
+----GimpMemsizeEntry
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpMemsizeEntry implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpMemsizeEntry-value-changed">value-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *gimpmemsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Similar to a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> but instead of lengths, this widget is used to let
|
||||
the user enter memory sizes. An option menu allows to switch between
|
||||
Kilobytes, Megabytes and Gigabytes. Used in the GIMP preferences dialog.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpMemsizeEntry-struct"/>struct GimpMemsizeEntry</title>
|
||||
<indexterm><primary>GimpMemsizeEntry</primary></indexterm><programlisting>struct GimpMemsizeEntry;</programlisting>
|
||||
<para>
|
||||
The <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> struct is considered private.
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-memsize-entry-new"/>gimp_memsize_entry_new ()</title>
|
||||
<indexterm><primary>gimp_memsize_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_memsize_entry_new (<link linkend="guint64">guint64</link> value,
|
||||
<link linkend="guint64">guint64</link> lower,
|
||||
<link linkend="guint64">guint64</link> upper);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> which is a <link linkend="GtkHBox"><type>GtkHBox</type></link> with a <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>
|
||||
and a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> all setup to allow the user to enter memory sizes.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> the initial value (in Bytes)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> the lower limit for the value (in Bytes)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> the upper limit for the value (in Bytes)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-memsize-entry-set-value"/>gimp_memsize_entry_set_value ()</title>
|
||||
<indexterm><primary>gimp_memsize_entry_set_value</primary></indexterm><programlisting><link linkend="void">void</link> gimp_memsize_entry_set_value (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry,
|
||||
<link linkend="guint64">guint64</link> value);</programlisting>
|
||||
<para>
|
||||
Sets the <parameter>entry</parameter>'s value. Please note that the <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> rounds
|
||||
the value to full Kilobytes.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>entry</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> the new value (in Bytes)
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-memsize-entry-get-value"/>gimp_memsize_entry_get_value ()</title>
|
||||
<indexterm><primary>gimp_memsize_entry_get_value</primary></indexterm><programlisting><link linkend="guint64">guint64</link> gimp_memsize_entry_get_value (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry);</programlisting>
|
||||
<para>
|
||||
Retrieves the current value from a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>entry</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current value of <parameter>entry</parameter> (in Bytes).
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpMemsizeEntry-value-changed"/>The "value-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *gimpmemsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpmemsizeentry</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
201
devel-docs/libgimpwidgets/xml/gimpoffsetarea.xml
Normal file
201
devel-docs/libgimpwidgets/xml/gimpoffsetarea.xml
Normal file
@ -0,0 +1,201 @@
|
||||
<?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="GimpOffsetArea">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpOffsetArea</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpOffsetArea</refname><refpurpose>Widget to control image offsets.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpOffsetArea-struct">GimpOffsetArea</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-offset-area-new">gimp_offset_area_new</link> (<link linkend="gint">gint</link> orig_width,
|
||||
<link linkend="gint">gint</link> orig_height);
|
||||
<link linkend="void">void</link> <link linkend="gimp-offset-area-set-size">gimp_offset_area_set_size</link> (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height);
|
||||
<link linkend="void">void</link> <link linkend="gimp-offset-area-set-offsets">gimp_offset_area_set_offsets</link> (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
|
||||
<link linkend="gint">gint</link> offset_x,
|
||||
<link linkend="gint">gint</link> offset_y);
|
||||
<link linkend="void">void</link> <link linkend="gimp-offset-area-set-pixbuf">gimp_offset_area_set_pixbuf</link> (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
|
||||
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkDrawingArea">GtkDrawingArea</link>
|
||||
+----GimpOffsetArea
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpOffsetArea implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpOffsetArea-offsets-changed">offsets-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *gimpoffsetarea,
|
||||
<link linkend="gint">gint</link> arg1,
|
||||
<link linkend="gint">gint</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpOffsetArea-struct"/>struct GimpOffsetArea</title>
|
||||
<indexterm><primary>GimpOffsetArea</primary></indexterm><programlisting>struct GimpOffsetArea;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-offset-area-new"/>gimp_offset_area_new ()</title>
|
||||
<indexterm><primary>gimp_offset_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_offset_area_new (<link linkend="gint">gint</link> orig_width,
|
||||
<link linkend="gint">gint</link> orig_height);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link> widget. A <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link> can be used
|
||||
when resizing an image or a drawable to allow the user to interactively
|
||||
specify the new offsets.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>orig_width</parameter> :</term>
|
||||
<listitem><simpara> the original width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>orig_height</parameter> :</term>
|
||||
<listitem><simpara> the original height
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-offset-area-set-size"/>gimp_offset_area_set_size ()</title>
|
||||
<indexterm><primary>gimp_offset_area_set_size</primary></indexterm><programlisting><link linkend="void">void</link> gimp_offset_area_set_size (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height);</programlisting>
|
||||
<para>
|
||||
Sets the size of the image/drawable displayed by the <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
|
||||
If the offsets change as a result of this change, the <literal>offsets_changed</literal>
|
||||
signal is emitted.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>offset_area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> the new width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> the new height
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-offset-area-set-offsets"/>gimp_offset_area_set_offsets ()</title>
|
||||
<indexterm><primary>gimp_offset_area_set_offsets</primary></indexterm><programlisting><link linkend="void">void</link> gimp_offset_area_set_offsets (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
|
||||
<link linkend="gint">gint</link> offset_x,
|
||||
<link linkend="gint">gint</link> offset_y);</programlisting>
|
||||
<para>
|
||||
Sets the offsets of the image/drawable displayed by the <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
|
||||
It does not emit the <literal>offsets_changed</literal> signal.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>offset_area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>offset_x</parameter> :</term>
|
||||
<listitem><simpara> the X offset
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>offset_y</parameter> :</term>
|
||||
<listitem><simpara> the Y offset
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-offset-area-set-pixbuf"/>gimp_offset_area_set_pixbuf ()</title>
|
||||
<indexterm><primary>gimp_offset_area_set_pixbuf</primary></indexterm><programlisting><link linkend="void">void</link> gimp_offset_area_set_pixbuf (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *offset_area,
|
||||
<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
|
||||
<para>
|
||||
Sets the pixbuf which represents the original image/drawable which
|
||||
is being offset.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>offset_area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpOffsetArea"><type>GimpOffsetArea</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>pixbuf</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpOffsetArea-offsets-changed"/>The "offsets-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpOffsetArea">GimpOffsetArea</link> *gimpoffsetarea,
|
||||
<link linkend="gint">gint</link> arg1,
|
||||
<link linkend="gint">gint</link> arg2,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpoffsetarea</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg2</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
329
devel-docs/libgimpwidgets/xml/gimpoldwidgets.xml
Normal file
329
devel-docs/libgimpwidgets/xml/gimpoldwidgets.xml
Normal file
@ -0,0 +1,329 @@
|
||||
<?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="libgimpwidgets-gimpoldwidgets">
|
||||
<refmeta>
|
||||
<refentrytitle>gimpoldwidgets</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>gimpoldwidgets</refname><refpurpose>Old API that is still available but declared as deprecated.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-int-option-menu-new">gimp_int_option_menu_new</link> (<link linkend="gboolean">gboolean</link> menu_only,
|
||||
<link linkend="GCallback">GCallback</link> menu_item_callback,
|
||||
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
|
||||
<link linkend="gint">gint</link> initial,
|
||||
...);
|
||||
<link linkend="void">void</link> <link linkend="gimp-int-option-menu-set-history">gimp_int_option_menu_set_history</link>
|
||||
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="gint">gint</link> item_data);
|
||||
<link linkend="gboolean">gboolean</link> (<link linkend="GimpIntOptionMenuSensitivityCallback">*GimpIntOptionMenuSensitivityCallback</link>)
|
||||
(<link linkend="gint">gint</link> item_data,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);
|
||||
<link linkend="void">void</link> <link linkend="gimp-int-option-menu-set-sensitive">gimp_int_option_menu_set_sensitive</link>
|
||||
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-option-menu-new">gimp_option_menu_new</link> (<link linkend="gboolean">gboolean</link> menu_only,
|
||||
...);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-option-menu-new2">gimp_option_menu_new2</link> (<link linkend="gboolean">gboolean</link> menu_only,
|
||||
<link linkend="GCallback">GCallback</link> menu_item_callback,
|
||||
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
|
||||
<link linkend="gpointer">gpointer</link> initial,
|
||||
...);
|
||||
<link linkend="void">void</link> <link linkend="gimp-option-menu-set-history">gimp_option_menu_set_history</link> (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="gpointer">gpointer</link> item_data);
|
||||
<link linkend="gboolean">gboolean</link> (<link linkend="GimpOptionMenuSensitivityCallback">*GimpOptionMenuSensitivityCallback</link>)
|
||||
(<link linkend="gpointer">gpointer</link> item_data,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);
|
||||
<link linkend="void">void</link> <link linkend="gimp-option-menu-set-sensitive">gimp_option_menu_set_sensitive</link> (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);
|
||||
<link linkend="void">void</link> <link linkend="gimp-menu-item-update">gimp_menu_item_update</link> (<link linkend="GtkWidget">GtkWidget</link> *widget,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
These functions are not defined if you <link linkend="define"><type>define</type></link> GIMP_DISABLE_DEPRECATED.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-option-menu-new"/>gimp_int_option_menu_new ()</title>
|
||||
<indexterm><primary>gimp_int_option_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_int_option_menu_new (<link linkend="gboolean">gboolean</link> menu_only,
|
||||
<link linkend="GCallback">GCallback</link> menu_item_callback,
|
||||
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
|
||||
<link linkend="gint">gint</link> initial,
|
||||
...);</programlisting>
|
||||
<warning><para><literal>gimp_int_option_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>. This
|
||||
function does the same thing as the deprecated function
|
||||
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>, but it takes integers as <parameter>item_data</parameter>
|
||||
instead of pointers, since that is a very common case (mapping an
|
||||
enum to a menu).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu_only</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>menu_item_callback</parameter> :</term>
|
||||
<listitem><simpara> The callback each menu item's "activate" signal will
|
||||
be connected with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>menu_item_callback_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
The data which will be passed to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>item_data</parameter> of the initially selected menu item.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> describing the menu items.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link> (depending on <parameter>menu_only</parameter>).
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-option-menu-set-history"/>gimp_int_option_menu_set_history ()</title>
|
||||
<indexterm><primary>gimp_int_option_menu_set_history</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_option_menu_set_history
|
||||
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="gint">gint</link> item_data);</programlisting>
|
||||
<warning><para><literal>gimp_int_option_menu_set_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Iterates over all entries in a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> and selects the one with the
|
||||
matching <parameter>item_data</parameter>. Probably only makes sense to use with a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link>
|
||||
that was created using <link linkend="gimp-int-option-menu-new"><function>gimp_int_option_menu_new()</function></link>. This function does the
|
||||
same thing as <link linkend="gimp-option-menu-set-history"><function>gimp_option_menu_set_history()</function></link>, but takes integers as
|
||||
<parameter>item_data</parameter> instead of pointers.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>option_menu</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-int-option-menu-new"><function>gimp_int_option_menu_new()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>item_data</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>item_data</parameter> of the menu item you want to select.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpIntOptionMenuSensitivityCallback"/>GimpIntOptionMenuSensitivityCallback ()</title>
|
||||
<indexterm><primary>GimpIntOptionMenuSensitivityCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpIntOptionMenuSensitivityCallback)
|
||||
(<link linkend="gint">gint</link> item_data,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
|
||||
<warning><para><literal>GimpIntOptionMenuSensitivityCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>item_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-int-option-menu-set-sensitive"/>gimp_int_option_menu_set_sensitive ()</title>
|
||||
<indexterm><primary>gimp_int_option_menu_set_sensitive</primary></indexterm><programlisting><link linkend="void">void</link> gimp_int_option_menu_set_sensitive
|
||||
(<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="GimpIntOptionMenuSensitivityCallback">GimpIntOptionMenuSensitivityCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
|
||||
<warning><para><literal>gimp_int_option_menu_set_sensitive</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Calls the given <parameter>callback</parameter> for each item in the menu and passes it the
|
||||
item_data and the <parameter>callback_data</parameter>. The menu item's sensitivity is set
|
||||
according to the return value of this function. This function does the
|
||||
same thing as <link linkend="gimp-option-menu-set-sensitive"><function>gimp_option_menu_set_sensitive()</function></link>, but takes integers as
|
||||
<parameter>item_data</parameter> instead of pointers.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>option_menu</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
|
||||
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> a function called for each item in the menu to determine the
|
||||
the sensitivity state.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback_data</parameter> :</term>
|
||||
<listitem><simpara> data to pass to the <parameter>callback</parameter> function.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-option-menu-new"/>gimp_option_menu_new ()</title>
|
||||
<indexterm><primary>gimp_option_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_option_menu_new (<link linkend="gboolean">gboolean</link> menu_only,
|
||||
...);</programlisting>
|
||||
<warning><para><literal>gimp_option_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu_only</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> describing the menu items.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link> (depending on <parameter>menu_only</parameter>).
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-option-menu-new2"/>gimp_option_menu_new2 ()</title>
|
||||
<indexterm><primary>gimp_option_menu_new2</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_option_menu_new2 (<link linkend="gboolean">gboolean</link> menu_only,
|
||||
<link linkend="GCallback">GCallback</link> menu_item_callback,
|
||||
<link linkend="gpointer">gpointer</link> menu_item_callback_data,
|
||||
<link linkend="gpointer">gpointer</link> initial,
|
||||
...);</programlisting>
|
||||
<warning><para><literal>gimp_option_menu_new2</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Convenience function to create a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu_only</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the function should return a <link linkend="GtkMenu"><type>GtkMenu</type></link> only.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>menu_item_callback</parameter> :</term>
|
||||
<listitem><simpara> The callback each menu item's "activate" signal will
|
||||
be connected with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>menu_item_callback_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
The data which will be passed to <link linkend="g-signal-connect"><function>g_signal_connect()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>item_data</parameter> of the initially selected menu item.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>...</parameter> :</term>
|
||||
<listitem><simpara> A <literal>NULL</literal>-terminated <parameter>va_list</parameter> describing the menu items.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> or a <link linkend="GtkMenu"><type>GtkMenu</type></link> (depending on <parameter>menu_only</parameter>).
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-option-menu-set-history"/>gimp_option_menu_set_history ()</title>
|
||||
<indexterm><primary>gimp_option_menu_set_history</primary></indexterm><programlisting><link linkend="void">void</link> gimp_option_menu_set_history (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="gpointer">gpointer</link> item_data);</programlisting>
|
||||
<warning><para><literal>gimp_option_menu_set_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Iterates over all entries in a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> and selects the one
|
||||
with the matching <parameter>item_data</parameter>. Probably only makes sense to use with
|
||||
a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> that was created using <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
|
||||
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>option_menu</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
|
||||
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>item_data</parameter> :</term>
|
||||
<listitem><simpara> The <parameter>item_data</parameter> of the menu item you want to select.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpOptionMenuSensitivityCallback"/>GimpOptionMenuSensitivityCallback ()</title>
|
||||
<indexterm><primary>GimpOptionMenuSensitivityCallback</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpOptionMenuSensitivityCallback)
|
||||
(<link linkend="gpointer">gpointer</link> item_data,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
|
||||
<warning><para><literal>GimpOptionMenuSensitivityCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>item_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback_data</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-option-menu-set-sensitive"/>gimp_option_menu_set_sensitive ()</title>
|
||||
<indexterm><primary>gimp_option_menu_set_sensitive</primary></indexterm><programlisting><link linkend="void">void</link> gimp_option_menu_set_sensitive (<link linkend="GtkOptionMenu">GtkOptionMenu</link> *option_menu,
|
||||
<link linkend="GimpOptionMenuSensitivityCallback">GimpOptionMenuSensitivityCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> callback_data);</programlisting>
|
||||
<warning><para><literal>gimp_option_menu_set_sensitive</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Calls the given <parameter>callback</parameter> for each item in the menu and passes it the
|
||||
item_data and the <parameter>callback_data</parameter>. The menu item's sensitivity is set
|
||||
according to the return value of this function.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>option_menu</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> as returned by <link linkend="gimp-option-menu-new"><function>gimp_option_menu_new()</function></link> or
|
||||
<link linkend="gimp-option-menu-new2"><function>gimp_option_menu_new2()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> a function called for each item in the menu to determine the
|
||||
the sensitivity state.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback_data</parameter> :</term>
|
||||
<listitem><simpara> data to pass to the <parameter>callback</parameter> function.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-menu-item-update"/>gimp_menu_item_update ()</title>
|
||||
<indexterm><primary>gimp_menu_item_update</primary></indexterm><programlisting><link linkend="void">void</link> gimp_menu_item_update (<link linkend="GtkWidget">GtkWidget</link> *widget,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<warning><para><literal>gimp_menu_item_update</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>widget</parameter> :</term>
|
||||
<listitem><simpara> A <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> A pointer to a <link linkend="gint"><type>gint</type></link> variable which will store the value of
|
||||
GPOINTER_TO_INT (g_object_get_data (<parameter>widget</parameter>, "gimp-item-data")).
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
GimpIntComboBox
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
285
devel-docs/libgimpwidgets/xml/gimppatheditor.xml
Normal file
285
devel-docs/libgimpwidgets/xml/gimppatheditor.xml
Normal file
@ -0,0 +1,285 @@
|
||||
<?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="GimpPathEditor">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpPathEditor</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpPathEditor</refname><refpurpose>Widget for editing a file search path.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpPathEditor-struct">GimpPathEditor</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-path-editor-new">gimp_path_editor_new</link> (const <link linkend="gchar">gchar</link> *filesel_title,
|
||||
const <link linkend="gchar">gchar</link> *path);
|
||||
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-editor-get-path">gimp_path_editor_get_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
|
||||
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-path">gimp_path_editor_set_path</link> (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *path);
|
||||
<link linkend="gchar">gchar</link>* <link linkend="gimp-path-editor-get-writable-path">gimp_path_editor_get_writable_path</link>
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);
|
||||
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-writable-path">gimp_path_editor_set_writable_path</link>
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *path);
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-path-editor-get-dir-writable">gimp_path_editor_get_dir_writable</link>
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *directory);
|
||||
<link linkend="void">void</link> <link linkend="gimp-path-editor-set-dir-writable">gimp_path_editor_set_dir_writable</link>
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *directory,
|
||||
<link linkend="gboolean">gboolean</link> writable);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----GimpPathEditor
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpPathEditor implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpPathEditor-path-changed">path-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpPathEditor-writable-changed">writable-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This widget is used to edit file search paths.
|
||||
</para>
|
||||
<para>
|
||||
It shows a list of all directories which are in the search path. You
|
||||
can click a directory to select it. The widget provides a
|
||||
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link> to change the currently selected directory.
|
||||
</para>
|
||||
<para>
|
||||
There are buttons to add or delete directories as well as "up" and "down"
|
||||
buttons to change the order in which the directories will be searched.
|
||||
</para>
|
||||
<para>
|
||||
Whenever the user adds, deletes, changes or reorders a directory of
|
||||
the search path, the "path_changed" signal will be emitted.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPathEditor-struct"/>struct GimpPathEditor</title>
|
||||
<indexterm><primary>GimpPathEditor</primary></indexterm><programlisting>struct GimpPathEditor;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-new"/>gimp_path_editor_new ()</title>
|
||||
<indexterm><primary>gimp_path_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_path_editor_new (const <link linkend="gchar">gchar</link> *filesel_title,
|
||||
const <link linkend="gchar">gchar</link> *path);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
|
||||
</para>
|
||||
<para>
|
||||
The elements of the initial search path must be separated with the
|
||||
<link linkend="G-SEARCHPATH-SEPARATOR-CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>filesel_title</parameter> :</term>
|
||||
<listitem><simpara> The title of the <link linkend="GtkFileSelection"><type>GtkFileSelection</type></link> dialog which can be
|
||||
popped up by the attached <link linkend="GimpFileSelection"><type>GimpFileSelection</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara> The initial search path.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpPathEditor"><type>GimpPathEditor</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-get-path"/>gimp_path_editor_get_path ()</title>
|
||||
<indexterm><primary>gimp_path_editor_get_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_editor_get_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
|
||||
<para>
|
||||
The elements of the returned search path string are separated with the
|
||||
<link linkend="G-SEARCHPATH-SEPARATOR-CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.
|
||||
</para>
|
||||
<para>
|
||||
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>editor</parameter> :</term>
|
||||
<listitem><simpara> The path editor you want to get the search path from.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The search path the user has selected in the path editor.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-set-path"/>gimp_path_editor_set_path ()</title>
|
||||
<indexterm><primary>gimp_path_editor_set_path</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_path (<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *path);</programlisting>
|
||||
<para>
|
||||
The elements of the initial search path must be separated with the
|
||||
<link linkend="G-SEARCHPATH-SEPARATOR-CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link> character.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>editor</parameter> :</term>
|
||||
<listitem><simpara> The path editor you want to set the search path from.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara> The new path to set.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-get-writable-path"/>gimp_path_editor_get_writable_path ()</title>
|
||||
<indexterm><primary>gimp_path_editor_get_writable_path</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_path_editor_get_writable_path
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>editor</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-set-writable-path"/>gimp_path_editor_set_writable_path ()</title>
|
||||
<indexterm><primary>gimp_path_editor_set_writable_path</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_writable_path
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *path);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>editor</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>path</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-get-dir-writable"/>gimp_path_editor_get_dir_writable ()</title>
|
||||
<indexterm><primary>gimp_path_editor_get_dir_writable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_path_editor_get_dir_writable
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *directory);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>editor</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>directory</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-path-editor-set-dir-writable"/>gimp_path_editor_set_dir_writable ()</title>
|
||||
<indexterm><primary>gimp_path_editor_set_dir_writable</primary></indexterm><programlisting><link linkend="void">void</link> gimp_path_editor_set_dir_writable
|
||||
(<link linkend="GimpPathEditor">GimpPathEditor</link> *editor,
|
||||
const <link linkend="gchar">gchar</link> *directory,
|
||||
<link linkend="gboolean">gboolean</link> writable);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>editor</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>directory</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>writable</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpPathEditor-path-changed"/>The "path-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
This signal is emitted whenever the user adds, deletes, modifies
|
||||
or reorders an element of the search path.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2><refsect2><title><anchor id="GimpPathEditor-writable-changed"/>The "writable-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPathEditor">GimpPathEditor</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
This signal is emitted whenever the "writable" column of a directory
|
||||
is changed, either by the user clicking on it or by calling
|
||||
<link linkend="gimp-path-editor-set-dir-writable"><function>gimp_path_editor_set_dir_writable()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GimpFileEntry"><type>GimpFileEntry</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="G-SEARCHPATH-SEPARATOR-CAPS"><type>G_SEARCHPATH_SEPARATOR</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
121
devel-docs/libgimpwidgets/xml/gimppickbutton.xml
Normal file
121
devel-docs/libgimpwidgets/xml/gimppickbutton.xml
Normal file
@ -0,0 +1,121 @@
|
||||
<?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="GimpPickButton">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpPickButton</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpPickButton</refname><refpurpose>Widget to pick a color from screen.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpPickButton-struct">GimpPickButton</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-pick-button-new">gimp_pick_button_new</link> (void);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkButton">GtkButton</link>
|
||||
+----GimpPickButton
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpPickButton implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpPickButton-color-picked">color-picked</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpPickButton">GimpPickButton</link> *gimppickbutton,
|
||||
<link linkend="gpointer">gpointer</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
<link linkend="GimpPickButton"><type>GimpPickButton</type></link> is a specialized button. When clicked, it changes the
|
||||
cursor to a color-picker pipette and allows the user to pick a color
|
||||
from any point on the screen.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPickButton-struct"/>struct GimpPickButton</title>
|
||||
<indexterm><primary>GimpPickButton</primary></indexterm><programlisting>struct GimpPickButton;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-pick-button-new"/>gimp_pick_button_new ()</title>
|
||||
<indexterm><primary>gimp_pick_button_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_pick_button_new (void);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpPickButton"><type>GimpPickButton</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GimpPickButton"><type>GimpPickButton</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpPickButton-color-picked"/>The "color-picked" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPickButton">GimpPickButton</link> *gimppickbutton,
|
||||
<link linkend="gpointer">gpointer</link> arg1,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimppickbutton</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>arg1</parameter> :</term>
|
||||
<listitem><simpara>pointer to a <link linkend="GimpRGB"><type>GimpRGB</type></link> structure that holds the picked color
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
130
devel-docs/libgimpwidgets/xml/gimppixmap.xml
Normal file
130
devel-docs/libgimpwidgets/xml/gimppixmap.xml
Normal file
@ -0,0 +1,130 @@
|
||||
<?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="GimpPixmap">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpPixmap</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpPixmap</refname><refpurpose>Widget which creates a <link linkend="GtkPixmap"><type>GtkPixmap</type></link> from XPM data.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpPixmap-struct">GimpPixmap</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-pixmap-new">gimp_pixmap_new</link> (<link linkend="gchar">gchar</link> **xpm_data);
|
||||
<link linkend="void">void</link> <link linkend="gimp-pixmap-set">gimp_pixmap_set</link> (<link linkend="GimpPixmap">GimpPixmap</link> *pixmap,
|
||||
<link linkend="gchar">gchar</link> **xpm_data);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkMisc">GtkMisc</link>
|
||||
+----<link linkend="GtkImage">GtkImage</link>
|
||||
+----GimpPixmap
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpPixmap implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
Widget which creates a <link linkend="GtkPixmap"><type>GtkPixmap</type></link> from XPM data.
|
||||
</para>
|
||||
<para>
|
||||
Use this widget instead of <link linkend="GtkPixmap"><type>GtkPixmap</type></link> if you don't want to worry about
|
||||
the parent container's "realized" state.
|
||||
</para>
|
||||
<para>
|
||||
Note that the drawback of the easy interface is that the actual <link linkend="GdkPixmap"><type>GdkPixmap</type></link>
|
||||
and it's mask have to be constructed every time you call <link linkend="gimp-pixmap-new"><function>gimp_pixmap_new()</function></link>
|
||||
and cannot be cached in memory without doing bad hacks.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPixmap-struct"/>struct GimpPixmap</title>
|
||||
<indexterm><primary>GimpPixmap</primary></indexterm><programlisting>struct GimpPixmap;</programlisting>
|
||||
<warning><para><literal>GimpPixmap</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-pixmap-new"/>gimp_pixmap_new ()</title>
|
||||
<indexterm><primary>gimp_pixmap_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_pixmap_new (<link linkend="gchar">gchar</link> **xpm_data);</programlisting>
|
||||
<warning><para><literal>gimp_pixmap_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpPixmap"><type>GimpPixmap</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>xpm_data</parameter> :</term>
|
||||
<listitem><simpara> A pointer to a XPM data structure as found in XPM files.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpPixmap"><type>GimpPixmap</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-pixmap-set"/>gimp_pixmap_set ()</title>
|
||||
<indexterm><primary>gimp_pixmap_set</primary></indexterm><programlisting><link linkend="void">void</link> gimp_pixmap_set (<link linkend="GimpPixmap">GimpPixmap</link> *pixmap,
|
||||
<link linkend="gchar">gchar</link> **xpm_data);</programlisting>
|
||||
<warning><para><literal>gimp_pixmap_set</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
||||
<para>
|
||||
Sets a new image for an existing <link linkend="GimpPixmap"><type>GimpPixmap</type></link> widget.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>pixmap</parameter> :</term>
|
||||
<listitem><simpara> The pixmap widget you want to set the new xpm_data for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>xpm_data</parameter> :</term>
|
||||
<listitem><simpara> A pointer to a XPM data structure as found in XPM files.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="gimp-pixmap-button-new"><function>gimp_pixmap_button_new()</function></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GtkPixmap"><type>GtkPixmap</type></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
348
devel-docs/libgimpwidgets/xml/gimppreview.xml
Normal file
348
devel-docs/libgimpwidgets/xml/gimppreview.xml
Normal file
@ -0,0 +1,348 @@
|
||||
<?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="GimpPreview">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpPreview</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpPreview</refname><refpurpose>A widget providing a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> plus framework to update the preview.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpPreview-struct">GimpPreview</link>;
|
||||
<link linkend="gboolean">gboolean</link> <link linkend="gimp-preview-get-update">gimp_preview_get_update</link> (<link linkend="GimpPreview">GimpPreview</link> *preview);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-set-update">gimp_preview_set_update</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gboolean">gboolean</link> update);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-set-bounds">gimp_preview_set_bounds</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gint">gint</link> xmin,
|
||||
<link linkend="gint">gint</link> ymin,
|
||||
<link linkend="gint">gint</link> xmax,
|
||||
<link linkend="gint">gint</link> ymax);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-get-size">gimp_preview_get_size</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gint">gint</link> *width,
|
||||
<link linkend="gint">gint</link> *height);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-get-position">gimp_preview_get_position</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gint">gint</link> *x,
|
||||
<link linkend="gint">gint</link> *y);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-draw">gimp_preview_draw</link> (<link linkend="GimpPreview">GimpPreview</link> *preview);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-draw-buffer">gimp_preview_draw_buffer</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
const <link linkend="guchar">guchar</link> *buffer,
|
||||
<link linkend="gint">gint</link> rowstride);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-invalidate">gimp_preview_invalidate</link> (<link linkend="GimpPreview">GimpPreview</link> *preview);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-set-default-cursor">gimp_preview_set_default_cursor</link> (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="GdkCursor">GdkCursor</link> *cursor);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBox">GtkBox</link>
|
||||
+----<link linkend="GtkVBox">GtkVBox</link>
|
||||
+----GimpPreview
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpPreview implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpPreview--update">update</link>" <link linkend="gboolean">gboolean</link> : Read / Write / Construct
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Style Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpPreview--size">size</link>" <link linkend="gint">gint</link> : Read
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpPreview-invalidated">invalidated</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A widget providing a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> plus framework to update the preview.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPreview-struct"/>struct GimpPreview</title>
|
||||
<indexterm><primary>GimpPreview</primary></indexterm><programlisting>struct GimpPreview;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-get-update"/>gimp_preview_get_update ()</title>
|
||||
<indexterm><primary>gimp_preview_get_update</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_preview_get_update (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the state of the "Preview" check button.
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-set-update"/>gimp_preview_set_update ()</title>
|
||||
<indexterm><primary>gimp_preview_set_update</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_set_update (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gboolean">gboolean</link> update);</programlisting>
|
||||
<para>
|
||||
Sets the state of the "Preview" check button.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>update</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the preview should invalidate itself when being
|
||||
scrolled or when <link linkend="gimp-preview-invalidate"><function>gimp_preview_invalidate()</function></link> is being called
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-set-bounds"/>gimp_preview_set_bounds ()</title>
|
||||
<indexterm><primary>gimp_preview_set_bounds</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_set_bounds (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gint">gint</link> xmin,
|
||||
<link linkend="gint">gint</link> ymin,
|
||||
<link linkend="gint">gint</link> xmax,
|
||||
<link linkend="gint">gint</link> ymax);</programlisting>
|
||||
<para>
|
||||
Sets the lower and upper limits for the previewed area. The
|
||||
difference between the upper and lower value is used to set the
|
||||
maximum size of the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> used in the <parameter>preview</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>xmin</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>ymin</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>xmax</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>ymax</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-get-size"/>gimp_preview_get_size ()</title>
|
||||
<indexterm><primary>gimp_preview_get_size</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_get_size (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gint">gint</link> *width,
|
||||
<link linkend="gint">gint</link> *height);</programlisting>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> return location for the preview area width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> return location for the preview area height
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-get-position"/>gimp_preview_get_position ()</title>
|
||||
<indexterm><primary>gimp_preview_get_position</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_get_position (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="gint">gint</link> *x,
|
||||
<link linkend="gint">gint</link> *y);</programlisting>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>x</parameter> :</term>
|
||||
<listitem><simpara> return location for the horizontal offset
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>y</parameter> :</term>
|
||||
<listitem><simpara> return location for the vertical offset
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-draw"/>gimp_preview_draw ()</title>
|
||||
<indexterm><primary>gimp_preview_draw</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_draw (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
|
||||
<para>
|
||||
Calls the GimpPreview::draw method. GimpPreview itself doesn't
|
||||
implement a default draw method so the behaviour is determined by
|
||||
the derived class implementing this method.
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GimpDrawablePreview"><type>GimpDrawablePreview</type></link> implements <link linkend="gimp-preview-draw"><function>gimp_preview_draw()</function></link> by drawing the
|
||||
original, unmodified drawable to the <parameter>preview</parameter>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-draw-buffer"/>gimp_preview_draw_buffer ()</title>
|
||||
<indexterm><primary>gimp_preview_draw_buffer</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_draw_buffer (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
const <link linkend="guchar">guchar</link> *buffer,
|
||||
<link linkend="gint">gint</link> rowstride);</programlisting>
|
||||
<para>
|
||||
Calls the GimpPreview::draw_buffer method. GimpPreview itself
|
||||
doesn't implement this method so the behaviour is determined by the
|
||||
derived class implementing this method.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buffer</parameter> :</term>
|
||||
<listitem><simpara> a pixel buffer the size of the preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride</parameter> :</term>
|
||||
<listitem><simpara> the <parameter>buffer</parameter>'s rowstride
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-invalidate"/>gimp_preview_invalidate ()</title>
|
||||
<indexterm><primary>gimp_preview_invalidate</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_invalidate (<link linkend="GimpPreview">GimpPreview</link> *preview);</programlisting>
|
||||
<para>
|
||||
This function starts or renews a short low-priority timeout. When
|
||||
the timeout expires, the GimpPreview::invalidated signal is emitted
|
||||
which will usually cause the <parameter>preview</parameter> to be updated.
|
||||
</para>
|
||||
<para>
|
||||
This function does nothing unless the "Preview" button is checked.
|
||||
</para>
|
||||
<para>
|
||||
During the emission of the signal a busy cursor is set on the
|
||||
toplevel window containing the <parameter>preview</parameter> and on the preview area
|
||||
itself.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-set-default-cursor"/>gimp_preview_set_default_cursor ()</title>
|
||||
<indexterm><primary>gimp_preview_set_default_cursor</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_set_default_cursor (<link linkend="GimpPreview">GimpPreview</link> *preview,
|
||||
<link linkend="GdkCursor">GdkCursor</link> *cursor);</programlisting>
|
||||
<para>
|
||||
Sets the default mouse cursor for the preview. Note that this will
|
||||
be overriden by a <literal>GDK_FLEUR</literal> if the preview has scrollbars, or by a
|
||||
<literal>GDK_WATCH</literal> when the preview is invalidated.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>preview</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreview"><type>GimpPreview</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>cursor</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GdkCursor"><type>GdkCursor</type></link> or <literal>NULL</literal>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpPreview--update"/>"<literal>update</literal>" (<link linkend="gboolean">gboolean</link> : Read / Write / Construct)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Style Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpPreview--size"/>"<literal>size</literal>" (<link linkend="gint">gint</link> : Read)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpPreview-invalidated"/>The "invalidated" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpPreview">GimpPreview</link> *gimppreview,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimppreview</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
458
devel-docs/libgimpwidgets/xml/gimppreviewarea.xml
Normal file
458
devel-docs/libgimpwidgets/xml/gimppreviewarea.xml
Normal file
@ -0,0 +1,458 @@
|
||||
<?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="GimpPreviewArea">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpPreviewArea</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpPreviewArea</refname><refpurpose>A general purpose preview widget which caches its pixel data.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpPreviewArea-struct">GimpPreviewArea</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-preview-area-new">gimp_preview_area_new</link> (void);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-draw">gimp_preview_area_draw</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="GimpImageType">GimpImageType</link> type,
|
||||
const <link linkend="guchar">guchar</link> *buf,
|
||||
<link linkend="gint">gint</link> rowstride);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-fill">gimp_preview_area_fill</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="guchar">guchar</link> red,
|
||||
<link linkend="guchar">guchar</link> green,
|
||||
<link linkend="guchar">guchar</link> blue);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-blend">gimp_preview_area_blend</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="GimpImageType">GimpImageType</link> type,
|
||||
const <link linkend="guchar">guchar</link> *buf1,
|
||||
<link linkend="gint">gint</link> rowstride1,
|
||||
const <link linkend="guchar">guchar</link> *buf2,
|
||||
<link linkend="gint">gint</link> rowstride2,
|
||||
<link linkend="guchar">guchar</link> opacity);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-mask">gimp_preview_area_mask</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="GimpImageType">GimpImageType</link> type,
|
||||
const <link linkend="guchar">guchar</link> *buf1,
|
||||
<link linkend="gint">gint</link> rowstride1,
|
||||
const <link linkend="guchar">guchar</link> *buf2,
|
||||
<link linkend="gint">gint</link> rowstride2,
|
||||
const <link linkend="guchar">guchar</link> *mask,
|
||||
<link linkend="gint">gint</link> rowstride_mask);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
const <link linkend="guchar">guchar</link> *colormap,
|
||||
<link linkend="gint">gint</link> num_colors);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height);
|
||||
<link linkend="void">void</link> <link linkend="gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</link> (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="GdkEventButton">GdkEventButton</link> *event);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkDrawingArea">GtkDrawingArea</link>
|
||||
+----GimpPreviewArea
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpPreviewArea implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpPreviewArea--check-size">check-size</link>" <link linkend="GimpCheckSize">GimpCheckSize</link> : Read / Write
|
||||
"<link linkend="GimpPreviewArea--check-type">check-type</link>" <link linkend="GimpCheckType">GimpCheckType</link> : Read / Write
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A general purpose preview widget which caches its pixel data.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpPreviewArea-struct"/>struct GimpPreviewArea</title>
|
||||
<indexterm><primary>GimpPreviewArea</primary></indexterm><programlisting>struct GimpPreviewArea;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-new"/>gimp_preview_area_new ()</title>
|
||||
<indexterm><primary>gimp_preview_area_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_preview_area_new (void);</programlisting>
|
||||
<para>
|
||||
</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a new <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
|
||||
|
||||
Since GIMP 2.2
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-draw"/>gimp_preview_area_draw ()</title>
|
||||
<indexterm><primary>gimp_preview_area_draw</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_draw (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="GimpImageType">GimpImageType</link> type,
|
||||
const <link linkend="guchar">guchar</link> *buf,
|
||||
<link linkend="gint">gint</link> rowstride);</programlisting>
|
||||
<para>
|
||||
Draws <parameter>buf</parameter> on <parameter>area</parameter> and queues a redraw on the given rectangle.
|
||||
</para>
|
||||
<para>
|
||||
Since GIMP 2.2</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>x</parameter> :</term>
|
||||
<listitem><simpara> x offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>y</parameter> :</term>
|
||||
<listitem><simpara> y offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> buffer width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> buffer height
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> the <link linkend="GimpImageType"><type>GimpImageType</type></link> of <parameter>buf</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer that contains the preview pixel data.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride</parameter> :</term>
|
||||
<listitem><simpara> rowstride of <parameter>buf</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-fill"/>gimp_preview_area_fill ()</title>
|
||||
<indexterm><primary>gimp_preview_area_fill</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_fill (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="guchar">guchar</link> red,
|
||||
<link linkend="guchar">guchar</link> green,
|
||||
<link linkend="guchar">guchar</link> blue);</programlisting>
|
||||
<para>
|
||||
Fills <parameter>area</parameter> in the given color and queues a redraw on the given
|
||||
rectangle.
|
||||
</para>
|
||||
<para>
|
||||
Since GIMP 2.2</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>x</parameter> :</term>
|
||||
<listitem><simpara> x offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>y</parameter> :</term>
|
||||
<listitem><simpara> y offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> buffer width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> buffer height
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>red</parameter> :</term>
|
||||
<listitem><simpara> red component of the fill color (0-255)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>green</parameter> :</term>
|
||||
<listitem><simpara> green component of the fill color (0-255)
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>blue</parameter> :</term>
|
||||
<listitem><simpara> red component of the fill color (0-255)
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-blend"/>gimp_preview_area_blend ()</title>
|
||||
<indexterm><primary>gimp_preview_area_blend</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_blend (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="GimpImageType">GimpImageType</link> type,
|
||||
const <link linkend="guchar">guchar</link> *buf1,
|
||||
<link linkend="gint">gint</link> rowstride1,
|
||||
const <link linkend="guchar">guchar</link> *buf2,
|
||||
<link linkend="gint">gint</link> rowstride2,
|
||||
<link linkend="guchar">guchar</link> opacity);</programlisting>
|
||||
<para>
|
||||
Composites <parameter>buf1</parameter> on <parameter>buf2</parameter> with the given <parameter>opacity</parameter>, draws the result
|
||||
to <parameter>area</parameter> and queues a redraw on the given rectangle.
|
||||
</para>
|
||||
<para>
|
||||
Since GIMP 2.2</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>x</parameter> :</term>
|
||||
<listitem><simpara> x offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>y</parameter> :</term>
|
||||
<listitem><simpara> y offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> buffer width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> buffer height
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> the <link linkend="GimpImageType"><type>GimpImageType</type></link> of <parameter>buf1</parameter> and <parameter>buf2</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf1</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
|
||||
the lower layer
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride1</parameter> :</term>
|
||||
<listitem><simpara> rowstride of <parameter>buf1</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf2</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
|
||||
the upper layer
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride2</parameter> :</term>
|
||||
<listitem><simpara> rowstride of <parameter>buf2</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>opacity</parameter> :</term>
|
||||
<listitem><simpara> The opacity of the first layer.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-mask"/>gimp_preview_area_mask ()</title>
|
||||
<indexterm><primary>gimp_preview_area_mask</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_mask (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height,
|
||||
<link linkend="GimpImageType">GimpImageType</link> type,
|
||||
const <link linkend="guchar">guchar</link> *buf1,
|
||||
<link linkend="gint">gint</link> rowstride1,
|
||||
const <link linkend="guchar">guchar</link> *buf2,
|
||||
<link linkend="gint">gint</link> rowstride2,
|
||||
const <link linkend="guchar">guchar</link> *mask,
|
||||
<link linkend="gint">gint</link> rowstride_mask);</programlisting>
|
||||
<para>
|
||||
Composites <parameter>buf1</parameter> on <parameter>buf2</parameter> with the given <parameter>mask</parameter>, draws the result on
|
||||
<parameter>area</parameter> and queues a redraw on the given rectangle.
|
||||
</para>
|
||||
<para>
|
||||
Since GIMP 2.2</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>x</parameter> :</term>
|
||||
<listitem><simpara> x offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>y</parameter> :</term>
|
||||
<listitem><simpara> y offset in preview
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> buffer width
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> buffer height
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>type</parameter> :</term>
|
||||
<listitem><simpara> the <link linkend="GimpImageType"><type>GimpImageType</type></link> of <parameter>buf1</parameter> and <parameter>buf2</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf1</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
|
||||
the lower layer
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride1</parameter> :</term>
|
||||
<listitem><simpara> rowstride of <parameter>buf1</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>buf2</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer that contains the pixel data for
|
||||
the upper layer
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride2</parameter> :</term>
|
||||
<listitem><simpara> rowstride of <parameter>buf2</parameter>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>mask</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer representing the mask of the second
|
||||
layer.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>rowstride_mask</parameter> :</term>
|
||||
<listitem><simpara> rowstride for the mask.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-set-offsets"/>gimp_preview_area_set_offsets ()</title>
|
||||
<indexterm><primary>gimp_preview_area_set_offsets</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_set_offsets (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> x,
|
||||
<link linkend="gint">gint</link> y);</programlisting>
|
||||
<para>
|
||||
Sets the offsets of the previewed area. This information is used
|
||||
when drawing the checkerboard and to determine the dither offsets.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>x</parameter> :</term>
|
||||
<listitem><simpara> horizontal offset
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>y</parameter> :</term>
|
||||
<listitem><simpara> vertical offset
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-set-colormap"/>gimp_preview_area_set_colormap ()</title>
|
||||
<indexterm><primary>gimp_preview_area_set_colormap</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_set_colormap (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
const <link linkend="guchar">guchar</link> *colormap,
|
||||
<link linkend="gint">gint</link> num_colors);</programlisting>
|
||||
<para>
|
||||
Sets the colormap for the <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget. You need to
|
||||
call this function before you use <link linkend="gimp-preview-area-draw"><function>gimp_preview_area_draw()</function></link> with
|
||||
an image type of <literal>GIMP_INDEXED_IMAGE</literal> or <literal>GIMP_INDEXEDA_IMAGE</literal>.
|
||||
</para>
|
||||
<para>
|
||||
Since GIMP 2.2</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>colormap</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="guchar"><type>guchar</type></link> buffer that contains the colormap
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>num_colors</parameter> :</term>
|
||||
<listitem><simpara> the number of colors in the colormap
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-set-max-size"/>gimp_preview_area_set_max_size ()</title>
|
||||
<indexterm><primary>gimp_preview_area_set_max_size</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_set_max_size (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="gint">gint</link> width,
|
||||
<link linkend="gint">gint</link> height);</programlisting>
|
||||
<para>
|
||||
Usually a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> fills the size that it is
|
||||
allocated. This funtion allows you to limit the preview area to a
|
||||
maximum size. If a larger size is allocated for the widget, the
|
||||
preview will draw itself centered into the allocated area.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link> widget
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>width</parameter> :</term>
|
||||
<listitem><simpara> the maximum width in pixels or -1 to unset the limit
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>height</parameter> :</term>
|
||||
<listitem><simpara> the maximum height in pixels or -1 to unset the limit
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-preview-area-menu-popup"/>gimp_preview_area_menu_popup ()</title>
|
||||
<indexterm><primary>gimp_preview_area_menu_popup</primary></indexterm><programlisting><link linkend="void">void</link> gimp_preview_area_menu_popup (<link linkend="GimpPreviewArea">GimpPreviewArea</link> *area,
|
||||
<link linkend="GdkEventButton">GdkEventButton</link> *event);</programlisting>
|
||||
<para>
|
||||
Creates a popup menu that allows to configure the size and type of
|
||||
the checkerboard pattern that the <parameter>area</parameter> uses to visualize transparency.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>area</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpPreviewArea"><type>GimpPreviewArea</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>event</parameter> :</term>
|
||||
<listitem><simpara> the button event that causes the menu to popup or <literal>NULL</literal>
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist><para>Since GIMP 2.2
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
<refsect1>
|
||||
<title>Properties</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><anchor id="GimpPreviewArea--check-size"/>"<literal>check-size</literal>" (<link linkend="GimpCheckSize">GimpCheckSize</link> : Read / Write)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
<varlistentry><term><anchor id="GimpPreviewArea--check-type"/>"<literal>check-type</literal>" (<link linkend="GimpCheckType">GimpCheckType</link> : Read / Write)</term>
|
||||
<listitem>
|
||||
<para></para>
|
||||
</listitem></varlistentry>
|
||||
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
574
devel-docs/libgimpwidgets/xml/gimpquerybox.xml
Normal file
574
devel-docs/libgimpwidgets/xml/gimpquerybox.xml
Normal file
@ -0,0 +1,574 @@
|
||||
<?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="libgimpwidgets-GimpQueryBox">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpQueryBox</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpQueryBox</refname><refpurpose>Some simple dialogs to enter a single int, double, string or boolean value.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
<link linkend="void">void</link> (<link linkend="GimpQueryStringCallback">*GimpQueryStringCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
const <link linkend="gchar">gchar</link> *string,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="void">void</link> (<link linkend="GimpQueryIntCallback">*GimpQueryIntCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gint">gint</link> value,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="void">void</link> (<link linkend="GimpQueryDoubleCallback">*GimpQueryDoubleCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gdouble">gdouble</link> value,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="void">void</link> (<link linkend="GimpQuerySizeCallback">*GimpQuerySizeCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gdouble">gdouble</link> size,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="void">void</link> (<link linkend="GimpQueryBooleanCallback">*GimpQueryBooleanCallback</link>) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gboolean">gboolean</link> value,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-string-box">gimp_query_string_box</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
const <link linkend="gchar">gchar</link> *initial,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-int-box">gimp_query_int_box</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
<link linkend="gint">gint</link> initial,
|
||||
<link linkend="gint">gint</link> lower,
|
||||
<link linkend="gint">gint</link> upper,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-double-box">gimp_query_double_box</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
<link linkend="gdouble">gdouble</link> initial,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper,
|
||||
<link linkend="gint">gint</link> digits,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-size-box">gimp_query_size_box</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
<link linkend="gdouble">gdouble</link> initial,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper,
|
||||
<link linkend="gint">gint</link> digits,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
<link linkend="gdouble">gdouble</link> resolution,
|
||||
<link linkend="gboolean">gboolean</link> dot_for_dot,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-query-boolean-box">gimp_query_boolean_box</link> (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *stock_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
const <link linkend="gchar">gchar</link> *true_button,
|
||||
const <link linkend="gchar">gchar</link> *false_button,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);
|
||||
#define <link linkend="GIMP-QUERY-BOX-VBOX-CAPS">GIMP_QUERY_BOX_VBOX</link> (qbox)
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
These functions provide simple dialogs for entering a single string,
|
||||
integer, double, boolean or pixel size value.
|
||||
</para>
|
||||
<para>
|
||||
They return a pointer to a <link linkend="GtkDialog"><type>GtkDialog</type></link> which has to be shown with
|
||||
<link linkend="gtk-widget-show"><function>gtk_widget_show()</function></link> by the caller.
|
||||
</para>
|
||||
<para>
|
||||
The dialogs contain an entry widget for the kind of value they ask for
|
||||
and "OK" and "Cancel" buttons. On "Cancel", all query boxes except the
|
||||
boolean one silently destroy themselves. On "OK" the user defined
|
||||
callback function is called and returns the entered value.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpQueryStringCallback"/>GimpQueryStringCallback ()</title>
|
||||
<indexterm><primary>GimpQueryStringCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryStringCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
const <link linkend="gchar">gchar</link> *string,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
Note that you have to <link linkend="g-free"><function>g_free()</function></link> the returned string.
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>query_box</parameter> :</term>
|
||||
<listitem><simpara>The query box.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>string</parameter> :</term>
|
||||
<listitem><simpara>The entered string.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>The user data.
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpQueryIntCallback"/>GimpQueryIntCallback ()</title>
|
||||
<indexterm><primary>GimpQueryIntCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryIntCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gint">gint</link> value,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>query_box</parameter> :</term>
|
||||
<listitem><simpara>The query box.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara>The entered integer value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>The user data.
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpQueryDoubleCallback"/>GimpQueryDoubleCallback ()</title>
|
||||
<indexterm><primary>GimpQueryDoubleCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryDoubleCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gdouble">gdouble</link> value,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>query_box</parameter> :</term>
|
||||
<listitem><simpara>The query box.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara>The entered double value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>The user data.
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpQuerySizeCallback"/>GimpQuerySizeCallback ()</title>
|
||||
<indexterm><primary>GimpQuerySizeCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQuerySizeCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gdouble">gdouble</link> size,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>query_box</parameter> :</term>
|
||||
<listitem><simpara>The query box.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>size</parameter> :</term>
|
||||
<listitem><simpara>The entered size in pixels.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara>The selected unit from the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>The user data.
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpQueryBooleanCallback"/>GimpQueryBooleanCallback ()</title>
|
||||
<indexterm><primary>GimpQueryBooleanCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpQueryBooleanCallback) (<link linkend="GtkWidget">GtkWidget</link> *query_box,
|
||||
<link linkend="gboolean">gboolean</link> value,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>query_box</parameter> :</term>
|
||||
<listitem><simpara>The query box.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara>The entered boolean value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara>The user data.
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-query-string-box"/>gimp_query_string_box ()</title>
|
||||
<indexterm><primary>gimp_query_string_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_string_box (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
const <link linkend="gchar">gchar</link> *initial,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryStringCallback">GimpQueryStringCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a string value.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The query box dialog's title.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The dialog's parent widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The help function to show this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> A string identifying this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>message</parameter> :</term>
|
||||
<listitem><simpara> A string which will be shown above the dialog's entry widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial</parameter> :</term>
|
||||
<listitem><simpara> The initial value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>object</parameter> :</term>
|
||||
<listitem><simpara> The object this query box is associated with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>signal</parameter> :</term>
|
||||
<listitem><simpara> The object's signal which will cause the query box to be closed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called when the user selects "OK".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> The callback's user data.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-query-int-box"/>gimp_query_int_box ()</title>
|
||||
<indexterm><primary>gimp_query_int_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_int_box (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
<link linkend="gint">gint</link> initial,
|
||||
<link linkend="gint">gint</link> lower,
|
||||
<link linkend="gint">gint</link> upper,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryIntCallback">GimpQueryIntCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for an integer value.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The query box dialog's title.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The dialog's parent widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The help function to show this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> A string identifying this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>message</parameter> :</term>
|
||||
<listitem><simpara> A string which will be shown above the dialog's entry widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial</parameter> :</term>
|
||||
<listitem><simpara> The initial value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> The lower boundary of the range of possible values.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> The upper boundray of the range of possible values.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>object</parameter> :</term>
|
||||
<listitem><simpara> The object this query box is associated with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>signal</parameter> :</term>
|
||||
<listitem><simpara> The object's signal which will cause the query box to be closed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called when the user selects "OK".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> The callback's user data.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-query-double-box"/>gimp_query_double_box ()</title>
|
||||
<indexterm><primary>gimp_query_double_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_double_box (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
<link linkend="gdouble">gdouble</link> initial,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper,
|
||||
<link linkend="gint">gint</link> digits,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryDoubleCallback">GimpQueryDoubleCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a double value.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The query box dialog's title.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The dialog's parent widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The help function to show this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> A string identifying this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>message</parameter> :</term>
|
||||
<listitem><simpara> A string which will be shown above the dialog's entry widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial</parameter> :</term>
|
||||
<listitem><simpara> The initial value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> The lower boundary of the range of possible values.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> The upper boundray of the range of possible values.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>digits</parameter> :</term>
|
||||
<listitem><simpara> The number of decimal digits the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> will provide.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>object</parameter> :</term>
|
||||
<listitem><simpara> The object this query box is associated with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>signal</parameter> :</term>
|
||||
<listitem><simpara> The object's signal which will cause the query box to be closed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called when the user selects "OK".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> The callback's user data.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-query-size-box"/>gimp_query_size_box ()</title>
|
||||
<indexterm><primary>gimp_query_size_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_size_box (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
<link linkend="gdouble">gdouble</link> initial,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper,
|
||||
<link linkend="gint">gint</link> digits,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
<link linkend="gdouble">gdouble</link> resolution,
|
||||
<link linkend="gboolean">gboolean</link> dot_for_dot,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQuerySizeCallback">GimpQuerySizeCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that queries the user for a size using a
|
||||
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The query box dialog's title.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The dialog's parent widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The help function to show this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> A string identifying this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>message</parameter> :</term>
|
||||
<listitem><simpara> A string which will be shown above the dialog's entry widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>initial</parameter> :</term>
|
||||
<listitem><simpara> The initial value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> The lower boundary of the range of possible values.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> The upper boundray of the range of possible values.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>digits</parameter> :</term>
|
||||
<listitem><simpara> The number of decimal digits the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> provide in
|
||||
"pixel" mode.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The unit initially shown by the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>resolution</parameter> :</term>
|
||||
<listitem><simpara> The resolution (in dpi) which will be used for pixel/unit
|
||||
calculations.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>dot_for_dot</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>'s initial unit should be "pixels".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>object</parameter> :</term>
|
||||
<listitem><simpara> The object this query box is associated with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>signal</parameter> :</term>
|
||||
<listitem><simpara> The object's signal which will cause the query box
|
||||
to be closed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called when the user selects "OK".
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> The callback's user data.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-query-boolean-box"/>gimp_query_boolean_box ()</title>
|
||||
<indexterm><primary>gimp_query_boolean_box</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_query_boolean_box (const <link linkend="gchar">gchar</link> *title,
|
||||
<link linkend="GtkWidget">GtkWidget</link> *parent,
|
||||
<link linkend="GimpHelpFunc">GimpHelpFunc</link> help_func,
|
||||
const <link linkend="gchar">gchar</link> *help_id,
|
||||
const <link linkend="gchar">gchar</link> *stock_id,
|
||||
const <link linkend="gchar">gchar</link> *message,
|
||||
const <link linkend="gchar">gchar</link> *true_button,
|
||||
const <link linkend="gchar">gchar</link> *false_button,
|
||||
<link linkend="GObject">GObject</link> *object,
|
||||
const <link linkend="gchar">gchar</link> *signal,
|
||||
<link linkend="GimpQueryBooleanCallback">GimpQueryBooleanCallback</link> callback,
|
||||
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GtkDialog"><type>GtkDialog</type></link> that asks the user to do a boolean decision.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>title</parameter> :</term>
|
||||
<listitem><simpara> The query box dialog's title.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>parent</parameter> :</term>
|
||||
<listitem><simpara> The dialog's parent widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_func</parameter> :</term>
|
||||
<listitem><simpara> The help function to show this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>help_id</parameter> :</term>
|
||||
<listitem><simpara> A string identifying this dialog's help page.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>stock_id</parameter> :</term>
|
||||
<listitem><simpara> A stock_id to specify an icon to appear on the left
|
||||
on the dialog's message.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>message</parameter> :</term>
|
||||
<listitem><simpara> A string which will be shown in the query box.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>true_button</parameter> :</term>
|
||||
<listitem><simpara> The string to be shown in the dialog's left button.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>false_button</parameter> :</term>
|
||||
<listitem><simpara> The string to be shown in the dialog's right button.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>object</parameter> :</term>
|
||||
<listitem><simpara> The object this query box is associated with.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>signal</parameter> :</term>
|
||||
<listitem><simpara> The object's signal which will cause the query box
|
||||
to be closed.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>callback</parameter> :</term>
|
||||
<listitem><simpara> The function which will be called when the user clicks one
|
||||
of the buttons.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>data</parameter> :</term>
|
||||
<listitem><simpara> The callback's user data.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkDialog"><type>GtkDialog</type></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GIMP-QUERY-BOX-VBOX-CAPS"/>GIMP_QUERY_BOX_VBOX()</title>
|
||||
<indexterm><primary>GIMP_QUERY_BOX_VBOX</primary></indexterm><programlisting>#define GIMP_QUERY_BOX_VBOX(qbox)</programlisting>
|
||||
<para>
|
||||
A macro to access the <link linkend="GtkVBox"><type>GtkVBox</type></link> in a <link linkend="GimpQueryBox"><type>GimpQueryBox</type></link>. Useful if you want to add
|
||||
more widgets.
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>qbox</parameter> :</term>
|
||||
<listitem><simpara>
|
||||
|
||||
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
GimpSizeEntry
|
||||
</para>
|
||||
<para>
|
||||
GimpUnitMenu
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
61
devel-docs/libgimpwidgets/xml/gimpscrolledpreview.xml
Normal file
61
devel-docs/libgimpwidgets/xml/gimpscrolledpreview.xml
Normal file
@ -0,0 +1,61 @@
|
||||
<?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="libgimpwidgets-GimpScrolledPreview">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpScrolledPreview</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpScrolledPreview</refname><refpurpose>A widget providing a <link linkend="GimpPreview"><type>GimpPreview</type></link> enhanced by scrolling capabilities.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpScrolledPreview">GimpScrolledPreview</link>;
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
A widget providing a <link linkend="GimpPreview"><type>GimpPreview</type></link> enhanced by scrolling capabilities.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpScrolledPreview"/>struct GimpScrolledPreview</title>
|
||||
<indexterm><primary>GimpScrolledPreview</primary></indexterm><programlisting>struct GimpScrolledPreview {
|
||||
|
||||
GimpPreview parent_instance;
|
||||
|
||||
};
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
|
||||
</refentry>
|
||||
735
devel-docs/libgimpwidgets/xml/gimpsizeentry.xml
Normal file
735
devel-docs/libgimpwidgets/xml/gimpsizeentry.xml
Normal file
@ -0,0 +1,735 @@
|
||||
<?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="GimpSizeEntry">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpSizeEntry</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpSizeEntry</refname><refpurpose>Widget for entering pixel values and resolutions.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpSizeEntry-struct">GimpSizeEntry</link>;
|
||||
struct <link linkend="GimpSizeEntryField">GimpSizeEntryField</link>;
|
||||
enum <link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-size-entry-new">gimp_size_entry_new</link> (<link linkend="gint">gint</link> number_of_fields,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
const <link linkend="gchar">gchar</link> *unit_format,
|
||||
<link linkend="gboolean">gboolean</link> menu_show_pixels,
|
||||
<link linkend="gboolean">gboolean</link> menu_show_percent,
|
||||
<link linkend="gboolean">gboolean</link> show_refval,
|
||||
<link linkend="gint">gint</link> spinbutton_width,
|
||||
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-add-field">gimp_size_entry_add_field</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="GtkSpinButton">GtkSpinButton</link> *value_spinbutton,
|
||||
<link linkend="GtkSpinButton">GtkSpinButton</link> *refval_spinbutton);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-size-entry-attach-label">gimp_size_entry_attach_label</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
const <link linkend="gchar">gchar</link> *text,
|
||||
<link linkend="gint">gint</link> row,
|
||||
<link linkend="gint">gint</link> column,
|
||||
<link linkend="gfloat">gfloat</link> alignment);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-resolution">gimp_size_entry_set_resolution</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> resolution,
|
||||
<link linkend="gboolean">gboolean</link> keep_size);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-size">gimp_size_entry_set_size</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-value-boundaries">gimp_size_entry_set_value_boundaries</link>
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper);
|
||||
<link linkend="gdouble">gdouble</link> <link linkend="gimp-size-entry-get-value">gimp_size_entry_get_value</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-value">gimp_size_entry_set_value</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> value);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-refval-boundaries">gimp_size_entry_set_refval_boundaries</link>
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-refval-digits">gimp_size_entry_set_refval_digits</link>
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gint">gint</link> digits);
|
||||
<link linkend="gdouble">gdouble</link> <link linkend="gimp-size-entry-get-refval">gimp_size_entry_get_refval</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-refval">gimp_size_entry_set_refval</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> refval);
|
||||
<link linkend="GimpUnit">GimpUnit</link> <link linkend="gimp-size-entry-get-unit">gimp_size_entry_get_unit</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-unit">gimp_size_entry_set_unit</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-set-pixel-digits">gimp_size_entry_set_pixel_digits</link>
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> digits);
|
||||
<link linkend="void">void</link> <link linkend="gimp-size-entry-grab-focus">gimp_size_entry_grab_focus</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-size-entry-get-help-widget">gimp_size_entry_get_help_widget</link> (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkTable">GtkTable</link>
|
||||
+----GimpSizeEntry
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpSizeEntry implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpSizeEntry-refval-changed">refval-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpSizeEntry-unit-changed">unit-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
"<link linkend="GimpSizeEntry-value-changed">value-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This widget is used to enter pixel distances/sizes and resolutions.
|
||||
</para>
|
||||
<para>
|
||||
You can specify the number of fields the widget should provide. For
|
||||
each field automatic mappings are performed between the field's
|
||||
"reference value" and it's "value".
|
||||
</para>
|
||||
<para>
|
||||
There is a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> right of the entry fields which lets you
|
||||
specify the <link linkend="GimpUnit"><type>GimpUnit</type></link> of the displayed values.
|
||||
</para>
|
||||
<para>
|
||||
For each field, there can be one or two <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s to enter
|
||||
"value" and "reference value". If you specify <parameter>show_refval</parameter> as <link linkend="FALSE-CAPS"><type>FALSE</type></link>
|
||||
in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> there will be only one <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> and the
|
||||
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> will contain an item for selecting GIMP_UNIT_PIXEL.
|
||||
</para>
|
||||
<para>
|
||||
The "reference value" is either of GIMP_UNIT_PIXEL or dpi, depending
|
||||
on which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you specify in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.
|
||||
The "value" is either the size in pixels mapped to the size in a
|
||||
real-world-unit (see <link linkend="GimpUnit"><type>GimpUnit</type></link>) or the dpi value mapped to pixels per
|
||||
real-world-unit.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpSizeEntry-struct"/>struct GimpSizeEntry</title>
|
||||
<indexterm><primary>GimpSizeEntry</primary></indexterm><programlisting>struct GimpSizeEntry;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpSizeEntryField"/>struct GimpSizeEntryField</title>
|
||||
<indexterm><primary>GimpSizeEntryField</primary></indexterm><programlisting>struct GimpSizeEntryField;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpSizeEntryUpdatePolicy"/>enum GimpSizeEntryUpdatePolicy</title>
|
||||
<indexterm><primary>GimpSizeEntryUpdatePolicy</primary></indexterm><programlisting>typedef enum
|
||||
{
|
||||
GIMP_SIZE_ENTRY_UPDATE_NONE = 0,
|
||||
GIMP_SIZE_ENTRY_UPDATE_SIZE = 1,
|
||||
GIMP_SIZE_ENTRY_UPDATE_RESOLUTION = 2
|
||||
} GimpSizeEntryUpdatePolicy;
|
||||
</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-new"/>gimp_size_entry_new ()</title>
|
||||
<indexterm><primary>gimp_size_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_size_entry_new (<link linkend="gint">gint</link> number_of_fields,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
const <link linkend="gchar">gchar</link> *unit_format,
|
||||
<link linkend="gboolean">gboolean</link> menu_show_pixels,
|
||||
<link linkend="gboolean">gboolean</link> menu_show_percent,
|
||||
<link linkend="gboolean">gboolean</link> show_refval,
|
||||
<link linkend="gint">gint</link> spinbutton_width,
|
||||
<link linkend="GimpSizeEntryUpdatePolicy">GimpSizeEntryUpdatePolicy</link> update_policy);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
|
||||
</para>
|
||||
<para>
|
||||
To have all automatic calculations performed correctly, set up the
|
||||
widget in the following order:
|
||||
</para>
|
||||
<para>
|
||||
1. <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>
|
||||
</para>
|
||||
<para>
|
||||
2. (for each additional input field) <link linkend="gimp-size-entry-add-field"><function>gimp_size_entry_add_field()</function></link>
|
||||
</para>
|
||||
<para>
|
||||
3. <link linkend="gimp-size-entry-set-unit"><function>gimp_size_entry_set_unit()</function></link>
|
||||
</para>
|
||||
<para>
|
||||
For each input field:
|
||||
</para>
|
||||
<para>
|
||||
4. <link linkend="gimp-size-entry-set-resolution"><function>gimp_size_entry_set_resolution()</function></link>
|
||||
</para>
|
||||
<para>
|
||||
5. <link linkend="gimp-size-entry-set-refval-boundaries"><function>gimp_size_entry_set_refval_boundaries()</function></link>
|
||||
(or <link linkend="gimp-size-entry-set-value-boundaries"><function>gimp_size_entry_set_value_boundaries()</function></link>)
|
||||
</para>
|
||||
<para>
|
||||
6. <link linkend="gimp-size-entry-set-size"><function>gimp_size_entry_set_size()</function></link>
|
||||
</para>
|
||||
<para>
|
||||
7. <link linkend="gimp-size-entry-set-refval"><function>gimp_size_entry_set_refval()</function></link> (or <link linkend="gimp-size-entry-set-value"><function>gimp_size_entry_set_value()</function></link>)
|
||||
</para>
|
||||
<para>
|
||||
The <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> is derived from <link linkend="GtkTable"><type>GtkTable</type></link> and will have
|
||||
an empty border of one cell width on each side plus an empty column left
|
||||
of the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> to allow the caller to add labels or a
|
||||
<link linkend="GimpChainButton"><type>GimpChainButton</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>number_of_fields</parameter> :</term>
|
||||
<listitem><simpara> The number of input fields.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The initial unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit_format</parameter> :</term>
|
||||
<listitem><simpara> A printf-like unit-format string as is used with
|
||||
<link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>menu_show_pixels</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the unit menu shold contain an item for
|
||||
GIMP_UNIT_PIXEL (ignored if the <parameter>update_policy</parameter> is not
|
||||
GIMP_SIZE_ENTRY_UPDATE_NONE).
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>menu_show_percent</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the unit menu shold contain an item for
|
||||
GIMP_UNIT_PERCENT.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>show_refval</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if you want an extra "reference value"
|
||||
spinbutton per input field.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>spinbutton_width</parameter> :</term>
|
||||
<listitem><simpara> The minimal horizontal size of the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>'s.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>update_policy</parameter> :</term>
|
||||
<listitem><simpara> How the automatic pixel <-> real-world-unit
|
||||
calculations should be done.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A Pointer to the new <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-add-field"/>gimp_size_entry_add_field ()</title>
|
||||
<indexterm><primary>gimp_size_entry_add_field</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_add_field (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="GtkSpinButton">GtkSpinButton</link> *value_spinbutton,
|
||||
<link linkend="GtkSpinButton">GtkSpinButton</link> *refval_spinbutton);</programlisting>
|
||||
<para>
|
||||
Adds an input field to the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The new input field will have the index 0. If you specified <parameter>show_refval</parameter>
|
||||
as <literal>TRUE</literal> in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> you have to pass an additional
|
||||
<link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> to hold the reference value. If <parameter>show_refval</parameter> was <literal>FALSE</literal>,
|
||||
<parameter>refval_spinbutton</parameter> will be ignored.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to add a field to.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value_spinbutton</parameter> :</term>
|
||||
<listitem><simpara> The spinbutton to display the field's value.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>refval_spinbutton</parameter> :</term>
|
||||
<listitem><simpara> The spinbutton to display the field's reference value.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-attach-label"/>gimp_size_entry_attach_label ()</title>
|
||||
<indexterm><primary>gimp_size_entry_attach_label</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_size_entry_attach_label (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
const <link linkend="gchar">gchar</link> *text,
|
||||
<link linkend="gint">gint</link> row,
|
||||
<link linkend="gint">gint</link> column,
|
||||
<link linkend="gfloat">gfloat</link> alignment);</programlisting>
|
||||
<para>
|
||||
Attaches a <link linkend="GtkLabel"><type>GtkLabel</type></link> to the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> (which is a <link linkend="GtkTable"><type>GtkTable</type></link>).</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to add a label to.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>text</parameter> :</term>
|
||||
<listitem><simpara> The text of the label.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>row</parameter> :</term>
|
||||
<listitem><simpara> The row where the label will be attached.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>column</parameter> :</term>
|
||||
<listitem><simpara> The column where the label will be attached.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>alignment</parameter> :</term>
|
||||
<listitem><simpara> The horizontal alignment of the label.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GtkLabel"><type>GtkLabel</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-resolution"/>gimp_size_entry_set_resolution ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_resolution</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_resolution (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> resolution,
|
||||
<link linkend="gboolean">gboolean</link> keep_size);</programlisting>
|
||||
<para>
|
||||
Sets the resolution (in dpi) for field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>resolution</parameter> passed will be clamped to fit in
|
||||
[<link linkend="GIMP-MIN-RESOLUTION-CAPS"><type>GIMP_MIN_RESOLUTION</type></link>..<link linkend="GIMP-MAX-RESOLUTION-CAPS"><type>GIMP_MAX_RESOLUTION</type></link>].
|
||||
</para>
|
||||
<para>
|
||||
This function does nothing if the <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> specified in
|
||||
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> doesn't equal to <link linkend="GIMP-SIZE-ENTRY-UPDATE-SIZE-CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_SIZE</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set a resolution for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set the resolution for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>resolution</parameter> :</term>
|
||||
<listitem><simpara> The new resolution (in dpi) for the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>keep_size</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the <parameter>field</parameter>'s size in pixels should stay the same.
|
||||
<literal>FALSE</literal> if the <parameter>field</parameter>'s size in units should stay the same.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-size"/>gimp_size_entry_set_size ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_size</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_size (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper);</programlisting>
|
||||
<para>
|
||||
Sets the pixel values for field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
|
||||
which will be treated as 0% and 100%.
|
||||
</para>
|
||||
<para>
|
||||
These values will be used if you specified <parameter>menu_show_percent</parameter> as <literal>TRUE</literal>
|
||||
in <link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> and the user has selected GIMP_UNIT_PERCENT in
|
||||
the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
This function does nothing if the <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> specified in
|
||||
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link> doesn't equal to GIMP_SIZE_ENTRY_UPDATE_SIZE.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set a size for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set the size for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> The reference value which will be treated as 0%.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> The reference value which will be treated as 100%.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-value-boundaries"/>gimp_size_entry_set_value_boundaries ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_value_boundaries</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_value_boundaries
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper);</programlisting>
|
||||
<para>
|
||||
Limits the range of possible values which can be entered in field # <parameter>field</parameter>
|
||||
of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The current value of the <parameter>field</parameter> will be clamped to fit in the <parameter>field</parameter>'s
|
||||
new boundaries.
|
||||
</para>
|
||||
<para>
|
||||
NOTE: In most cases you won't be interested in these values because the
|
||||
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s purpose is to shield the programmer from unit
|
||||
calculations. Use <link linkend="gimp-size-entry-set-refval-boundaries"><function>gimp_size_entry_set_refval_boundaries()</function></link> instead.
|
||||
Whatever you do, don't mix these calls. A size entry should either
|
||||
be clamped by the value or the reference value.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set value boundaries for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set value boundaries for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> The new lower boundary of the value of the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> The new upper boundary of the value of the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-get-value"/>gimp_size_entry_get_value ()</title>
|
||||
<indexterm><primary>gimp_size_entry_get_value</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_size_entry_get_value (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field);</programlisting>
|
||||
<para>
|
||||
Returns the value of field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>value</parameter> returned is a distance or resolution
|
||||
in the <link linkend="GimpUnit"><type>GimpUnit</type></link> the user has selected in the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s
|
||||
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
NOTE: In most cases you won't be interested in this value because the
|
||||
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s purpose is to shield the programmer from unit
|
||||
calculations. Use <link linkend="gimp-size-entry-get-refval"><function>gimp_size_entry_get_refval()</function></link> instead.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to know a value of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to know the value of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The value of the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-value"/>gimp_size_entry_set_value ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_value</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_value (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> value);</programlisting>
|
||||
<para>
|
||||
Sets the value for field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>value</parameter> passed is treated to be a distance or resolution
|
||||
in the <link linkend="GimpUnit"><type>GimpUnit</type></link> the user has selected in the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s
|
||||
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
NOTE: In most cases you won't be interested in this value because the
|
||||
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s purpose is to shield the programmer from unit
|
||||
calculations. Use <link linkend="gimp-size-entry-set-refval"><function>gimp_size_entry_set_refval()</function></link> instead.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set a value for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set a value for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>value</parameter> :</term>
|
||||
<listitem><simpara> The new value for <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-refval-boundaries"/>gimp_size_entry_set_refval_boundaries ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_refval_boundaries</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_refval_boundaries
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> lower,
|
||||
<link linkend="gdouble">gdouble</link> upper);</programlisting>
|
||||
<para>
|
||||
Limits the range of possible reference values which can be entered in
|
||||
field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The current reference value of the <parameter>field</parameter> will be clamped to fit in the
|
||||
<parameter>field</parameter>'s new boundaries.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set the reference value boundaries for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set the reference value
|
||||
boundaries for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>lower</parameter> :</term>
|
||||
<listitem><simpara> The new lower boundary of the reference value of the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>upper</parameter> :</term>
|
||||
<listitem><simpara> The new upper boundary of the reference value of the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-refval-digits"/>gimp_size_entry_set_refval_digits ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_refval_digits</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_refval_digits
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gint">gint</link> digits);</programlisting>
|
||||
<para>
|
||||
Sets the decimal digits of field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> to
|
||||
<parameter>digits</parameter>.
|
||||
</para>
|
||||
<para>
|
||||
If you don't specify this value explicitly, the reference value's number
|
||||
of digits will equal to 0 for <link linkend="GIMP-SIZE-ENTRY-UPDATE-SIZE-CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_SIZE</type></link> and to 2 for
|
||||
<link linkend="GIMP-SIZE-ENTRY-UPDATE-RESOLUTION-CAPS"><type>GIMP_SIZE_ENTRY_UPDATE_RESOLUTION</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set the reference value digits for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set the reference value for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>digits</parameter> :</term>
|
||||
<listitem><simpara> The new number of decimal digits for the <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link> which
|
||||
displays <parameter>field</parameter>'s reference value.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-get-refval"/>gimp_size_entry_get_refval ()</title>
|
||||
<indexterm><primary>gimp_size_entry_get_refval</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_size_entry_get_refval (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field);</programlisting>
|
||||
<para>
|
||||
Returns the reference value for field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The reference value is either a distance in pixels or a resolution
|
||||
in dpi, depending on which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you chose in
|
||||
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to know a reference value of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to know the reference value of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The reference value of the chosen <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-refval"/>gimp_size_entry_set_refval ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_refval</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_refval (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field,
|
||||
<link linkend="gdouble">gdouble</link> refval);</programlisting>
|
||||
<para>
|
||||
Sets the reference value for field # <parameter>field</parameter> of the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>refval</parameter> passed is either a distance in pixels or a resolution in dpi,
|
||||
depending on which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you chose in
|
||||
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to set a reference value for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> The index of the field you want to set the reference value for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>refval</parameter> :</term>
|
||||
<listitem><simpara> The new reference value for <parameter>field</parameter>.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-get-unit"/>gimp_size_entry_get_unit ()</title>
|
||||
<indexterm><primary>gimp_size_entry_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link> gimp_size_entry_get_unit (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);</programlisting>
|
||||
<para>
|
||||
Returns the <link linkend="GimpUnit"><type>GimpUnit</type></link> the user has selected in the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s
|
||||
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to know the unit of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The sizeentry's unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-unit"/>gimp_size_entry_set_unit ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_unit</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_unit (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
|
||||
<para>
|
||||
Sets the <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>'s unit. The reference value for all fields will
|
||||
stay the same but the value in units or pixels per unit will change
|
||||
according to which <link linkend="GimpSizeEntryUpdatePolicy"><type>GimpSizeEntryUpdatePolicy</type></link> you chose in
|
||||
<link linkend="gimp-size-entry-new"><function>gimp_size_entry_new()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to change the unit for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The new unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-set-pixel-digits"/>gimp_size_entry_set_pixel_digits ()</title>
|
||||
<indexterm><primary>gimp_size_entry_set_pixel_digits</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_set_pixel_digits
|
||||
(<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> digits);</programlisting>
|
||||
<para>
|
||||
Similar to <link linkend="gimp-unit-menu-set-pixel-digits"><function>gimp_unit_menu_set_pixel_digits()</function></link>, this function allows
|
||||
you set up a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> so that sub-pixel sizes can be entered.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>digits</parameter> :</term>
|
||||
<listitem><simpara> the number of digits to display for a pixel size
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-grab-focus"/>gimp_size_entry_grab_focus ()</title>
|
||||
<indexterm><primary>gimp_size_entry_grab_focus</primary></indexterm><programlisting><link linkend="void">void</link> gimp_size_entry_grab_focus (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse);</programlisting>
|
||||
<para>
|
||||
This function is rather ugly and just a workaround for the fact that
|
||||
it's impossible to implement <link linkend="gtk-widget-grab-focus"><function>gtk_widget_grab_focus()</function></link> for a <link linkend="GtkTable"><type>GtkTable</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> The sizeentry you want to grab the keyboard focus.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-size-entry-get-help-widget"/>gimp_size_entry_get_help_widget ()</title>
|
||||
<indexterm><primary>gimp_size_entry_get_help_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_size_entry_get_help_widget (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gse,
|
||||
<link linkend="gint">gint</link> field);</programlisting>
|
||||
<para>
|
||||
You shouldn't fiddle with the internals of a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> but
|
||||
if you want to set tooltips using <link linkend="gimp-help-set-help-data"><function>gimp_help_set_help_data()</function></link> you
|
||||
can use this function to get a pointer to the spinbuttons.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gse</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>field</parameter> :</term>
|
||||
<listitem><simpara> the index of the widget you want to get a pointer to
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GtkWidget"><type>GtkWidget</type></link> pointer that you can attach a tooltip to.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpSizeEntry-refval-changed"/>The "refval-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpsizeentry</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2><refsect2><title><anchor id="GimpSizeEntry-unit-changed"/>The "unit-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpsizeentry</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2><refsect2><title><anchor id="GimpSizeEntry-value-changed"/>The "value-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpSizeEntry">GimpSizeEntry</link> *gimpsizeentry,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>gimpsizeentry</parameter> :</term>
|
||||
<listitem><simpara>the object which received the signal.
|
||||
|
||||
</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></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GimpUnit"><type>GimpUnit</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="gimp-coordinates-new"><function>gimp_coordinates_new()</function></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
1594
devel-docs/libgimpwidgets/xml/gimpstock.xml
Normal file
1594
devel-docs/libgimpwidgets/xml/gimpstock.xml
Normal file
File diff suppressed because it is too large
Load Diff
277
devel-docs/libgimpwidgets/xml/gimpunitmenu.xml
Normal file
277
devel-docs/libgimpwidgets/xml/gimpunitmenu.xml
Normal file
@ -0,0 +1,277 @@
|
||||
<?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="GimpUnitMenu">
|
||||
<refmeta>
|
||||
<refentrytitle>GimpUnitMenu</refentrytitle>
|
||||
<manvolnum>3</manvolnum>
|
||||
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
|
||||
</refmeta>
|
||||
|
||||
<refnamediv>
|
||||
<refname>GimpUnitMenu</refname><refpurpose>Widget for selecting a <link linkend="GimpUnit"><type>GimpUnit</type></link>.</refpurpose>
|
||||
</refnamediv>
|
||||
|
||||
<refsynopsisdiv><title>Synopsis</title>
|
||||
|
||||
<synopsis>
|
||||
|
||||
|
||||
|
||||
struct <link linkend="GimpUnitMenu-struct">GimpUnitMenu</link>;
|
||||
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-unit-menu-new">gimp_unit_menu_new</link> (const <link linkend="gchar">gchar</link> *format,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
<link linkend="gboolean">gboolean</link> show_pixels,
|
||||
<link linkend="gboolean">gboolean</link> show_percent,
|
||||
<link linkend="gboolean">gboolean</link> show_custom);
|
||||
<link linkend="void">void</link> <link linkend="gimp-unit-menu-set-unit">gimp_unit_menu_set_unit</link> (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit);
|
||||
<link linkend="GimpUnit">GimpUnit</link> <link linkend="gimp-unit-menu-get-unit">gimp_unit_menu_get_unit</link> (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);
|
||||
<link linkend="gint">gint</link> <link linkend="gimp-unit-menu-get-pixel-digits">gimp_unit_menu_get_pixel_digits</link> (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);
|
||||
<link linkend="void">void</link> <link linkend="gimp-unit-menu-set-pixel-digits">gimp_unit_menu_set_pixel_digits</link> (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
|
||||
<link linkend="gint">gint</link> digits);
|
||||
|
||||
</synopsis>
|
||||
</refsynopsisdiv>
|
||||
|
||||
<refsect1>
|
||||
<title>Object Hierarchy</title>
|
||||
<synopsis>
|
||||
|
||||
<link linkend="GObject">GObject</link>
|
||||
+----<link linkend="GtkObject">GtkObject</link>
|
||||
+----<link linkend="GtkWidget">GtkWidget</link>
|
||||
+----<link linkend="GtkContainer">GtkContainer</link>
|
||||
+----<link linkend="GtkBin">GtkBin</link>
|
||||
+----<link linkend="GtkButton">GtkButton</link>
|
||||
+----<link linkend="GtkOptionMenu">GtkOptionMenu</link>
|
||||
+----GimpUnitMenu
|
||||
</synopsis>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Implemented Interfaces</title>
|
||||
<para>
|
||||
GimpUnitMenu implements
|
||||
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
||||
|
||||
</refsect1>
|
||||
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Signal Prototypes</title>
|
||||
<synopsis>
|
||||
|
||||
"<link linkend="GimpUnitMenu-unit-changed">unit-changed</link>"
|
||||
<link linkend="void">void</link> user_function (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);
|
||||
</synopsis>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<para>
|
||||
This widget provides a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> which contains a list of <link linkend="GimpUnit"><type>GimpUnit</type></link>'s.
|
||||
</para>
|
||||
<para>
|
||||
You can specify the string that will be displayed for each unit by
|
||||
passing a printf-like <parameter>format</parameter> string to <link linkend="gimp-unit-menu-new"><function>gimp_unit_menu_new()</function></link>.
|
||||
</para>
|
||||
<para>
|
||||
The constructor also lets you choose if the menu should contain items
|
||||
for GIMP_UNIT_PIXEL, GIMP_UNIT_PERCENT and a "More..." item which will
|
||||
pop up a dialog for selecting user-defined units.
|
||||
</para>
|
||||
<para>
|
||||
Whenever the user selects a unit from the menu or the dialog, the
|
||||
"unit_changed" signal will be emitted.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Details</title>
|
||||
<refsect2>
|
||||
<title><anchor id="GimpUnitMenu-struct"/>struct GimpUnitMenu</title>
|
||||
<indexterm><primary>GimpUnitMenu</primary></indexterm><programlisting>struct GimpUnitMenu;</programlisting>
|
||||
<para>
|
||||
|
||||
</para></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-unit-menu-new"/>gimp_unit_menu_new ()</title>
|
||||
<indexterm><primary>gimp_unit_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_unit_menu_new (const <link linkend="gchar">gchar</link> *format,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit,
|
||||
<link linkend="gboolean">gboolean</link> show_pixels,
|
||||
<link linkend="gboolean">gboolean</link> show_percent,
|
||||
<link linkend="gboolean">gboolean</link> show_custom);</programlisting>
|
||||
<para>
|
||||
Creates a new <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> widget.
|
||||
</para>
|
||||
<para>
|
||||
The <parameter>format</parameter> string supports the following percent expansions:
|
||||
</para>
|
||||
<para>
|
||||
<informaltable pgwide="1" frame="none" role="enum">
|
||||
<tgroup cols="2"><colspec colwidth="1*"/><colspec colwidth="8*"/>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>% f</entry>
|
||||
<entry>Factor (how many units make up an inch)</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>% y</entry>
|
||||
<entry>Symbol (e.g. "''" for GIMP_UNIT_INCH)</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>% a</entry>
|
||||
<entry>Abbreviation</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>% s</entry>
|
||||
<entry>Singular</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>% p</entry>
|
||||
<entry>Plural</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>%%</entry>
|
||||
<entry>Literal percent</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable></para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>format</parameter> :</term>
|
||||
<listitem><simpara> A printf-like format string which is used to create the unit
|
||||
strings.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The initially selected unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>show_pixels</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the unit menu should contain an item for
|
||||
GIMP_UNIT_PIXEL.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>show_percent</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> in the unit menu should contain an item for
|
||||
GIMP_UNIT_PERCENT.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>show_custom</parameter> :</term>
|
||||
<listitem><simpara> <literal>TRUE</literal> if the unit menu should contain a "More..." item for
|
||||
opening the user-defined-unit selection dialog.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link> widget.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-unit-menu-set-unit"/>gimp_unit_menu_set_unit ()</title>
|
||||
<indexterm><primary>gimp_unit_menu_set_unit</primary></indexterm><programlisting><link linkend="void">void</link> gimp_unit_menu_set_unit (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
|
||||
<link linkend="GimpUnit">GimpUnit</link> unit);</programlisting>
|
||||
<para>
|
||||
Sets a new <link linkend="GimpUnit"><type>GimpUnit</type></link> for the specified <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu</parameter> :</term>
|
||||
<listitem><simpara> The unit menu you want to set the unit for.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>unit</parameter> :</term>
|
||||
<listitem><simpara> The new unit.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-unit-menu-get-unit"/>gimp_unit_menu_get_unit ()</title>
|
||||
<indexterm><primary>gimp_unit_menu_get_unit</primary></indexterm><programlisting><link linkend="GimpUnit">GimpUnit</link> gimp_unit_menu_get_unit (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);</programlisting>
|
||||
<para>
|
||||
Returns the <link linkend="GimpUnit"><type>GimpUnit</type></link> the user has selected from the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu</parameter> :</term>
|
||||
<listitem><simpara> The unit menu you want to know the unit of.
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The unit the user has selected.
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-unit-menu-get-pixel-digits"/>gimp_unit_menu_get_pixel_digits ()</title>
|
||||
<indexterm><primary>gimp_unit_menu_get_pixel_digits</primary></indexterm><programlisting><link linkend="gint">gint</link> gimp_unit_menu_get_pixel_digits (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu);</programlisting>
|
||||
<para>
|
||||
Retrieve the number of digits for a pixel size as set by
|
||||
<link linkend="gimp-unit-set-pixel-digits"><function>gimp_unit_set_pixel_digits()</function></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the configured number of digits for a pixel size
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
<refsect2>
|
||||
<title><anchor id="gimp-unit-menu-set-pixel-digits"/>gimp_unit_menu_set_pixel_digits ()</title>
|
||||
<indexterm><primary>gimp_unit_menu_set_pixel_digits</primary></indexterm><programlisting><link linkend="void">void</link> gimp_unit_menu_set_pixel_digits (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *menu,
|
||||
<link linkend="gint">gint</link> digits);</programlisting>
|
||||
<para>
|
||||
A GimpUnitMenu can be setup to control the number of digits shown
|
||||
by attached spinbuttons. Please refer to the documentation of
|
||||
<link linkend="gimp-unit-menu-update"><function>gimp_unit_menu_update()</function></link> to see how this is done.
|
||||
</para>
|
||||
<para>
|
||||
This function allows to specify the number of digits shown for a
|
||||
size in pixels. Usually this is 0 (only full pixels). If you want
|
||||
to allow the user to specify sub-pixel sizes using the attached
|
||||
spinbuttons, specify the number of digits after the decimal point
|
||||
here. You should do this after attaching your spinbuttons.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>menu</parameter> :</term>
|
||||
<listitem><simpara> a <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>
|
||||
</simpara></listitem></varlistentry>
|
||||
<varlistentry><term><parameter>digits</parameter> :</term>
|
||||
<listitem><simpara> the number of digits to display for a pixel size
|
||||
</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
|
||||
</refsect1>
|
||||
|
||||
<refsect1>
|
||||
<title>Signals</title>
|
||||
<refsect2><title><anchor id="GimpUnitMenu-unit-changed"/>The "unit-changed" signal</title>
|
||||
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpUnitMenu">GimpUnitMenu</link> *,
|
||||
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
|
||||
<para>
|
||||
This signal is emitted whenever the user selects a <link linkend="GimpUnit"><type>GimpUnit</type></link> from
|
||||
the <link linkend="GimpUnitMenu"><type>GimpUnitMenu</type></link>.</para>
|
||||
<para>
|
||||
|
||||
</para><variablelist role="params">
|
||||
<varlistentry><term><parameter>user_data</parameter> :</term>
|
||||
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
|
||||
</variablelist></refsect2>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1>
|
||||
<title>See Also</title>
|
||||
<para>
|
||||
<link linkend="GimpUnit"><type>GimpUnit</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link>
|
||||
</para>
|
||||
<para>
|
||||
<link linkend="gimp-coordinates-new"><function>gimp_coordinates_new()</function></link>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
</refentry>
|
||||
1062
devel-docs/libgimpwidgets/xml/gimpwidgets.xml
Normal file
1062
devel-docs/libgimpwidgets/xml/gimpwidgets.xml
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user