You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

169 lines
10 KiB

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AnypaperImage</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="anypaper Reference Manual">
<link rel="up" href="ch01.html" title="anyPaper Classes">
<link rel="prev" href="anypaper-anypaper-parameters.html" title="AnypaperParameters">
<link rel="next" href="anypaper-anypaper-window.html" title="AnypaperWindow">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="anypaper-anypaper-parameters.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">anypaper Reference Manual</th>
<td><a accesskey="n" href="anypaper-anypaper-window.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#anypaper-anypaper-image.synopsis" class="shortcut">Top</a>
 | 
<a href="#anypaper-anypaper-image.description" class="shortcut">Description</a>
 | 
<a href="#anypaper-anypaper-image.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="anypaper-anypaper-image"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="anypaper-anypaper-image.top_of_page"></a>AnypaperImage</span></h2>
<p>AnypaperImage — genarates the images used by anyPaper</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="anypaper-anypaper-image.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="anypaper-anypaper-image.synopsis"></a><h2>Synopsis</h2>
<a name="AnypaperImage"></a><pre class="synopsis">
#include &lt;anypaper_image.h&gt;
<a class="link" href="anypaper-anypaper-image.html#AnypaperImagePrivate" title="AnypaperImagePrivate">AnypaperImagePrivate</a>;
struct <a class="link" href="anypaper-anypaper-image.html#AnypaperImage-struct" title="struct AnypaperImage">AnypaperImage</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="anypaper-anypaper-image.html#anypaper-image-make" title="anypaper_image_make ()">anypaper_image_make</a> (<em class="parameter"><code><a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a> *image</code></em>,
<em class="parameter"><code><a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> *parameters</code></em>);
<span class="returnvalue">void</span> <a class="link" href="anypaper-anypaper-image.html#anypaper-image-move" title="anypaper_image_move ()">anypaper_image_move</a> (<em class="parameter"><code><a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a> *image</code></em>,
<em class="parameter"><code><a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> *parameters</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-image.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----AnypaperImage
</pre>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-image.description"></a><h2>Description</h2>
<p>
This application class generates the images used by anyPaper
</p>
<p>
The images present in <a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a> are created by <a class="link" href="anypaper-anypaper-image.html#anypaper-image-move" title="anypaper_image_move ()"><code class="function">anypaper_image_move()</code></a> using the parameters passed to function and images previously created by <a class="link" href="anypaper-anypaper-image.html#anypaper-image-make" title="anypaper_image_make ()"><code class="function">anypaper_image_make()</code></a>. The <a class="link" href="anypaper-anypaper-image.html#anypaper-image-make" title="anypaper_image_make ()"><code class="function">anypaper_image_make()</code></a> function modifies some parameters passed by <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> (mainly positionx and positiony, for indicating the range allowed for the variables) so they must be updated.
</p>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-image.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AnypaperImagePrivate"></a><h3>AnypaperImagePrivate</h3>
<pre class="programlisting">typedef struct _AnypaperImagePrivate AnypaperImagePrivate;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AnypaperImage-struct"></a><h3>struct AnypaperImage</h3>
<pre class="programlisting">struct AnypaperImage {
GdkPixbuf *image;
GdkPixbuf *preview;
};
</pre>
<p>
Contains the generated images used by the program
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">GdkPixbuf</span> *<em class="structfield"><code><a name="AnypaperImage-struct.image"></a>image</code></em>;</span></p></td>
<td>contains the real size image created by anyPaper</td>
</tr>
<tr>
<td><p><span class="term"><span class="type">GdkPixbuf</span> *<em class="structfield"><code><a name="AnypaperImage-struct.preview"></a>preview</code></em>;</span></p></td>
<td>contains a thumbnail of the image created by anyPaper</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anypaper-image-make"></a><h3>anypaper_image_make ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> anypaper_image_make (<em class="parameter"><code><a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a> *image</code></em>,
<em class="parameter"><code><a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> *parameters</code></em>);</pre>
<p>
Generate a <span class="type">GdkPixbuf</span> background and a <span class="type">GdkPixbuf</span> base image with the parameters selected in <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
<td>a <a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parameters</code></em> :</span></p></td>
<td>a <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the image file is successfully opened, <code class="literal">FALSE</code> if an error occurs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anypaper-image-move"></a><h3>anypaper_image_move ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> anypaper_image_move (<em class="parameter"><code><a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a> *image</code></em>,
<em class="parameter"><code><a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> *parameters</code></em>);</pre>
<p>
Generate the <span class="type">GdkPixbuf</span> image and the <span class="type">GdkPixbuf</span> preview present in <a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a> struct with the parameters selected in <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> and the images created by <a class="link" href="anypaper-anypaper-image.html#anypaper-image-make" title="anypaper_image_make ()"><code class="function">anypaper_image_make()</code></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>image</code></em> :</span></p></td>
<td>a <a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parameters</code></em> :</span></p></td>
<td>a <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-image.see-also"></a><h2>See Also</h2>
<a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>