223 lines
11 KiB
XML
223 lines
11 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="GimpDrawableComboBox">
|
|
<refmeta>
|
|
<refentrytitle>gimpdrawablecombobox</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpdrawablecombobox</refname><refpurpose>A widget providing a popup menu of drawables.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
<anchor id="GimpChannelComboBox"/><anchor id="GimpLayerComboBox"/>
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GimpDrawableComboBox-struct">GimpDrawableComboBox</link>;
|
|
<link linkend="gboolean">gboolean</link> (<link linkend="GimpDrawableConstraintFunc">*GimpDrawableConstraintFunc</link>) (<link linkend="gint32">gint32</link> image_id,
|
|
<link linkend="gint32">gint32</link> drawable_id,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-drawable-combo-box-new">gimp_drawable_combo_box_new</link> (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="GimpChannelComboBox-struct">GimpChannelComboBox</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-channel-combo-box-new">gimp_channel_combo_box_new</link> (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
|
|
<link linkend="gpointer">gpointer</link> data);
|
|
<link linkend="GimpLayerComboBox-struct">GimpLayerComboBox</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-layer-combo-box-new">gimp_layer_combo_box_new</link> (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
|
|
<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>
|
|
+----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
|
|
+----GimpDrawableComboBox
|
|
</synopsis>
|
|
<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>
|
|
+----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
|
|
+----GimpChannelComboBox
|
|
</synopsis>
|
|
<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>
|
|
+----<link linkend="GimpIntComboBox">GimpIntComboBox</link>
|
|
+----GimpLayerComboBox
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Implemented Interfaces</title>
|
|
<para>
|
|
GimpDrawableComboBox implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkCellLayout">GtkCellLayout</link> and <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
|
|
<para>
|
|
GimpChannelComboBox implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkCellLayout">GtkCellLayout</link> and <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
|
|
<para>
|
|
GimpLayerComboBox implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkCellLayout">GtkCellLayout</link> and <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
A widget providing a popup menu of drawables.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpDrawableComboBox-struct"/>GimpDrawableComboBox</title>
|
|
<indexterm><primary>GimpDrawableComboBox</primary></indexterm><programlisting>typedef struct _GimpDrawableComboBox GimpDrawableComboBox;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="GimpDrawableConstraintFunc"/>GimpDrawableConstraintFunc ()</title>
|
|
<indexterm><primary>GimpDrawableConstraintFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpDrawableConstraintFunc) (<link linkend="gint32">gint32</link> image_id,
|
|
<link linkend="gint32">gint32</link> drawable_id,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_id</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>drawable_id</parameter> :</term>
|
|
<listitem><simpara>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>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-drawable-combo-box-new"/>gimp_drawable_combo_box_new ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_drawable_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_drawable_combo_box_new (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
|
|
drawables. If a <parameter>constraint</parameter> function is specified, it is called for
|
|
each drawable and only if the function returns <literal>TRUE</literal>, the drawable
|
|
is added to the combobox.
|
|
</para>
|
|
<para>
|
|
You should use <link linkend="gimp-int-combo-box-connect"><function>gimp_int_combo_box_connect()</function></link> to initialize and connect
|
|
the combo. Use <link linkend="gimp-int-combo-box-set-active"><function>gimp_int_combo_box_set_active()</function></link> to get the active
|
|
drawable ID and <link linkend="gimp-int-combo-box-get-active"><function>gimp_int_combo_box_get_active()</function></link> to retrieve the ID
|
|
of the selected drawable.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>constraint</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <literal>NULL</literal>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara> a pointer that is passed to <parameter>constraint</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="GimpChannelComboBox-struct"/>GimpChannelComboBox</title>
|
|
<indexterm><primary>GimpChannelComboBox</primary></indexterm><programlisting>typedef struct _GimpChannelComboBox GimpChannelComboBox;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-channel-combo-box-new"/>gimp_channel_combo_box_new ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_channel_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_channel_combo_box_new (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
|
|
channels. See <link linkend="gimp-drawable-combo-box"><function>gimp_drawable_combo_box()</function></link> for more info.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>constraint</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <literal>NULL</literal>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara> a pointer that is passed to <parameter>constraint</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="GimpLayerComboBox-struct"/>GimpLayerComboBox</title>
|
|
<indexterm><primary>GimpLayerComboBox</primary></indexterm><programlisting>typedef struct _GimpLayerComboBox GimpLayerComboBox;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-layer-combo-box-new"/>gimp_layer_combo_box_new ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_layer_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_layer_combo_box_new (<link linkend="GimpDrawableConstraintFunc">GimpDrawableConstraintFunc</link> constraint,
|
|
<link linkend="gpointer">gpointer</link> data);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpIntComboBox"><type>GimpIntComboBox</type></link> filled with all currently opened
|
|
layers. See <link linkend="gimp-drawable-combo-box"><function>gimp_drawable_combo_box()</function></link> for more info.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>constraint</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawableConstraintFunc"><type>GimpDrawableConstraintFunc</type></link> or <literal>NULL</literal>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>data</parameter> :</term>
|
|
<listitem><simpara> a pointer that is passed to <parameter>constraint</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>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|