127 lines
5.3 KiB
XML
127 lines
5.3 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="GimpAspectPreview">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="GimpAspectPreview.top_of_page">GimpAspectPreview</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpAspectPreview</refname>
|
|
<refpurpose>A widget providing a preview with fixed aspect ratio.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="GimpAspectPreview.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="GimpAspectPreview-struct">GimpAspectPreview</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-aspect-preview-new">gimp_aspect_preview_new</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="gboolean">gboolean</link> *toggle);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 id="GimpAspectPreview.object-hierarchy" role="object_hierarchy">
|
|
<title role="object_hierarchy.title">Object Hierarchy</title>
|
|
<synopsis>
|
|
<link linkend="GObject">GObject</link>
|
|
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
|
|
+----<link linkend="GtkObject">GtkObject</link>
|
|
+----<link linkend="GtkWidget">GtkWidget</link>
|
|
+----<link linkend="GtkContainer">GtkContainer</link>
|
|
+----<link linkend="GtkBox">GtkBox</link>
|
|
+----<link linkend="GtkVBox">GtkVBox</link>
|
|
+----<link linkend="GimpPreview">GimpPreview</link>
|
|
+----GimpAspectPreview
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="GimpAspectPreview.implemented-interfaces" role="impl_interfaces">
|
|
<title role="impl_interfaces.title">Implemented Interfaces</title>
|
|
<para>
|
|
GimpAspectPreview implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkBuildable">GtkBuildable</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 id="GimpAspectPreview.properties" role="properties">
|
|
<title role="properties.title">Properties</title>
|
|
<synopsis>
|
|
"<link linkend="GimpAspectPreview--drawable">drawable</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 id="GimpAspectPreview.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
A widget providing a preview with fixed aspect ratio.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="GimpAspectPreview.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="GimpAspectPreview-struct" role="struct">
|
|
<title>GimpAspectPreview</title>
|
|
<indexterm zone="GimpAspectPreview-struct"><primary>GimpAspectPreview</primary></indexterm><programlisting>typedef struct _GimpAspectPreview GimpAspectPreview;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-aspect-preview-new" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_aspect_preview_new ()</title>
|
|
<indexterm zone="gimp-aspect-preview-new" role="GIMP 2.2"><primary>gimp_aspect_preview_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_aspect_preview_new (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="gboolean">gboolean</link> *toggle);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpAspectPreview"><type>GimpAspectPreview</type></link> widget for <parameter>drawable</parameter>. See also
|
|
<link linkend="gimp-drawable-preview-new"><function>gimp_drawable_preview_new()</function></link>.
|
|
</para>
|
|
<para>
|
|
In GIMP 2.2 the <parameter>toggle</parameter> parameter was provided to conviently access
|
|
the state of the "Preview" check-button. This is not any longer
|
|
necessary as the preview itself now stores this state, as well as
|
|
the scroll offset.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>drawable</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawable"><type>GimpDrawable</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>toggle</parameter> :</term>
|
|
<listitem><simpara> unused
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
|
|
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1 id="GimpAspectPreview.property-details" role="property_details">
|
|
<title role="property_details.title">Property Details</title>
|
|
<refsect2 id="GimpAspectPreview--drawable"><title>The <literal>"drawable"</literal> property</title>
|
|
<indexterm zone="GimpAspectPreview--drawable" role="GIMP 2.4"><primary>GimpAspectPreview:drawable</primary></indexterm><programlisting> "drawable" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><para>Since GIMP 2.4
|
|
</para>
|
|
</refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|