Files
gimp/devel-docs/libgimp/xml/gimpmenu.xml
2010-08-11 01:27:05 -04:00

206 lines
13 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="libgimp-gimpmenu">
<refmeta>
<refentrytitle role="top_of_page" id="libgimp-gimpmenu.top_of_page">gimpmenu</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpmenu</refname>
<refpurpose>Menus for selecting images, layers, channels and drawables</refpurpose>
</refnamediv>
<refsynopsisdiv id="libgimp-gimpmenu.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> (<link linkend="GimpConstraintFunc">*GimpConstraintFunc</link>) (<link linkend="gint32">gint32</link> image_id,
<link linkend="gint32">gint32</link> drawable_id,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> (<link linkend="GimpMenuCallback">*GimpMenuCallback</link>) (<link linkend="gint32">gint32</link> any_id,
<link linkend="gpointer">gpointer</link> data);
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-image-menu-new">gimp_image_menu_new</link> (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_image);
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-layer-menu-new">gimp_layer_menu_new</link> (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_layer);
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-channel-menu-new">gimp_channel_menu_new</link> (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_channel);
<link linkend="GtkWidget">GtkWidget</link> * <link linkend="gimp-drawable-menu-new">gimp_drawable_menu_new</link> (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_drawable);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libgimp-gimpmenu.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libgimp-gimpmenu.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GimpConstraintFunc" role="function" condition="deprecated:">
<title>GimpConstraintFunc ()</title>
<indexterm zone="GimpConstraintFunc" role="deprecated"><primary sortas="GimpConstraintFunc">GimpConstraintFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> (*GimpConstraintFunc) (<link linkend="gint32">gint32</link> image_id,
<link linkend="gint32">gint32</link> drawable_id,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<warning><para><literal>GimpConstraintFunc</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>image_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>drawable_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="GimpMenuCallback" role="function" condition="deprecated:">
<title>GimpMenuCallback ()</title>
<indexterm zone="GimpMenuCallback" role="deprecated"><primary sortas="GimpMenuCallback">GimpMenuCallback</primary></indexterm><programlisting><link linkend="void">void</link> (*GimpMenuCallback) (<link linkend="gint32">gint32</link> any_id,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<warning><para><literal>GimpMenuCallback</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>any_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-image-menu-new" role="function" condition="deprecated:">
<title>gimp_image_menu_new ()</title>
<indexterm zone="gimp-image-menu-new" role="deprecated"><primary sortas="gimp_image_menu_new">gimp_image_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_image_menu_new (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_image);</programlisting>
<warning><para><literal>gimp_image_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Use <link linkend="gimp-image-combo-box-new"><function>gimp_image_combo_box_new()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>active_image</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-layer-menu-new" role="function" condition="deprecated:">
<title>gimp_layer_menu_new ()</title>
<indexterm zone="gimp-layer-menu-new" role="deprecated"><primary sortas="gimp_layer_menu_new">gimp_layer_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_layer_menu_new (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_layer);</programlisting>
<warning><para><literal>gimp_layer_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Use <link linkend="gimp-layer-combo-box-new"><function>gimp_layer_combo_box_new()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>active_layer</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-channel-menu-new" role="function" condition="deprecated:">
<title>gimp_channel_menu_new ()</title>
<indexterm zone="gimp-channel-menu-new" role="deprecated"><primary sortas="gimp_channel_menu_new">gimp_channel_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_channel_menu_new (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_channel);</programlisting>
<warning><para><literal>gimp_channel_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Use <link linkend="gimp-channel-combo-box-new"><function>gimp_channel_combo_box_new()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>active_channel</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gimp-drawable-menu-new" role="function" condition="deprecated:">
<title>gimp_drawable_menu_new ()</title>
<indexterm zone="gimp-drawable-menu-new" role="deprecated"><primary sortas="gimp_drawable_menu_new">gimp_drawable_menu_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> * gimp_drawable_menu_new (<link linkend="GimpConstraintFunc">GimpConstraintFunc</link> constraint,
<link linkend="GimpMenuCallback">GimpMenuCallback</link> callback,
<link linkend="gpointer">gpointer</link> data,
<link linkend="gint32">gint32</link> active_drawable);</programlisting>
<warning><para><literal>gimp_drawable_menu_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Use <link linkend="gimp-drawable-combo-box-new"><function>gimp_drawable_combo_box_new()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>constraint</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>callback</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>active_drawable</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>