Imported Upstream version 2.4.0~rc2

This commit is contained in:
Ari Pollak
2010-08-11 01:22:44 -04:00
parent d884b2912c
commit 4be5597e32
576 changed files with 70261 additions and 80724 deletions

View File

@ -3,7 +3,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpPreviewArea</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
<link rel="up" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="prev" href="GimpPixmap.html" title="GimpPixmap">
@ -33,22 +33,22 @@
<th width="100%" align="center">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2579852" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2587166" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2627598" class="shortcut">Description</a>
<a href="#id2635380" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2627486" class="shortcut">Object Hierarchy</a>
<a href="#id2635262" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2627535" class="shortcut">Implemented Interfaces</a>
<a href="#id2635310" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2627556" class="shortcut">Properties</a></nobr></td></tr>
<a href="#id2635338" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpPreviewArea"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2579852"></a><span class="refentrytitle">GimpPreviewArea</span>
<a name="id2587166"></a><span class="refentrytitle">GimpPreviewArea</span>
</h2>
<p>GimpPreviewArea &#8212; A general purpose preview widget which caches its pixel data.</p>
</td>
@ -60,220 +60,128 @@
<a href="GimpPreviewArea.html#GimpPreviewArea-struct">GimpPreviewArea</a>;
<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GimpPreviewArea.html#gimp-preview-area-new">gimp_preview_area_new</a> (void);
void <a href="GimpPreviewArea.html#gimp-preview-area-draw">gimp_preview_area_draw</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a class="link" href="GimpPreviewArea.html#GimpPreviewArea-struct">GimpPreviewArea</a>;
GtkWidget* <a class="link" href="GimpPreviewArea.html#gimp-preview-area-new">gimp_preview_area_new</a> (void);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-draw">gimp_preview_area_draw</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride);
void <a href="GimpPreviewArea.html#gimp-preview-area-fill">gimp_preview_area_fill</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> red,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> green,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> blue);
void <a href="GimpPreviewArea.html#gimp-preview-area-blend">gimp_preview_area_blend</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
const guchar *buf,
gint rowstride);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-fill">gimp_preview_area_fill</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
guchar red,
guchar green,
guchar blue);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-blend">gimp_preview_area_blend</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf1,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride1,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf2,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride2,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> opacity);
void <a href="GimpPreviewArea.html#gimp-preview-area-mask">gimp_preview_area_mask</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
const guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
guchar opacity);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-mask">gimp_preview_area_mask</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf1,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride1,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf2,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride2,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *mask,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride_mask);
void <a href="GimpPreviewArea.html#gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y);
void <a href="GimpPreviewArea.html#gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *colormap,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_colors);
void <a href="GimpPreviewArea.html#gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height);
void <a href="GimpPreviewArea.html#gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../gdk/gdk-Event-Structures.html#GdkEventButton"
>GdkEventButton</a> *event);
const guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
const guchar *mask,
gint rowstride_mask);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
const guchar *colormap,
gint num_colors);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint width,
gint height);
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
GdkEventButton *event);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2627486"></a><h2>Object Hierarchy</h2>
<a name="id2635262"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="../gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="../gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="../gtk/GtkDrawingArea.html"
>GtkDrawingArea</a>
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkDrawingArea
+----GimpPreviewArea
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2627535"></a><h2>Implemented Interfaces</h2>
<a name="id2635310"></a><h2>Implemented Interfaces</h2>
<p>
GimpPreviewArea implements
AtkImplementorIface.</p>
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2627556"></a><h2>Properties</h2>
<a name="id2635338"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpPreviewArea.html#GimpPreviewArea--check-size">check-size</a>" <a
"<a class="link" href="GimpPreviewArea.html#GimpPreviewArea--check-size">check-size</a>" <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
>GimpCheckSize</a> : Read / Write
"<a href="GimpPreviewArea.html#GimpPreviewArea--check-type">check-type</a>" <a
"<a class="link" href="GimpPreviewArea.html#GimpPreviewArea--check-type">check-type</a>" <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
>GimpCheckType</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2627598"></a><h2>Description</h2>
<a name="id2635380"></a><h2>Description</h2>
<p>
A general purpose preview widget which caches its pixel data.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2623782"></a><h2>Details</h2>
<a name="id2635397"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2623793"></a><h3>
<a name="id2635408"></a><h3>
<a name="GimpPreviewArea-struct"></a>GimpPreviewArea</h3>
<a class="indexterm" name="id2623804"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
<a class="indexterm" name="id2635419"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623821"></a><h3>
<a name="id2635436"></a><h3>
<a name="gimp-preview-area-new"></a>gimp_preview_area_new ()</h3>
<a class="indexterm" name="id2623832"></a><pre class="programlisting"><a
href="../gtk/GtkWidget.html"
>GtkWidget</a>* gimp_preview_area_new (void);</pre>
<a class="indexterm" name="id2635447"></a><pre class="programlisting">GtkWidget* gimp_preview_area_new (void);</pre>
<p>
Creates a new <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.</p>
Creates a new <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
<td> a new <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
Since GIMP 2.2
</td>
@ -282,30 +190,18 @@ Since GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2623886"></a><h3>
<a name="id2635501"></a><h3>
<a name="gimp-preview-area-draw"></a>gimp_preview_area_draw ()</h3>
<a class="indexterm" name="id2623897"></a><pre class="programlisting">void gimp_preview_area_draw (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a class="indexterm" name="id2635512"></a><pre class="programlisting">void gimp_preview_area_draw (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride);</pre>
const guchar *buf,
gint rowstride);</pre>
<p>
Draws <em class="parameter"><code>buf</code></em> on <em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
</p>
@ -318,46 +214,44 @@ Since GIMP 2.2</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> x offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> y offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> buffer width
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> buffer height
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
<td> the <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
><span class="type">GimpImageType</span></a> of <em class="parameter"><code>buf</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>buf</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer that contains the preview pixel data.
<td><p><span class="term"><em class="parameter"><code>buf</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer that contains the preview pixel data.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rowstride</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>rowstride</code></em>&#160;:</span></p></td>
<td> rowstride of <em class="parameter"><code>buf</code></em>
</td>
</tr>
@ -366,30 +260,16 @@ href="../glib/glib-Basic-Types.html#guchar"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629722"></a><h3>
<a name="id2647048"></a><h3>
<a name="gimp-preview-area-fill"></a>gimp_preview_area_fill ()</h3>
<a class="indexterm" name="id2629733"></a><pre class="programlisting">void gimp_preview_area_fill (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> red,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> green,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> blue);</pre>
<a class="indexterm" name="id2647058"></a><pre class="programlisting">void gimp_preview_area_fill (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
guchar red,
guchar green,
guchar blue);</pre>
<p>
Fills the given rectangle of <em class="parameter"><code>area</code></em> in the given color and queues a
redraw.
@ -403,42 +283,42 @@ Since GIMP 2.2</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> x offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> y offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> width of the rectangle to fill
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> height of the rectangle to fill
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>red</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>red</code></em>&#160;:</span></p></td>
<td> red component of the fill color (0-255)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>green</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>green</code></em>&#160;:</span></p></td>
<td> green component of the fill color (0-255)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>blue</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>blue</code></em>&#160;:</span></p></td>
<td> red component of the fill color (0-255)
</td>
</tr>
@ -447,39 +327,21 @@ Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2629943"></a><h3>
<a name="id2647272"></a><h3>
<a name="gimp-preview-area-blend"></a>gimp_preview_area_blend ()</h3>
<a class="indexterm" name="id2629954"></a><pre class="programlisting">void gimp_preview_area_blend (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a class="indexterm" name="id2647283"></a><pre class="programlisting">void gimp_preview_area_blend (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf1,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride1,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf2,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride2,
<a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> opacity);</pre>
const guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
guchar opacity);</pre>
<p>
Composites <em class="parameter"><code>buf1</code></em> on <em class="parameter"><code>buf2</code></em> with the given <em class="parameter"><code>opacity</code></em>, draws the result
to <em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
@ -493,65 +355,61 @@ Since GIMP 2.2</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> x offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> y offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> buffer width
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> buffer height
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
<td> the <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
><span class="type">GimpImageType</span></a> of <em class="parameter"><code>buf1</code></em> and <em class="parameter"><code>buf2</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>buf1</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer that contains the pixel data for
<td><p><span class="term"><em class="parameter"><code>buf1</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer that contains the pixel data for
the lower layer
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rowstride1</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>rowstride1</code></em>&#160;:</span></p></td>
<td> rowstride of <em class="parameter"><code>buf1</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>buf2</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer that contains the pixel data for
<td><p><span class="term"><em class="parameter"><code>buf2</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer that contains the pixel data for
the upper layer
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rowstride2</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>rowstride2</code></em>&#160;:</span></p></td>
<td> rowstride of <em class="parameter"><code>buf2</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>opacity</code></em>&#160;:</span></p></td>
<td> The opacity of the first layer.
</td>
</tr>
@ -560,42 +418,22 @@ href="../glib/glib-Basic-Types.html#guchar"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630301"></a><h3>
<a name="id2647630"></a><h3>
<a name="gimp-preview-area-mask"></a>gimp_preview_area_mask ()</h3>
<a class="indexterm" name="id2630313"></a><pre class="programlisting">void gimp_preview_area_mask (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height,
<a class="indexterm" name="id2647641"></a><pre class="programlisting">void gimp_preview_area_mask (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf1,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride1,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *buf2,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride2,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *mask,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> rowstride_mask);</pre>
const guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
const guchar *mask,
gint rowstride_mask);</pre>
<p>
Composites <em class="parameter"><code>buf1</code></em> on <em class="parameter"><code>buf2</code></em> with the given <em class="parameter"><code>mask</code></em>, draws the result on
<em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
@ -609,73 +447,67 @@ Since GIMP 2.2</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> x offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> y offset in preview
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> buffer width
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> buffer height
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>type</code></em>&#160;:</span></p></td>
<td> the <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
><span class="type">GimpImageType</span></a> of <em class="parameter"><code>buf1</code></em> and <em class="parameter"><code>buf2</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>buf1</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer that contains the pixel data for
<td><p><span class="term"><em class="parameter"><code>buf1</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer that contains the pixel data for
the lower layer
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rowstride1</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>rowstride1</code></em>&#160;:</span></p></td>
<td> rowstride of <em class="parameter"><code>buf1</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>buf2</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer that contains the pixel data for
<td><p><span class="term"><em class="parameter"><code>buf2</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer that contains the pixel data for
the upper layer
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rowstride2</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>rowstride2</code></em>&#160;:</span></p></td>
<td> rowstride of <em class="parameter"><code>buf2</code></em>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mask</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer representing the mask of the second
<td><p><span class="term"><em class="parameter"><code>mask</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer representing the mask of the second
layer.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>rowstride_mask</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>rowstride_mask</code></em>&#160;:</span></p></td>
<td> rowstride for the mask.
</td>
</tr>
@ -684,15 +516,11 @@ href="../glib/glib-Basic-Types.html#guchar"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630689"></a><h3>
<a name="id2648018"></a><h3>
<a name="gimp-preview-area-set-offsets"></a>gimp_preview_area_set_offsets ()</h3>
<a class="indexterm" name="id2630705"></a><pre class="programlisting">void gimp_preview_area_set_offsets (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> x,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> y);</pre>
<a class="indexterm" name="id2648033"></a><pre class="programlisting">void gimp_preview_area_set_offsets (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y);</pre>
<p>
Sets the offsets of the previewed area. This information is used
when drawing the checkerboard and to determine the dither offsets.</p>
@ -703,17 +531,17 @@ when drawing the checkerboard and to determine the dither offsets.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></p></td>
<td> horizontal offset
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></p></td>
<td> vertical offset
</td>
</tr>
@ -724,18 +552,14 @@ when drawing the checkerboard and to determine the dither offsets.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630814"></a><h3>
<a name="id2648142"></a><h3>
<a name="gimp-preview-area-set-colormap"></a>gimp_preview_area_set_colormap ()</h3>
<a class="indexterm" name="id2630827"></a><pre class="programlisting">void gimp_preview_area_set_colormap (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
const <a
href="../glib/glib-Basic-Types.html#guchar"
>guchar</a> *colormap,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> num_colors);</pre>
<a class="indexterm" name="id2648155"></a><pre class="programlisting">void gimp_preview_area_set_colormap (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
const guchar *colormap,
gint num_colors);</pre>
<p>
Sets the colormap for the <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget. You need to
call this function before you use <a href="GimpPreviewArea.html#gimp-preview-area-draw"><code class="function">gimp_preview_area_draw()</code></a> with
Sets the colormap for the <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget. You need to
call this function before you use <a class="link" href="GimpPreviewArea.html#gimp-preview-area-draw"><code class="function">gimp_preview_area_draw()</code></a> with
an image type of <code class="literal">GIMP_INDEXED_IMAGE</code> or <code class="literal">GIMP_INDEXEDA_IMAGE</code>.
</p>
<p>
@ -747,19 +571,17 @@ Since GIMP 2.2</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>colormap</code></em>&#160;:</span></td>
<td> a <a
href="../glib/glib-Basic-Types.html#guchar"
><span class="type">guchar</span></a> buffer that contains the colormap
<td><p><span class="term"><em class="parameter"><code>colormap</code></em>&#160;:</span></p></td>
<td> a <span class="type">guchar</span> buffer that contains the colormap
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em>&#160;:</span></p></td>
<td> the number of colors in the colormap
</td>
</tr>
@ -768,17 +590,13 @@ href="../glib/glib-Basic-Types.html#guchar"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2630973"></a><h3>
<a name="id2648302"></a><h3>
<a name="gimp-preview-area-set-max-size"></a>gimp_preview_area_set_max_size ()</h3>
<a class="indexterm" name="id2630989"></a><pre class="programlisting">void gimp_preview_area_set_max_size (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> width,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> height);</pre>
<a class="indexterm" name="id2648317"></a><pre class="programlisting">void gimp_preview_area_set_max_size (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint width,
gint height);</pre>
<p>
Usually a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> fills the size that it is
Usually a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> fills the size that it is
allocated. This funtion allows you to limit the preview area to a
maximum size. If a larger size is allocated for the widget, the
preview will draw itself centered into the allocated area.</p>
@ -789,17 +607,17 @@ preview will draw itself centered into the allocated area.</p>
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></p></td>
<td> the maximum width in pixels or -1 to unset the limit
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td><p><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></p></td>
<td> the maximum height in pixels or -1 to unset the limit
</td>
</tr>
@ -810,12 +628,10 @@ preview will draw itself centered into the allocated area.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631083"></a><h3>
<a name="id2648409"></a><h3>
<a name="gimp-preview-area-menu-popup"></a>gimp_preview_area_menu_popup ()</h3>
<a class="indexterm" name="id2631097"></a><pre class="programlisting">void gimp_preview_area_menu_popup (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
<a
href="../gdk/gdk-Event-Structures.html#GdkEventButton"
>GdkEventButton</a> *event);</pre>
<a class="indexterm" name="id2648424"></a><pre class="programlisting">void gimp_preview_area_menu_popup (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
GdkEventButton *event);</pre>
<p>
Creates a popup menu that allows to configure the size and type of
the checkerboard pattern that the <em class="parameter"><code>area</code></em> uses to visualize transparency.</p>
@ -826,15 +642,13 @@ the checkerboard pattern that the <em class="parameter"><code>area</code></em> u
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></td>
<td> a <a href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
<td><p><span class="term"><em class="parameter"><code>area</code></em>&#160;:</span></p></td>
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></td>
<td> the button event that causes the menu to popup or <a
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
><code class="literal">NULL</code></a>
<td><p><span class="term"><em class="parameter"><code>event</code></em>&#160;:</span></p></td>
<td> the button event that causes the menu to popup or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
@ -844,11 +658,11 @@ href="../glib/glib-Standard-Macros.html#NULL:CAPS"
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2631191"></a><h2>Property Details</h2>
<a name="id2648518"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2631200"></a><h3>
<a name="id2648527"></a><h3>
<a name="GimpPreviewArea--check-size"></a>The "<code class="literal">check-size</code>" property</h3>
<a class="indexterm" name="id2631213"></a><pre class="programlisting"> "check-size" <a
<a class="indexterm" name="id2648540"></a><pre class="programlisting"> "check-size" <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
>GimpCheckSize</a> : Read / Write</pre>
<p></p>
@ -856,9 +670,9 @@ href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2631236"></a><h3>
<a name="id2648562"></a><h3>
<a name="GimpPreviewArea--check-type"></a>The "<code class="literal">check-type</code>" property</h3>
<a class="indexterm" name="id2631248"></a><pre class="programlisting"> "check-type" <a
<a class="indexterm" name="id2648575"></a><pre class="programlisting"> "check-type" <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
>GimpCheckType</a> : Read / Write</pre>
<p></p>