168 lines
8.0 KiB
XML
168 lines
8.0 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="GimpDrawablePreview">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page">GimpDrawablePreview</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>GimpDrawablePreview</refname>
|
|
<refpurpose>A widget providing a preview of a <link linkend="GimpDrawable"><type>GimpDrawable</type></link>.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="GimpDrawablePreview-struct">GimpDrawablePreview</link>;
|
|
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-drawable-preview-new">gimp_drawable_preview_new</link> (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="gboolean">gboolean</link> *toggle);
|
|
<link linkend="GimpDrawable">GimpDrawable</link>* <link linkend="gimp-drawable-preview-get-drawable">gimp_drawable_preview_get_drawable</link> (<link linkend="GimpDrawablePreview">GimpDrawablePreview</link> *preview);
|
|
<link linkend="void">void</link> <link linkend="gimp-drawable-preview-draw-region">gimp_drawable_preview_draw_region</link> (<link linkend="GimpDrawablePreview">GimpDrawablePreview</link> *preview,
|
|
const <link linkend="GimpPixelRgn">GimpPixelRgn</link> *region);
|
|
|
|
</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="GtkBox">GtkBox</link>
|
|
+----<link linkend="GtkVBox">GtkVBox</link>
|
|
+----<link linkend="GimpPreview">GimpPreview</link>
|
|
+----<link linkend="GimpScrolledPreview">GimpScrolledPreview</link>
|
|
+----GimpDrawablePreview
|
|
</synopsis>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 role="impl_interfaces">
|
|
<title role="impl_interfaces.title">Implemented Interfaces</title>
|
|
<para>
|
|
GimpDrawablePreview implements
|
|
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
<refsect1 role="properties">
|
|
<title role="properties.title">Properties</title>
|
|
<synopsis>
|
|
|
|
"<link linkend="GimpDrawablePreview--drawable">drawable</link>" <link linkend="gpointer">gpointer</link> : Read / Write / Construct Only
|
|
</synopsis>
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1 role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
A widget providing a preview of a <link linkend="GimpDrawable"><type>GimpDrawable</type></link>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2>
|
|
<title><anchor id="GimpDrawablePreview-struct" role="struct"/>GimpDrawablePreview</title>
|
|
<indexterm><primary>GimpDrawablePreview</primary></indexterm><programlisting>typedef struct _GimpDrawablePreview GimpDrawablePreview;</programlisting>
|
|
<para>
|
|
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-drawable-preview-new" role="function" condition="since:GIMP 2.2"/>gimp_drawable_preview_new ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_drawable_preview_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_drawable_preview_new (<link linkend="GimpDrawable">GimpDrawable</link> *drawable,
|
|
<link linkend="gboolean">gboolean</link> *toggle);</programlisting>
|
|
<para>
|
|
Creates a new <link linkend="GimpDrawablePreview"><type>GimpDrawablePreview</type></link> widget for <parameter>drawable</parameter>. If
|
|
updating the preview takes considerable time, you will want to
|
|
store the state of the "Preview" check-button in the plug-in
|
|
data. For convenience you can pass a pointer to the <link linkend="gboolean"><type>gboolean</type></link> as
|
|
<parameter>toggle</parameter>.</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> pointer to a <link linkend="gboolean"><type>gboolean</type></link> variable to sync with the "Preview"
|
|
check-button or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the new <link linkend="GimpDrawablePreview"><type>GimpDrawablePreview</type></link> widget.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-drawable-preview-get-drawable" role="function" condition="since:GIMP 2.2"/>gimp_drawable_preview_get_drawable ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_drawable_preview_get_drawable</primary></indexterm><programlisting><link linkend="GimpDrawable">GimpDrawable</link>* gimp_drawable_preview_get_drawable (<link linkend="GimpDrawablePreview">GimpDrawablePreview</link> *preview);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>preview</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawablePreview"><type>GimpDrawablePreview</type></link> widget
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GimpDrawable"><type>GimpDrawable</type></link> that has been passed to
|
|
<link linkend="gimp-drawable-preview-new"><function>gimp_drawable_preview_new()</function></link>.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-drawable-preview-draw-region" role="function" condition="since:GIMP 2.2"/>gimp_drawable_preview_draw_region ()</title>
|
|
<indexterm role="GIMP 2.2"><primary>gimp_drawable_preview_draw_region</primary></indexterm><programlisting><link linkend="void">void</link> gimp_drawable_preview_draw_region (<link linkend="GimpDrawablePreview">GimpDrawablePreview</link> *preview,
|
|
const <link linkend="GimpPixelRgn">GimpPixelRgn</link> *region);</programlisting>
|
|
<para>
|
|
</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>preview</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpDrawablePreview"><type>GimpDrawablePreview</type></link> widget
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>region</parameter> :</term>
|
|
<listitem><simpara> a <link linkend="GimpPixelRgn"><type>GimpPixelRgn</type></link>
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2
|
|
</para></refsect2>
|
|
|
|
</refsect1>
|
|
<refsect1 role="property_details">
|
|
<title role="property_details.title">Property Details</title>
|
|
<refsect2><title><anchor id="GimpDrawablePreview--drawable"/>The "<literal>drawable</literal>" property</title>
|
|
<indexterm role="GIMP 2.4"><primary>GimpDrawablePreview: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>
|