callisto-debian/gimp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Imported Upstream version 2.4.0~rc1

Browse Source
This commit is contained in:
Ari Pollak
2010-08-11 01:22:21 -04:00
parent 5516c26b4b
commit d884b2912c
672 changed files with 122964 additions and 82169 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
devel-docs/libgimpwidgets/xml/gimpcolordisplay.xml
View File

@ -28,6 +28,8 @@
<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="GimpColorConfig">GimpColorConfig</link>* <link linkend="gimp-color-display-get-config">gimp_color_display_get_config</link> (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);
<link linkend="GimpColorManaged">GimpColorManaged</link>* <link linkend="gimp-color-display-get-managed">gimp_color_display_get_managed</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,
@ -69,6 +71,8 @@ GimpColorDisplay implements
<title role="properties.title">Properties</title>
<synopsis>
&quot;<link linkend="GimpColorDisplay--color-config">color-config</link>&quot; <link linkend="GimpColorConfig">GimpColorConfig</link> : Read / Write / Construct Only
&quot;<link linkend="GimpColorDisplay--color-managed">color-managed</link>&quot; <link linkend="GimpColorManagedInterface">GimpColorManagedInterface</link> : Read / Write / Construct Only
&quot;<link linkend="GimpColorDisplay--enabled">enabled</link>&quot; <link linkend="gboolean">gboolean</link> : Read / Write / Construct
</synopsis>
</refsect1>
@ -99,17 +103,18 @@ display color correction modules.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-display-new" role="function"/>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>
<title><anchor id="gimp-color-display-new" role="function" condition="deprecated:"/>gimp_color_display_new ()</title>
<indexterm role="deprecated"><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>
<warning><para><literal>gimp_color_display_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This function is deprecated. Please use <link linkend="g-object-new"><function>g_object_new()</function></link> directly.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>display_type</parameter>&nbsp;:</term>
<listitem><simpara>
<listitem><simpara> the GType of the GimpColorDisplay to instantiate.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpColorDisplay"><literal>GimpColorDisplay</literal></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
@ -157,6 +162,38 @@ display color correction modules.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-color-display-get-config" role="function" condition="since:GIMP 2.4"/>gimp_color_display_get_config ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_display_get_config</primary></indexterm><programlisting><link linkend="GimpColorConfig">GimpColorConfig</link>* gimp_color_display_get_config (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>display</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to the <link linkend="GimpColorConfig"><type>GimpColorConfig</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-display-get-managed" role="function" condition="since:GIMP 2.4"/>gimp_color_display_get_managed ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_display_get_managed</primary></indexterm><programlisting><link linkend="GimpColorManaged">GimpColorManaged</link>* gimp_color_display_get_managed (<link linkend="GimpColorDisplay">GimpColorDisplay</link> *display);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>display</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a pointer to the <link linkend="GimpColorManaged"><type>GimpColorManaged</type></link> object or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-display-convert" role="function"/>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,
@ -260,6 +297,12 @@ display color correction modules.
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpColorDisplay--color-config"/>The &quot;<literal>color-config</literal>&quot; property</title>
<indexterm><primary>GimpColorDisplay:color-config</primary></indexterm><programlisting> &quot;color-config&quot; <link linkend="GimpColorConfig">GimpColorConfig</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="GimpColorDisplay--color-managed"/>The &quot;<literal>color-managed</literal>&quot; property</title>
<indexterm><primary>GimpColorDisplay:color-managed</primary></indexterm><programlisting> &quot;color-managed&quot; <link linkend="GimpColorManagedInterface">GimpColorManagedInterface</link> : Read / Write / Construct Only</programlisting>
<para></para></refsect2>
<refsect2><title><anchor id="GimpColorDisplay--enabled"/>The &quot;<literal>enabled</literal>&quot; property</title>
<indexterm><primary>GimpColorDisplay:enabled</primary></indexterm><programlisting> &quot;enabled&quot; <link linkend="gboolean">gboolean</link> : Read / Write / Construct</programlisting>
<para></para><para>Default value: TRUE</para>

249
devel-docs/libgimpwidgets/xml/gimpcolorprofilecombobox.xml Normal file
View File

@ -0,0 +1,249 @@
<?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="GimpColorProfileComboBox">
<refmeta>
<refentrytitle role="top_of_page">GimpColorProfileComboBox</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpColorProfileComboBox</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpColorProfileComboBox-struct">GimpColorProfileComboBox</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-profile-combo-box-new">gimp_color_profile_combo_box_new</link> (<link linkend="GtkWidget">GtkWidget</link> *dialog,
const <link linkend="gchar">gchar</link> *history);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-color-profile-combo-box-new-with-model">gimp_color_profile_combo_box_new_with_model</link>
(<link linkend="GtkWidget">GtkWidget</link> *dialog,
<link linkend="GtkTreeModel">GtkTreeModel</link> *model);
<link linkend="void">void</link> <link linkend="gimp-color-profile-combo-box-add">gimp_color_profile_combo_box_add</link> (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *label);
<link linkend="void">void</link> <link linkend="gimp-color-profile-combo-box-set-active">gimp_color_profile_combo_box_set_active</link>
(<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *label);
<link linkend="gchar">gchar</link>* <link linkend="gimp-color-profile-combo-box-get-active">gimp_color_profile_combo_box_get_active</link>
(<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBin">GtkBin</link>
+----<link linkend="GtkComboBox">GtkComboBox</link>
+----GimpColorProfileComboBox
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpColorProfileComboBox implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkCellEditable">GtkCellEditable</link> and <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
&quot;<link linkend="GimpColorProfileComboBox--dialog">dialog</link>&quot; <link linkend="GtkDialog">GtkDialog</link> : Read / Write / Construct Only
&quot;<link linkend="GimpColorProfileComboBox--model">model</link>&quot; <link linkend="GimpColorProfileStore">GimpColorProfileStore</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpColorProfileComboBox-struct" role="struct"/>GimpColorProfileComboBox</title>
<indexterm><primary>GimpColorProfileComboBox</primary></indexterm><programlisting>typedef struct _GimpColorProfileComboBox GimpColorProfileComboBox;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-combo-box-new" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_combo_box_new ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_combo_box_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_profile_combo_box_new (<link linkend="GtkWidget">GtkWidget</link> *dialog,
const <link linkend="gchar">gchar</link> *history);</programlisting>
<para>
Create a combo-box widget for selecting color profiles. The combo-box
is populated from the file specified as <parameter>history</parameter>. This filename is
typically created using the following code snippet:
<informalexample><programlisting>
gchar *history = gimp_personal_rc_file ("profilerc");
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GtkDialog"><type>GtkDialog</type></link> to present when the user selects the
"Select color profile from disk..." item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>history</parameter>&nbsp;:</term>
<listitem><simpara> filename of the profilerc (or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for no history)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-combo-box-new-with-model" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_combo_box_new_with_model ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_combo_box_new_with_model</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_color_profile_combo_box_new_with_model
(<link linkend="GtkWidget">GtkWidget</link> *dialog,
<link linkend="GtkTreeModel">GtkTreeModel</link> *model);</programlisting>
<para>
This constructor is useful when you want to create several
combo-boxes for profile selection that all share the same
<link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>. This is for example done in the
GIMP Preferences dialog.
</para>
<para>
See also <link linkend="gimp-color-profile-combo-box-new"><function>gimp_color_profile_combo_box_new()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>dialog</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GtkDialog"><type>GtkDialog</type></link> to present when the user selects the
"Select color profile from disk..." item
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>model</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link> object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-combo-box-add" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_combo_box_add ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_combo_box_add</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_profile_combo_box_add (<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *label);</programlisting>
<para>
This function delegates to the underlying
<link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>. Please refer to the documentation of
<link linkend="gimp-color-profile-store-add"><function>gimp_color_profile_store_add()</function></link> for details.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> filename of the profile to add (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
<listitem><simpara> label to use for the profile
(may only be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>filename</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-combo-box-set-active" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_combo_box_set_active ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_combo_box_set_active</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_profile_combo_box_set_active
(<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *label);</programlisting>
<para>
Selects a color profile from the <parameter>combo</parameter> and makes it the active
item. If the profile is not listed in the <parameter>combo</parameter>, then it is
added.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> filename of the profile to select
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
<listitem><simpara> label
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-combo-box-get-active" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_combo_box_get_active ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_combo_box_get_active</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_color_profile_combo_box_get_active
(<link linkend="GimpColorProfileComboBox">GimpColorProfileComboBox</link> *combo);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>combo</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The filename of the currently selected color profile.
This is a newly allocated string and should be released
using <link linkend="g-free"><function>g_free()</function></link> when it is not any longer needed.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpColorProfileComboBox--dialog"/>The &quot;<literal>dialog</literal>&quot; property</title>
<indexterm role="GIMP 2.4"><primary>GimpColorProfileComboBox:dialog</primary></indexterm><programlisting> &quot;dialog&quot; <link linkend="GtkDialog">GtkDialog</link> : Read / Write / Construct Only</programlisting>
<para>
<link linkend="GtkDialog"><type>GtkDialog</type></link> to present when the user selects the
"Select color profile from disk..." item.</para>
<para>
</para><para>Since GIMP 2.4
</para>
</refsect2>
<refsect2><title><anchor id="GimpColorProfileComboBox--model"/>The &quot;<literal>model</literal>&quot; property</title>
<indexterm role="GIMP 2.4"><primary>GimpColorProfileComboBox:model</primary></indexterm><programlisting> &quot;model&quot; <link linkend="GimpColorProfileStore">GimpColorProfileStore</link> : Read / Write</programlisting>
<para>
Overrides the "model" property of the <link linkend="GtkComboBox"><type>GtkComboBox</type></link> class.
<link linkend="GimpColorProfileComboBox"><type>GimpColorProfileComboBox</type></link> requires the model to be a
<link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>.</para>
<para>
</para><para>Since GIMP 2.4
</para>
</refsect2>
</refsect1>
</refentry>

156
devel-docs/libgimpwidgets/xml/gimpcolorprofilestore.xml Normal file
View File

@ -0,0 +1,156 @@
<?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="GimpColorProfileStore">
<refmeta>
<refentrytitle role="top_of_page">GimpColorProfileStore</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpColorProfileStore</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpColorProfileStore-struct">GimpColorProfileStore</link>;
<link linkend="GtkListStore">GtkListStore</link>* <link linkend="gimp-color-profile-store-new">gimp_color_profile_store_new</link> (const <link linkend="gchar">gchar</link> *history);
<link linkend="void">void</link> <link linkend="gimp-color-profile-store-add">gimp_color_profile_store_add</link> (<link linkend="GimpColorProfileStore">GimpColorProfileStore</link> *store,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *label);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GtkListStore">GtkListStore</link>
+----GimpColorProfileStore
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpColorProfileStore 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 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
&quot;<link linkend="GimpColorProfileStore--history">history</link>&quot; <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpColorProfileStore-struct" role="struct"/>GimpColorProfileStore</title>
<indexterm><primary>GimpColorProfileStore</primary></indexterm><programlisting>typedef struct _GimpColorProfileStore GimpColorProfileStore;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-store-new" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_store_new ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_store_new</primary></indexterm><programlisting><link linkend="GtkListStore">GtkListStore</link>* gimp_color_profile_store_new (const <link linkend="gchar">gchar</link> *history);</programlisting>
<para>
Creates a new <link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link> object and populates it with
last used profiles read from the file <parameter>history</parameter>. The updated history
is written back to disk when the store is disposed.
</para>
<para>
The filename passed as <parameter>history</parameter> is typically created using the
following code snippet:
<informalexample><programlisting>
gchar *history = gimp_personal_rc_file ("profilerc");
</programlisting></informalexample></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>history</parameter>&nbsp;:</term>
<listitem><simpara> filename of the profilerc (or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for no history)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-color-profile-store-add" role="function" condition="since:GIMP 2.4"/>gimp_color_profile_store_add ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_color_profile_store_add</primary></indexterm><programlisting><link linkend="void">void</link> gimp_color_profile_store_add (<link linkend="GimpColorProfileStore">GimpColorProfileStore</link> *store,
const <link linkend="gchar">gchar</link> *filename,
const <link linkend="gchar">gchar</link> *label);</programlisting>
<para>
Adds a color profile item to the <link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>. Items
added with this function will be kept at the top, separated from
the history of last used color profiles.
</para>
<para>
This function is often used to add a selectable item for the <link linkend="NULL:CAPS"><literal>NULL</literal></link>
filename. If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> for both <parameter>filename</parameter> and <parameter>label</parameter>, the
<parameter>label</parameter> will be set to the string "None" for you (and translated for
the user).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>store</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpColorProfileStore"><type>GimpColorProfileStore</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> filename of the profile to add (or <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter>&nbsp;:</term>
<listitem><simpara> label to use for the profile
(may only be <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>filename</parameter> is <link linkend="NULL:CAPS"><literal>NULL</literal></link>)
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpColorProfileStore--history"/>The &quot;<literal>history</literal>&quot; property</title>
<indexterm role="GIMP 2.4"><primary>GimpColorProfileStore:history</primary></indexterm><programlisting> &quot;history&quot; <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>
Filename of the color history used to populate the profile store.</para>
<para>
</para><para>Default value: NULL</para>
<para>Since GIMP 2.4
</para>
</refsect2>
</refsect1>
</refentry>

477
devel-docs/libgimpwidgets/xml/gimpnumberpairentry.xml Normal file
View File

@ -0,0 +1,477 @@
<?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="GimpNumberPairEntry">
<refmeta>
<refentrytitle role="top_of_page">GimpNumberPairEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpNumberPairEntry</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpNumberPairEntry-struct">GimpNumberPairEntry</link>;
enum <link linkend="GimpAspectType">GimpAspectType</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-number-pair-entry-new">gimp_number_pair_entry_new</link> (const <link linkend="gchar">gchar</link> *separators,
<link linkend="gboolean">gboolean</link> allow_simplification,
<link linkend="gdouble">gdouble</link> min_valid_value,
<link linkend="gdouble">gdouble</link> max_valid_value);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-set-default-values">gimp_number_pair_entry_set_default_values</link>
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> left,
<link linkend="gdouble">gdouble</link> right);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-get-default-values">gimp_number_pair_entry_get_default_values</link>
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> *left,
<link linkend="gdouble">gdouble</link> *right);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-set-values">gimp_number_pair_entry_set_values</link> (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> left,
<link linkend="gdouble">gdouble</link> right);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-get-values">gimp_number_pair_entry_get_values</link> (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> *left,
<link linkend="gdouble">gdouble</link> *right);
<link linkend="GimpAspectType">GimpAspectType</link> <link linkend="gimp-number-pair-entry-get-aspect">gimp_number_pair_entry_get_aspect</link> (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-set-aspect">gimp_number_pair_entry_set_aspect</link> (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="GimpAspectType">GimpAspectType</link> aspect);
<link linkend="gdouble">gdouble</link> <link linkend="gimp-number-pair-entry-get-ratio">gimp_number_pair_entry_get_ratio</link> (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-set-ratio">gimp_number_pair_entry_set_ratio</link> (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> ratio);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-number-pair-entry-get-user-override">gimp_number_pair_entry_get_user_override</link>
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry);
<link linkend="void">void</link> <link linkend="gimp-number-pair-entry-set-user-override">gimp_number_pair_entry_set_user_override</link>
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gboolean">gboolean</link> user_override);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkEntry">GtkEntry</link>
+----GimpNumberPairEntry
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpNumberPairEntry implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkEditable">GtkEditable</link> and <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
&quot;<link linkend="GimpNumberPairEntry--allow-simplification">allow-simplification</link>&quot; <link linkend="gboolean">gboolean</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--aspect">aspect</link>&quot; <link linkend="GimpAspectType">GimpAspectType</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--default-left-number">default-left-number</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--default-right-number">default-right-number</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--left-number">left-number</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--max-valid-value">max-valid-value</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--min-valid-value">min-valid-value</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--ratio">ratio</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--right-number">right-number</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpNumberPairEntry--separators">separators</link>&quot; <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only
&quot;<link linkend="GimpNumberPairEntry--user-override">user-override</link>&quot; <link linkend="gboolean">gboolean</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
&quot;<link linkend="GimpNumberPairEntry-numbers-changed">numbers-changed</link>&quot; : Run First
&quot;<link linkend="GimpNumberPairEntry-ratio-changed">ratio-changed</link>&quot; : Run First
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpNumberPairEntry-struct" role="struct"/>GimpNumberPairEntry</title>
<indexterm><primary>GimpNumberPairEntry</primary></indexterm><programlisting>typedef struct _GimpNumberPairEntry GimpNumberPairEntry;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpAspectType" role="enum"/>enum GimpAspectType</title>
<indexterm><primary>GimpAspectType</primary></indexterm><programlisting>typedef enum
{
GIMP_ASPECT_SQUARE, /*&lt; desc="Square" &gt;*/
GIMP_ASPECT_PORTRAIT, /*&lt; desc="Portrait" &gt;*/
GIMP_ASPECT_LANDSCAPE /*&lt; desc="Landscape" &gt;*/
} GimpAspectType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-new" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_new ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_number_pair_entry_new (const <link linkend="gchar">gchar</link> *separators,
<link linkend="gboolean">gboolean</link> allow_simplification,
<link linkend="gdouble">gdouble</link> min_valid_value,
<link linkend="gdouble">gdouble</link> max_valid_value);</programlisting>
<para>
Creates a new <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget, which is a GtkEntry that
accepts two numbers separated by a separator. Typical input example
with a 'x' separator: "377x233".
</para>
<para>
The widget supports simplification of the entered ratio when the
input ends in '=', if "allow-simplification" is TRUE.
</para>
<para>
The "separators" property contains a string of characters valid as
separators when parsing input. The first separator is used when
displaying the current values.
</para>
<para>
It is possible to specify what range of values that shall be
considered as valid when parsing user input, by changing
"min-valid-value" and "max-valid-value".
</para>
<para>
The first separator of <parameter>separators</parameter> is used to display the current
value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>separators</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>allow_simplification</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>min_valid_value</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_valid_value</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-set-default-values" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_set_default_values ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_set_default_values</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_set_default_values
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> left,
<link linkend="gdouble">gdouble</link> right);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter>&nbsp;:</term>
<listitem><simpara> Default left value in the entry.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter>&nbsp;:</term>
<listitem><simpara> Default right value in the entry.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-get-default-values" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_get_default_values ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_get_default_values</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_get_default_values
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> *left,
<link linkend="gdouble">gdouble</link> *right);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter>&nbsp;:</term>
<listitem><simpara> Pointer of where to put left value.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter>&nbsp;:</term>
<listitem><simpara> Pointer of where to put right value.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-set-values" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_set_values ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_set_values</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_set_values (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> left,
<link linkend="gdouble">gdouble</link> right);</programlisting>
<para>
Forces setting the numbers displayed by a <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link>,
ignoring if the user has set his/her own value. The state of
user-override will not be changed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter>&nbsp;:</term>
<listitem><simpara> Left number in the entry.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter>&nbsp;:</term>
<listitem><simpara> Right number in the entry.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-get-values" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_get_values ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_get_values</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_get_values (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> *left,
<link linkend="gdouble">gdouble</link> *right);</programlisting>
<para>
Gets the numbers displayed by a <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left</parameter>&nbsp;:</term>
<listitem><simpara> Pointer of where to store the left number (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>right</parameter>&nbsp;:</term>
<listitem><simpara> Pointer of to store the right number (may be <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-get-aspect" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_get_aspect ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_get_aspect</primary></indexterm><programlisting><link linkend="GimpAspectType">GimpAspectType</link> gimp_number_pair_entry_get_aspect (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry);</programlisting>
<para>
Gets the aspect of the ratio displayed by a <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The entry's current aspect.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-set-aspect" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_set_aspect ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_set_aspect</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_set_aspect (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="GimpAspectType">GimpAspectType</link> aspect);</programlisting>
<para>
Sets the aspect of the ratio by swapping the left_number and
right_number if necessary (or setting them to 1.0 in case that
<parameter>aspect</parameter> is <link linkend="GIMP-ASPECT-SQUARE:CAPS"><literal>GIMP_ASPECT_SQUARE</literal></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>aspect</parameter>&nbsp;:</term>
<listitem><simpara> The new aspect.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-get-ratio" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_get_ratio ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_get_ratio</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_number_pair_entry_get_ratio (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry);</programlisting>
<para>
Retrieves the ratio of the numbers displayed by a <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The ratio value.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-set-ratio" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_set_ratio ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_set_ratio</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_set_ratio (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gdouble">gdouble</link> ratio);</programlisting>
<para>
Sets the numbers of the <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> to have the desired
ratio. If the new ratio is different than the previous ratio, the
"ratio-changed" signal is emitted.
</para>
<para>
An attempt is made to convert the decimal number into a fraction
with left_number and right_number &lt; 1000.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ratio</parameter>&nbsp;:</term>
<listitem><simpara> Ratio to set in the widget.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-get-user-override" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_get_user_override ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_get_user_override</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_number_pair_entry_get_user_override
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Wether or not the the widget is in user overridden mode.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-number-pair-entry-set-user-override" role="function" condition="since:GIMP 2.4"/>gimp_number_pair_entry_set_user_override ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_number_pair_entry_set_user_override</primary></indexterm><programlisting><link linkend="void">void</link> gimp_number_pair_entry_set_user_override
(<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *entry,
<link linkend="gboolean">gboolean</link> user_override);</programlisting>
<para>
When the entry is not in user overridden mode, the values will
change when the default values are changed. When in user overridden
mode, setting default values will not affect the active values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> A <link linkend="GimpNumberPairEntry"><type>GimpNumberPairEntry</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_override</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> sets the entry in user overridden mode,
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> disables.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpNumberPairEntry--allow-simplification"/>The &quot;<literal>allow-simplification</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:allow-simplification</primary></indexterm><programlisting> &quot;allow-simplification&quot; <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether to allow simplification.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--aspect"/>The &quot;<literal>aspect</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:aspect</primary></indexterm><programlisting> &quot;aspect&quot; <link linkend="GimpAspectType">GimpAspectType</link> : Read / Write</programlisting>
<para></para><para>Default value: GIMP_ASPECT_SQUARE</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--default-left-number"/>The &quot;<literal>default-left-number</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:default-left-number</primary></indexterm><programlisting> &quot;default-left-number&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 100</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--default-right-number"/>The &quot;<literal>default-right-number</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:default-right-number</primary></indexterm><programlisting> &quot;default-right-number&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 100</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--left-number"/>The &quot;<literal>left-number</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:left-number</primary></indexterm><programlisting> &quot;left-number&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 100</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--max-valid-value"/>The &quot;<literal>max-valid-value</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:max-valid-value</primary></indexterm><programlisting> &quot;max-valid-value&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para>Maximum value valid when parsing input.</para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 1.79769e+308</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--min-valid-value"/>The &quot;<literal>min-valid-value</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:min-valid-value</primary></indexterm><programlisting> &quot;min-valid-value&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para>Minimum value valid when parsing input.</para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 2.22507e-308</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--ratio"/>The &quot;<literal>ratio</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:ratio</primary></indexterm><programlisting> &quot;ratio&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 1</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--right-number"/>The &quot;<literal>right-number</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:right-number</primary></indexterm><programlisting> &quot;right-number&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 100</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--separators"/>The &quot;<literal>separators</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:separators</primary></indexterm><programlisting> &quot;separators&quot; <link linkend="gchararray">gchararray</link> : Read / Write / Construct Only</programlisting>
<para>A string of valid separators.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="GimpNumberPairEntry--user-override"/>The &quot;<literal>user-override</literal>&quot; property</title>
<indexterm><primary>GimpNumberPairEntry:user-override</primary></indexterm><programlisting> &quot;user-override&quot; <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether the widget is in 'user override' mode.</para><para>Default value: FALSE</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpNumberPairEntry-numbers-changed"/>The &quot;numbers-changed&quot; signal</title>
<indexterm><primary>GimpNumberPairEntry::numbers-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *gimpnumberpairentry,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpnumberpairentry</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="GimpNumberPairEntry-ratio-changed"/>The &quot;ratio-changed&quot; signal</title>
<indexterm><primary>GimpNumberPairEntry::ratio-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpNumberPairEntry">GimpNumberPairEntry</link> *gimpnumberpairentry,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpnumberpairentry</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>

300
devel-docs/libgimpwidgets/xml/gimpratioentry.xml
View File

@ -1,300 +0,0 @@
<?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="GimpRatioEntry">
<refmeta>
<refentrytitle role="top_of_page">GimpRatioEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpRatioEntry</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GimpRatioEntry-struct">GimpRatioEntry</link>;
enum <link linkend="GimpAspectType">GimpAspectType</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-ratio-entry-new">gimp_ratio_entry_new</link> (void);
<link linkend="void">void</link> <link linkend="gimp-ratio-entry-set-fraction">gimp_ratio_entry_set_fraction</link> (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="gdouble">gdouble</link> numerator,
<link linkend="gdouble">gdouble</link> denominator);
<link linkend="void">void</link> <link linkend="gimp-ratio-entry-get-fraction">gimp_ratio_entry_get_fraction</link> (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="gdouble">gdouble</link> *numerator,
<link linkend="gdouble">gdouble</link> *denominator);
<link linkend="void">void</link> <link linkend="gimp-ratio-entry-set-ratio">gimp_ratio_entry_set_ratio</link> (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="gdouble">gdouble</link> ratio);
<link linkend="gdouble">gdouble</link> <link linkend="gimp-ratio-entry-get-ratio">gimp_ratio_entry_get_ratio</link> (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);
<link linkend="void">void</link> <link linkend="gimp-ratio-entry-set-aspect">gimp_ratio_entry_set_aspect</link> (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="GimpAspectType">GimpAspectType</link> aspect);
<link linkend="GimpAspectType">GimpAspectType</link> <link linkend="gimp-ratio-entry-get-aspect">gimp_ratio_entry_get_aspect</link> (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkEntry">GtkEntry</link>
+----GimpRatioEntry
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpRatioEntry implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkEditable">GtkEditable</link> and <link linkend="GtkCellEditable">GtkCellEditable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
&quot;<link linkend="GimpRatioEntry--aspect">aspect</link>&quot; <link linkend="GimpAspectType">GimpAspectType</link> : Read / Write
&quot;<link linkend="GimpRatioEntry--denominator">denominator</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpRatioEntry--numerator">numerator</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
&quot;<link linkend="GimpRatioEntry--ratio">ratio</link>&quot; <link linkend="gdouble">gdouble</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
&quot;<link linkend="GimpRatioEntry-ratio-changed">ratio-changed</link>&quot; : Run First
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GimpRatioEntry-struct" role="struct"/>GimpRatioEntry</title>
<indexterm><primary>GimpRatioEntry</primary></indexterm><programlisting>typedef struct _GimpRatioEntry GimpRatioEntry;</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpAspectType" role="enum"/>enum GimpAspectType</title>
<indexterm><primary>GimpAspectType</primary></indexterm><programlisting>typedef enum
{
GIMP_ASPECT_SQUARE, /*&lt; desc="Square" &gt;*/
GIMP_ASPECT_PORTRAIT, /*&lt; desc="Portrait" &gt;*/
GIMP_ASPECT_LANDSCAPE /*&lt; desc="Landscape" &gt;*/
} GimpAspectType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-new" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_new ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_ratio_entry_new (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-set-fraction" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_set_fraction ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_set_fraction</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ratio_entry_set_fraction (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="gdouble">gdouble</link> numerator,
<link linkend="gdouble">gdouble</link> denominator);</programlisting>
<para>
Sets the fraction displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>. If the resulting
ratio is different to the previously set ratio, the "ratio-changed"
signal is emitted.
</para>
<para>
If the denominator is zero, the <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> will silently
convert it to 1.0.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>numerator</parameter>&nbsp;:</term>
<listitem><simpara> numerator of the fraction to set in the widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>denominator</parameter>&nbsp;:</term>
<listitem><simpara> denominator of the fraction to set in the widget
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-get-fraction" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_get_fraction ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_get_fraction</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ratio_entry_get_fraction (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="gdouble">gdouble</link> *numerator,
<link linkend="gdouble">gdouble</link> *denominator);</programlisting>
<para>
Gets the fraction displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>.
</para>
<para>
The denominator may be zero if the <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> shows just a single
value. You can use <link linkend="gimp-ratio-entry-get-ratio"><type>gimp_ratio_entry_get_ratio</type></link> to retrieve the ratio
as a single decimal value.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>numerator</parameter>&nbsp;:</term>
<listitem><simpara> pointer to store the numerator of the fraction
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>denominator</parameter>&nbsp;:</term>
<listitem><simpara> pointer to store the denominator of the fraction
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-set-ratio" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_set_ratio ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_set_ratio</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ratio_entry_set_ratio (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="gdouble">gdouble</link> ratio);</programlisting>
<para>
Sets the ratio displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>. If the new ratio is
different than the previous ratio, the "ratio-changed" signal is
emitted.
</para>
<para>
An attempt is made to convert the decimal number into a fraction with
numerator and denominator &lt; 1000.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ratio</parameter>&nbsp;:</term>
<listitem><simpara> ratio to set in the widget
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-get-ratio" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_get_ratio ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_get_ratio</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_ratio_entry_get_ratio (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);</programlisting>
<para>
Retrieves the ratio value displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The ratio value.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-set-aspect" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_set_aspect ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_set_aspect</primary></indexterm><programlisting><link linkend="void">void</link> gimp_ratio_entry_set_aspect (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry,
<link linkend="GimpAspectType">GimpAspectType</link> aspect);</programlisting>
<para>
Sets the aspect of the ratio by swapping the numerator and denominator
(or setting them to 1.0 in case that <parameter>aspect</parameter> is <link linkend="GIMP-ASPECT-SQUARE:CAPS"><literal>GIMP_ASPECT_SQUARE</literal></link>).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>aspect</parameter>&nbsp;:</term>
<listitem><simpara> the new aspect
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
<refsect2>
<title><anchor id="gimp-ratio-entry-get-aspect" role="function" condition="since:GIMP 2.4"/>gimp_ratio_entry_get_aspect ()</title>
<indexterm role="GIMP 2.4"><primary>gimp_ratio_entry_get_aspect</primary></indexterm><programlisting><link linkend="GimpAspectType">GimpAspectType</link> gimp_ratio_entry_get_aspect (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *entry);</programlisting>
<para>
Gets the aspect of the ratio displayed by a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GimpRatioEntry"><type>GimpRatioEntry</type></link> widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The entry's current aspect.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since GIMP 2.4
</para></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GimpRatioEntry--aspect"/>The &quot;<literal>aspect</literal>&quot; property</title>
<indexterm><primary>GimpRatioEntry:aspect</primary></indexterm><programlisting> &quot;aspect&quot; <link linkend="GimpAspectType">GimpAspectType</link> : Read / Write</programlisting>
<para></para><para>Default value: GIMP_ASPECT_SQUARE</para>
</refsect2>
<refsect2><title><anchor id="GimpRatioEntry--denominator"/>The &quot;<literal>denominator</literal>&quot; property</title>
<indexterm><primary>GimpRatioEntry:denominator</primary></indexterm><programlisting> &quot;denominator&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 1</para>
</refsect2>
<refsect2><title><anchor id="GimpRatioEntry--numerator"/>The &quot;<literal>numerator</literal>&quot; property</title>
<indexterm><primary>GimpRatioEntry:numerator</primary></indexterm><programlisting> &quot;numerator&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 1</para>
</refsect2>
<refsect2><title><anchor id="GimpRatioEntry--ratio"/>The &quot;<literal>ratio</literal>&quot; property</title>
<indexterm><primary>GimpRatioEntry:ratio</primary></indexterm><programlisting> &quot;ratio&quot; <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
<para></para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 1</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GimpRatioEntry-ratio-changed"/>The &quot;ratio-changed&quot; signal</title>
<indexterm><primary>GimpRatioEntry::ratio-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GimpRatioEntry">GimpRatioEntry</link> *gimpratioentry,
<link linkend="gpointer">gpointer</link> user_data) : Run First</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpratioentry</parameter>&nbsp;:</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>