1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
|
<?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="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>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>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>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|