~ubuntu-branches/ubuntu/jaunty/gimp/jaunty-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html

  • Committer: Bazaar Package Importer
  • Author(s): Pedro Fragoso
  • Date: 2008-08-22 11:50:05 UTC
  • mfrom: (0.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 34.
  • Revision ID: james.westby@ubuntu.com-20080822115005-yxj5svf3v9x1mkr7
Tags: upstream-2.4.7
Import upstream version 2.4.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
41
41
<div class="refsynopsisdiv">
42
42
<a name="libgimpbase-gimpmemsize.synopsis"></a><h2>Synopsis</h2>
43
43
<pre class="synopsis">
44
 
<a
45
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
46
 
>gchar</a>*              <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" title="gimp_memsize_serialize ()">gimp_memsize_serialize</a>              (<a
47
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
48
 
>guint64</a> memsize);
49
 
<a
50
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
51
 
>gboolean</a>            <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize" title="gimp_memsize_deserialize ()">gimp_memsize_deserialize</a>            (const <a
52
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
53
 
>gchar</a> *string,
54
 
                                                         <a
55
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
56
 
>guint64</a> *memsize);
57
 
<a
58
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
59
 
>gchar</a>*              <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string" title="gimp_memsize_to_string ()">gimp_memsize_to_string</a>              (<a
60
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
61
 
>guint64</a> memsize);
 
44
gchar*              <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" title="gimp_memsize_serialize ()">gimp_memsize_serialize</a>              (guint64 memsize);
 
45
gboolean            <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize" title="gimp_memsize_deserialize ()">gimp_memsize_deserialize</a>            (const gchar *string,
 
46
                                                         guint64 *memsize);
 
47
gchar*              <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string" title="gimp_memsize_to_string ()">gimp_memsize_to_string</a>              (guint64 memsize);
62
48
#define             <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS" title="GIMP_TYPE_MEMSIZE">GIMP_TYPE_MEMSIZE</a>
63
49
#define             <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-PARAM-MEMSIZE:CAPS" title="GIMP_TYPE_PARAM_MEMSIZE">GIMP_TYPE_PARAM_MEMSIZE</a>
64
50
#define             <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS" title="GIMP_IS_PARAM_SPEC_MEMSIZE()">GIMP_IS_PARAM_SPEC_MEMSIZE</a>          (pspec)
65
 
<a
66
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
67
 
>GParamSpec</a>*         <a class="link" href="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize" title="gimp_param_spec_memsize ()">gimp_param_spec_memsize</a>             (const <a
68
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
69
 
>gchar</a> *name,
70
 
                                                         const <a
71
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
72
 
>gchar</a> *nick,
73
 
                                                         const <a
74
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
75
 
>gchar</a> *blurb,
76
 
                                                         <a
77
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
78
 
>guint64</a> minimum,
79
 
                                                         <a
80
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
81
 
>guint64</a> maximum,
82
 
                                                         <a
83
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
84
 
>guint64</a> default_value,
85
 
                                                         <a
86
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
87
 
>GParamFlags</a> flags);
 
51
GParamSpec*         <a class="link" href="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize" title="gimp_param_spec_memsize ()">gimp_param_spec_memsize</a>             (const gchar *name,
 
52
                                                         const gchar *nick,
 
53
                                                         const gchar *blurb,
 
54
                                                         guint64 minimum,
 
55
                                                         guint64 maximum,
 
56
                                                         guint64 default_value,
 
57
                                                         GParamFlags flags);
88
58
#define             <a class="link" href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS" title="GIMP_VALUE_HOLDS_MEMSIZE()">GIMP_VALUE_HOLDS_MEMSIZE</a>            (value)
89
59
</pre>
90
60
</div>
98
68
<a name="libgimpbase-gimpmemsize.details"></a><h2>Details</h2>
99
69
<div class="refsect2" lang="en">
100
70
<a name="gimp-memsize-serialize"></a><h3>gimp_memsize_serialize ()</h3>
101
 
<pre class="programlisting"><a
102
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
103
 
>gchar</a>*              gimp_memsize_serialize              (<a
104
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
105
 
>guint64</a> memsize);</pre>
 
71
<pre class="programlisting">gchar*              gimp_memsize_serialize              (guint64 memsize);</pre>
106
72
<p>
107
73
Creates a string representation of a given memory size. This string
108
74
can be parsed by <a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize" title="gimp_memsize_deserialize ()"><code class="function">gimp_memsize_deserialize()</code></a> and can thus be used in
133
99
<hr>
134
100
<div class="refsect2" lang="en">
135
101
<a name="gimp-memsize-deserialize"></a><h3>gimp_memsize_deserialize ()</h3>
136
 
<pre class="programlisting"><a
137
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
138
 
>gboolean</a>            gimp_memsize_deserialize            (const <a
139
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
140
 
>gchar</a> *string,
141
 
                                                         <a
142
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
143
 
>guint64</a> *memsize);</pre>
 
102
<pre class="programlisting">gboolean            gimp_memsize_deserialize            (const gchar *string,
 
103
                                                         guint64 *memsize);</pre>
144
104
<p>
145
105
Parses a string representation of a memory size as returned by
146
106
<a class="link" href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize" title="gimp_memsize_serialize ()"><code class="function">gimp_memsize_serialize()</code></a>.</p>
162
122
</tr>
163
123
<tr>
164
124
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
165
 
<td> <a
166
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
167
 
><code class="literal">TRUE</code></a> if the <em class="parameter"><code>string</code></em> was successfully parsed and
168
 
              <em class="parameter"><code>memsize</code></em> has been set, <a
169
 
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
170
 
><code class="literal">FALSE</code></a> otherwise.
 
125
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>string</code></em> was successfully parsed and
 
126
              <em class="parameter"><code>memsize</code></em> has been set, <code class="literal">FALSE</code> otherwise.
171
127
 
172
128
</td>
173
129
</tr>
179
135
<hr>
180
136
<div class="refsect2" lang="en">
181
137
<a name="gimp-memsize-to-string"></a><h3>gimp_memsize_to_string ()</h3>
182
 
<pre class="programlisting"><a
183
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
184
 
>gchar</a>*              gimp_memsize_to_string              (<a
185
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
186
 
>guint64</a> memsize);</pre>
 
138
<pre class="programlisting">gchar*              gimp_memsize_to_string              (guint64 memsize);</pre>
187
139
<p>
188
140
This function returns a human readable, translated representation
189
141
of the passed <em class="parameter"><code>memsize</code></em>. Large values are displayed using a
214
166
<pre class="programlisting">#define GIMP_TYPE_MEMSIZE               (gimp_memsize_get_type ())
215
167
</pre>
216
168
<p>
217
 
<a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS" title="GIMP_TYPE_MEMSIZE"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <a
218
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
219
 
><span class="type">GType</span></a> derived from <a
220
 
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#G-TYPE-UINT64:CAPS"
221
 
><span class="type">G_TYPE_UINT64</span></a>.
 
169
<a class="link" href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS" title="GIMP_TYPE_MEMSIZE"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_UINT64</span>.
222
170
</p>
223
171
</div>
224
172
<hr>
252
200
<hr>
253
201
<div class="refsect2" lang="en">
254
202
<a name="gimp-param-spec-memsize"></a><h3>gimp_param_spec_memsize ()</h3>
255
 
<pre class="programlisting"><a
256
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
257
 
>GParamSpec</a>*         gimp_param_spec_memsize             (const <a
258
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
259
 
>gchar</a> *name,
260
 
                                                         const <a
261
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
262
 
>gchar</a> *nick,
263
 
                                                         const <a
264
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
265
 
>gchar</a> *blurb,
266
 
                                                         <a
267
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
268
 
>guint64</a> minimum,
269
 
                                                         <a
270
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
271
 
>guint64</a> maximum,
272
 
                                                         <a
273
 
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"
274
 
>guint64</a> default_value,
275
 
                                                         <a
276
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
277
 
>GParamFlags</a> flags);</pre>
 
203
<pre class="programlisting">GParamSpec*         gimp_param_spec_memsize             (const gchar *name,
 
204
                                                         const gchar *nick,
 
205
                                                         const gchar *blurb,
 
206
                                                         guint64 minimum,
 
207
                                                         guint64 maximum,
 
208
                                                         guint64 default_value,
 
209
                                                         GParamFlags flags);</pre>
278
210
<p>
279
211
Creates a param spec to hold a memory size value.
280
 
See <a
281
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#g-param-spec-internal"
282
 
><code class="function">g_param_spec_internal()</code></a> for more information.</p>
 
212
See <code class="function">g_param_spec_internal()</code> for more information.</p>
283
213
<p>
284
214
 
285
215
</p>
318
248
</tr>
319
249
<tr>
320
250
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
321
 
<td>         a combination of <a
322
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamFlags"
323
 
><span class="type">GParamFlags</span></a>
 
251
<td>         a combination of <span class="type">GParamFlags</span>
324
252
</td>
325
253
</tr>
326
254
<tr>
327
255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
328
 
<td> a newly allocated <a
329
 
href="/usr/share/gtk-doc/html/gobject/gobject-GParamSpec.html#GParamSpec"
330
 
><span class="type">GParamSpec</span></a> instance
 
256
<td> a newly allocated <span class="type">GParamSpec</span> instance
331
257
 
332
258
</td>
333
259
</tr>