Files
gimp/devel-docs/libgimpwidgets/html/GimpMemsizeEntry.html
2010-08-11 01:21:06 -04:00

244 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GimpMemsizeEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.71.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="GimpIntStore.html" title="GimpIntStore">
<link rel="next" href="GimpOffsetArea.html" title="GimpOffsetArea">
<meta name="generator" content="GTK-Doc V1.7 (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">
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part&#160;II.&#160;GIMP Display Filters">
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part&#160;III.&#160;GIMP Color Selectors">
<link rel="part" href="libgimpwidgets-controller.html" title="Part&#160;IV.&#160;GIMP Controllers">
<link rel="part" href="libgimpwidgets-utils.html" title="Part&#160;V.&#160;GIMP Widgets Utilities">
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part&#160;VI.&#160;Deprecated API">
<link rel="index" href="libgimpwidgets-index.html" title="Index">
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
</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="GimpIntStore.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimpwidgets-widgets.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">GIMP Widgets Library Reference Manual</th>
<td><a accesskey="n" href="GimpOffsetArea.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="#id2590888" class="shortcut">Top</a>
&#160;|&#160;
<a href="#id2605836" class="shortcut">Description</a>
&#160;|&#160;
<a href="#id2605627" class="shortcut">Object Hierarchy</a>
&#160;|&#160;
<a href="#id2605686" class="shortcut">Implemented Interfaces</a>
&#160;|&#160;
<a href="#id2605707" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GimpMemsizeEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2590888"></a><span class="refentrytitle">GimpMemsizeEntry</span>
</h2>
<p>GimpMemsizeEntry &#8212; A composite widget that allows to enter a memory size.</p>
</td>
<td valign="top" align="right"><img src="gimp-memsize-entry.png"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="GimpMemsizeEntry.html#GimpMemsizeEntry-struct">GimpMemsizeEntry</a>;
GtkWidget* <a href="GimpMemsizeEntry.html#gimp-memsize-entry-new">gimp_memsize_entry_new</a> (guint64 value,
guint64 lower,
guint64 upper);
void <a href="GimpMemsizeEntry.html#gimp-memsize-entry-set-value">gimp_memsize_entry_set_value</a> (<a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">GimpMemsizeEntry</a> *entry,
guint64 value);
guint64 <a href="GimpMemsizeEntry.html#gimp-memsize-entry-get-value">gimp_memsize_entry_get_value</a> (<a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">GimpMemsizeEntry</a> *entry);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2605627"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkContainer
+----GtkBox
+----GtkHBox
+----GimpMemsizeEntry
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2605686"></a><h2>Implemented Interfaces</h2>
<p>
GimpMemsizeEntry implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2605707"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="GimpMemsizeEntry.html#GimpMemsizeEntry-value-changed">value-changed</a>"
void user_function (<a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">GimpMemsizeEntry</a> *gimpmemsizeentry,
gpointer user_data) : Run first
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2605836"></a><h2>Description</h2>
<p>
Similar to a <a href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> but instead of lengths, this widget is used to let
the user enter memory sizes. An option menu allows to switch between
Kilobytes, Megabytes and Gigabytes. Used in the GIMP preferences dialog.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2605862"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2605873"></a><h3>
<a name="GimpMemsizeEntry-struct"></a>GimpMemsizeEntry</h3>
<a class="indexterm" name="id2605885"></a><pre class="programlisting">typedef struct _GimpMemsizeEntry GimpMemsizeEntry;</pre>
<p>
The <a href="GimpSizeEntry.html" title="GimpSizeEntry"><span class="type">GimpSizeEntry</span></a> struct is considered private.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2605908"></a><h3>
<a name="gimp-memsize-entry-new"></a>gimp_memsize_entry_new ()</h3>
<a class="indexterm" name="id2605920"></a><pre class="programlisting">GtkWidget* gimp_memsize_entry_new (guint64 value,
guint64 lower,
guint64 upper);</pre>
<p>
Creates a new <a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry"><span class="type">GimpMemsizeEntry</span></a> which is a <span class="type">GtkHBox</span> with a <span class="type">GtkSpinButton</span>
and a <span class="type">GtkOptionMenu</span> all setup to allow the user to enter memory sizes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> the initial value (in Bytes)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>lower</code></em>&#160;:</span></td>
<td> the lower limit for the value (in Bytes)
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>upper</code></em>&#160;:</span></td>
<td> the upper limit for the value (in Bytes)
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> Pointer to the new <a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry"><span class="type">GimpMemsizeEntry</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604712"></a><h3>
<a name="gimp-memsize-entry-set-value"></a>gimp_memsize_entry_set_value ()</h3>
<a class="indexterm" name="id2604723"></a><pre class="programlisting">void gimp_memsize_entry_set_value (<a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">GimpMemsizeEntry</a> *entry,
guint64 value);</pre>
<p>
Sets the <em class="parameter"><code>entry</code></em>'s value. Please note that the <a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry"><span class="type">GimpMemsizeEntry</span></a> rounds
the value to full Kilobytes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
<td> a <a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry"><span class="type">GimpMemsizeEntry</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
<td> the new value (in Bytes)
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2604813"></a><h3>
<a name="gimp-memsize-entry-get-value"></a>gimp_memsize_entry_get_value ()</h3>
<a class="indexterm" name="id2604825"></a><pre class="programlisting">guint64 gimp_memsize_entry_get_value (<a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">GimpMemsizeEntry</a> *entry);</pre>
<p>
Retrieves the current value from a <a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry"><span class="type">GimpMemsizeEntry</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>entry</code></em>&#160;:</span></td>
<td> a <a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry"><span class="type">GimpMemsizeEntry</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the current value of <em class="parameter"><code>entry</code></em> (in Bytes).
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2602206"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2602216"></a><h3>
<a name="GimpMemsizeEntry-value-changed"></a>The "value-changed" signal</h3>
<a class="indexterm" name="id2602226"></a><pre class="programlisting">void user_function (<a href="GimpMemsizeEntry.html" title="GimpMemsizeEntry">GimpMemsizeEntry</a> *gimpmemsizeentry,
gpointer user_data) : Run first</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>gimpmemsizeentry</code></em>&#160;:</span></td>
<td>the object which received the signal.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>