Imported Upstream version 2.3.16

This commit is contained in:
Ari Pollak
2010-08-11 01:21:23 -04:00
parent d694295a3e
commit 2e1d89b96f
944 changed files with 103935 additions and 69090 deletions

View File

@ -3,12 +3,12 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpPreviewArea</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<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">
<link rel="next" href="GimpPreview.html" title="GimpPreview">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimpwidgets-widgets.html" title="Part&#160;I.&#160;GIMP Widgets">
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
@ -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="#id2581223" class="shortcut">Top</a>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2588480" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2607402" class="shortcut">Description</a>
<a href="#id2617418" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2607289" class="shortcut">Object Hierarchy</a>
<a href="#id2617306" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2607338" class="shortcut">Implemented Interfaces</a>
<a href="#id2617355" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2607360" class="shortcut">Properties</a></nobr></td></tr>
<a href="#id2617376" 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="id2581223"></a><span class="refentrytitle">GimpPreviewArea</span>
<a name="id2588480"></a><span class="refentrytitle">GimpPreviewArea</span>
</h2>
<p>GimpPreviewArea &#8212; A general purpose preview widget which caches its pixel data.</p>
</td>
@ -60,69 +60,69 @@
<a href="GimpPreviewArea.html#GimpPreviewArea-struct">GimpPreviewArea</a>;
GtkWidget* <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,
gint x,
gint y,
gint width,
gint height,
<a
<a href="GimpPreviewArea.html#GimpPreviewArea-struct">GimpPreviewArea</a>;
GtkWidget* <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,
gint x,
gint y,
gint width,
gint height,
<a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
>GimpImageType</a> type,
const guchar *buf,
gint rowstride);
void <a href="GimpPreviewArea.html#gimp-preview-area-fill">gimp_preview_area_fill</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
guchar red,
guchar green,
guchar blue);
void <a href="GimpPreviewArea.html#gimp-preview-area-blend">gimp_preview_area_blend</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
const guchar *buf,
gint rowstride);
void <a href="GimpPreviewArea.html#gimp-preview-area-fill">gimp_preview_area_fill</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
guchar red,
guchar green,
guchar blue);
void <a href="GimpPreviewArea.html#gimp-preview-area-blend">gimp_preview_area_blend</a> (<a 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 guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
guchar opacity);
void <a href="GimpPreviewArea.html#gimp-preview-area-mask">gimp_preview_area_mask</a> (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
const guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
guchar opacity);
void <a href="GimpPreviewArea.html#gimp-preview-area-mask">gimp_preview_area_mask</a> (<a 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 guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
const guchar *mask,
gint 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,
gint x,
gint 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 guchar *colormap,
gint 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,
gint width,
gint 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,
GdkEventButton *event);
const guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
const guchar *mask,
gint 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,
gint x,
gint 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 guchar *colormap,
gint 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,
gint width,
gint 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,
GdkEventButton *event);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2607289"></a><h2>Object Hierarchy</h2>
<a name="id2617306"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
@ -134,44 +134,44 @@ void <a href="GimpPreviewArea.html#gimp-preview-area-menu-popup">gimp_pre
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2607338"></a><h2>Implemented Interfaces</h2>
<a name="id2617355"></a><h2>Implemented Interfaces</h2>
<p>
GimpPreviewArea implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2607360"></a><h2>Properties</h2>
<a name="id2617376"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GimpPreviewArea.html#GimpPreviewArea--check-size">check-size</a>" <a
"<a 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 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="id2607402"></a><h2>Description</h2>
<a name="id2617418"></a><h2>Description</h2>
<p>
A general purpose preview widget which caches its pixel data.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2609272"></a><h2>Details</h2>
<a name="id2617435"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2609282"></a><h3>
<a name="id2617446"></a><h3>
<a name="GimpPreviewArea-struct"></a>GimpPreviewArea</h3>
<a class="indexterm" name="id2609294"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
<a class="indexterm" name="id2617457"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609310"></a><h3>
<a name="id2617474"></a><h3>
<a name="gimp-preview-area-new"></a>gimp_preview_area_new ()</h3>
<a class="indexterm" name="id2609322"></a><pre class="programlisting">GtkWidget* gimp_preview_area_new (void);</pre>
<a class="indexterm" name="id2617485"></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>
<p>
@ -190,18 +190,18 @@ Since GIMP 2.2
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2609375"></a><h3>
<a name="id2617539"></a><h3>
<a name="gimp-preview-area-draw"></a>gimp_preview_area_draw ()</h3>
<a class="indexterm" name="id2609386"></a><pre class="programlisting">void gimp_preview_area_draw (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
<a class="indexterm" name="id2617551"></a><pre class="programlisting">void gimp_preview_area_draw (<a 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 guchar *buf,
gint 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>
@ -260,19 +260,19 @@ href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2616514"></a><h3>
<a name="id2624711"></a><h3>
<a name="gimp-preview-area-fill"></a>gimp_preview_area_fill ()</h3>
<a class="indexterm" name="id2616524"></a><pre class="programlisting">void gimp_preview_area_fill (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
guchar red,
guchar green,
guchar blue);</pre>
<a class="indexterm" name="id2624722"></a><pre class="programlisting">void gimp_preview_area_fill (<a 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 <em class="parameter"><code>area</code></em> in the given color and queues a redraw on the given
rectangle.
Fills the given rectangle of <em class="parameter"><code>area</code></em> in the given color and queues a
redraw.
</p>
<p>
Since GIMP 2.2</p>
@ -299,12 +299,12 @@ Since GIMP 2.2</p>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> buffer width
<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> buffer height
<td> height of the rectangle to fill
</td>
</tr>
<tr>
@ -327,21 +327,21 @@ Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2616733"></a><h3>
<a name="id2624927"></a><h3>
<a name="gimp-preview-area-blend"></a>gimp_preview_area_blend ()</h3>
<a class="indexterm" name="id2616744"></a><pre class="programlisting">void gimp_preview_area_blend (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
<a class="indexterm" name="id2624938"></a><pre class="programlisting">void gimp_preview_area_blend (<a 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 guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
guchar 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.
@ -418,22 +418,22 @@ href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617090"></a><h3>
<a name="id2625284"></a><h3>
<a name="gimp-preview-area-mask"></a>gimp_preview_area_mask ()</h3>
<a class="indexterm" name="id2617101"></a><pre class="programlisting">void gimp_preview_area_mask (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y,
gint width,
gint height,
<a
<a class="indexterm" name="id2625295"></a><pre class="programlisting">void gimp_preview_area_mask (<a 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 guchar *buf1,
gint rowstride1,
const guchar *buf2,
gint rowstride2,
const guchar *mask,
gint 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.
@ -516,11 +516,11 @@ href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617475"></a><h3>
<a name="id2625672"></a><h3>
<a name="gimp-preview-area-set-offsets"></a>gimp_preview_area_set_offsets ()</h3>
<a class="indexterm" name="id2617491"></a><pre class="programlisting">void gimp_preview_area_set_offsets (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint x,
gint y);</pre>
<a class="indexterm" name="id2625688"></a><pre class="programlisting">void gimp_preview_area_set_offsets (<a 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>
@ -547,16 +547,16 @@ when drawing the checkerboard and to determine the dither offsets.</p>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617596"></a><h3>
<a name="id2625796"></a><h3>
<a name="gimp-preview-area-set-colormap"></a>gimp_preview_area_set_colormap ()</h3>
<a class="indexterm" name="id2617610"></a><pre class="programlisting">void gimp_preview_area_set_colormap (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
const guchar *colormap,
gint num_colors);</pre>
<a class="indexterm" name="id2573809"></a><pre class="programlisting">void gimp_preview_area_set_colormap (<a 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
@ -590,11 +590,11 @@ Since GIMP 2.2</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2501397"></a><h3>
<a name="id2625926"></a><h3>
<a name="gimp-preview-area-set-max-size"></a>gimp_preview_area_set_max_size ()</h3>
<a class="indexterm" name="id2617753"></a><pre class="programlisting">void gimp_preview_area_set_max_size (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
gint width,
gint height);</pre>
<a class="indexterm" name="id2625940"></a><pre class="programlisting">void gimp_preview_area_set_max_size (<a 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
allocated. This funtion allows you to limit the preview area to a
@ -623,15 +623,15 @@ preview will draw itself centered into the allocated area.</p>
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2617857"></a><h3>
<a name="id2626047"></a><h3>
<a name="gimp-preview-area-menu-popup"></a>gimp_preview_area_menu_popup ()</h3>
<a class="indexterm" name="id2617872"></a><pre class="programlisting">void gimp_preview_area_menu_popup (<a href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
GdkEventButton *event);</pre>
<a class="indexterm" name="id2626062"></a><pre class="programlisting">void gimp_preview_area_menu_popup (<a 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>
@ -653,16 +653,16 @@ the checkerboard pattern that the <em class="parameter"><code>area</code></em> u
</tr>
</tbody>
</table></div>
<p>Since GIMP 2.2
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2617964"></a><h2>Property Details</h2>
<a name="id2626156"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2617973"></a><h3>
<a name="id2626165"></a><h3>
<a name="GimpPreviewArea--check-size"></a>The "<code class="literal">check-size</code>" property</h3>
<a class="indexterm" name="id2617985"></a><pre class="programlisting"> "check-size" <a
<a class="indexterm" name="id2626178"></a><pre class="programlisting"> "check-size" <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
>GimpCheckSize</a> : Read / Write</pre>
<p></p>
@ -670,9 +670,9 @@ href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2618007"></a><h3>
<a name="id2626200"></a><h3>
<a name="GimpPreviewArea--check-type"></a>The "<code class="literal">check-type</code>" property</h3>
<a class="indexterm" name="id2618020"></a><pre class="programlisting"> "check-type" <a
<a class="indexterm" name="id2626213"></a><pre class="programlisting"> "check-type" <a
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
>GimpCheckType</a> : Read / Write</pre>
<p></p>