← Back to branch summary

~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): Daniel Holbach
  • Date: 2007-05-02 16:33:03 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20070502163303-bvzhjzbpw8qglc4y
Tags: 2.3.16-1ubuntu1
* Resynchronized with Debian, remaining Ubuntu changes:
  - debian/rules: i18n magic.
* debian/control.in:
  - Maintainer: Ubuntu Core Developers <ubuntu-devel@lists.ubuntu.com>
* debian/patches/02_help-message.patch,
  debian/patches/03_gimp.desktop.in.in.patch,
  debian/patches/10_dont_show_wizard.patch: updated.
* debian/patches/04_composite-signedness.patch,
  debian/patches/05_add-letter-spacing.patch: dropped, used upstream.

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>gimpmemsize</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
7
<link rel="start" href="index.html" title="GIMP Base Library Reference Manual">
8
8
<link rel="up" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
9
9
<link rel="prev" href="libgimpbase-gimpenv.html" title="gimpenv">
10
 
<link rel="next" href="libgimpbase-gimpparasite.html" title="gimpparasite">
11
 
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
 
10
<link rel="next" href="libgimpbase-gimprectangle.html" title="gimprectangle">
 
11
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="part" href="libgimpbase.html" title="Part&#160;I.&#160;GIMP Base Library">
 
14
<link rel="index" href="libgimpbase-index.html" title="Index">
 
15
<link rel="index" href="libgimpbase-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
 
16
<link rel="index" href="libgimpbase-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
 
17
<link rel="index" href="libgimpbase-index-deprecated.html" title="Index of deprecated symbols">
14
18
</head>
15
19
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
16
20
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
19
23
<td><a accesskey="u" href="libgimpbase.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
20
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
21
25
<th width="100%" align="center">GIMP Base Library Reference Manual</th>
22
 
<td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
26
<td><a accesskey="n" href="libgimpbase-gimprectangle.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
27
</tr>
24
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2561991" class="shortcut">Top</a>
 
28
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2587512" class="shortcut">Top</a>
25
29
                  &#160;|&#160;
26
 
                  <a href="#id2543707" class="shortcut">Description</a></nobr></td></tr>
 
30
                  <a href="#id2601906" class="shortcut">Description</a></nobr></td></tr>
27
31
</table>
28
32
<div class="refentry" lang="en">
29
33
<a name="libgimpbase-gimpmemsize"></a><div class="titlepage"></div>
30
34
<div class="refnamediv"><table width="100%"><tr>
31
35
<td valign="top">
32
36
<h2>
33
 
<a name="id2561991"></a><span class="refentrytitle">gimpmemsize</span>
 
37
<a name="id2587512"></a><span class="refentrytitle">gimpmemsize</span>
34
38
</h2>
35
39
<p>gimpmemsize &#8212; Functions to (de)serialize a given memory size.</p>
36
40
</td>
42
46
 
43
47
 
44
48
 
45
 
gchar*      <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a>          (guint64 memsize);
46
 
gboolean    <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a>        (const gchar *string,
47
 
                                             guint64 *memsize);
48
 
gchar*      <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a>          (guint64 memsize);
49
 
#define     <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</a>
50
 
#define     <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a>        (value)
 
49
gchar*              <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a>              (guint64 memsize);
 
50
gboolean            <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a>            (const gchar *string,
 
51
                                                         guint64 *memsize);
 
52
gchar*              <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a>              (guint64 memsize);
 
53
#define             <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</a>
 
54
#define             <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-PARAM-MEMSIZE:CAPS">GIMP_TYPE_PARAM_MEMSIZE</a>
 
55
#define             <a href="libgimpbase-gimpmemsize.html#GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS">GIMP_IS_PARAM_SPEC_MEMSIZE</a>          (pspec)
 
56
GParamSpec*         <a href="libgimpbase-gimpmemsize.html#gimp-param-spec-memsize">gimp_param_spec_memsize</a>             (const gchar *name,
 
57
                                                         const gchar *nick,
 
58
                                                         const gchar *blurb,
 
59
                                                         guint64 minimum,
 
60
                                                         guint64 maximum,
 
61
                                                         guint64 default_value,
 
62
                                                         GParamFlags flags);
 
63
#define             <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a>            (value)
51
64
 
52
65
</pre>
53
66
</div>
54
67
<div class="refsect1" lang="en">
55
 
<a name="id2543707"></a><h2>Description</h2>
 
68
<a name="id2601906"></a><h2>Description</h2>
56
69
<p>
57
70
Functions to (de)serialize a given memory size.
58
71
</p>
59
72
</div>
60
73
<div class="refsect1" lang="en">
61
 
<a name="id2543723"></a><h2>Details</h2>
 
74
<a name="id2601922"></a><h2>Details</h2>
62
75
<div class="refsect2" lang="en">
63
 
<a name="id2543734"></a><h3>
 
76
<a name="id2601933"></a><h3>
64
77
<a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3>
65
 
<a class="indexterm" name="id2543747"></a><pre class="programlisting">gchar*      gimp_memsize_serialize          (guint64 memsize);</pre>
 
78
<a class="indexterm" name="id2601276"></a><pre class="programlisting">gchar*              gimp_memsize_serialize              (guint64 memsize);</pre>
66
79
<p>
67
80
Creates a string representation of a given memory size. This string
68
81
can be parsed by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize"><code class="function">gimp_memsize_deserialize()</code></a> and can thus be used in
75
88
<col align="left" valign="top">
76
89
<tbody>
77
90
<tr>
78
 
<td>
79
 
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
 
91
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
80
92
<td> memory size in bytes
81
93
</td>
82
94
</tr>
83
95
<tr>
84
 
<td>
85
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
96
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
86
97
<td> A newly allocated string representation of <em class="parameter"><code>memsize</code></em>.
87
98
 
88
99
</td>
89
100
</tr>
90
101
</tbody>
91
102
</table></div>
92
 
<p>Since  GIMP 2.2
 
103
<p class="since">Since  GIMP 2.2
93
104
</p>
94
105
</div>
95
106
<hr>
96
107
<div class="refsect2" lang="en">
97
 
<a name="id2544691"></a><h3>
 
108
<a name="id2601370"></a><h3>
98
109
<a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3>
99
 
<a class="indexterm" name="id2544704"></a><pre class="programlisting">gboolean    gimp_memsize_deserialize        (const gchar *string,
100
 
                                             guint64 *memsize);</pre>
 
110
<a class="indexterm" name="id2601384"></a><pre class="programlisting">gboolean            gimp_memsize_deserialize            (const gchar *string,
 
111
                                                         guint64 *memsize);</pre>
101
112
<p>
102
113
Parses a string representation of a memory size as returned by
103
114
<a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>.</p>
108
119
<col align="left" valign="top">
109
120
<tbody>
110
121
<tr>
111
 
<td>
112
 
<span class="term"><em class="parameter"><code>string</code></em>&#160;:</span></td>
 
122
<td><span class="term"><em class="parameter"><code>string</code></em>&#160;:</span></td>
113
123
<td>  a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><code class="function">gimp_memsize_serialize()</code></a>
114
124
</td>
115
125
</tr>
116
126
<tr>
117
 
<td>
118
 
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
 
127
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
119
128
<td> return location for memory size in bytes
120
129
</td>
121
130
</tr>
122
131
<tr>
123
 
<td>
124
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
132
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
125
133
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>string</code></em> was successfully parsed and
126
134
              <em class="parameter"><code>memsize</code></em> has been set, <code class="literal">FALSE</code> otherwise.
127
135
 
129
137
</tr>
130
138
</tbody>
131
139
</table></div>
132
 
<p>Since  GIMP 2.2
 
140
<p class="since">Since  GIMP 2.2
133
141
</p>
134
142
</div>
135
143
<hr>
136
144
<div class="refsect2" lang="en">
137
 
<a name="id2555586"></a><h3>
 
145
<a name="id2558618"></a><h3>
138
146
<a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3>
139
 
<a class="indexterm" name="id2555597"></a><pre class="programlisting">gchar*      gimp_memsize_to_string          (guint64 memsize);</pre>
 
147
<a class="indexterm" name="id2558629"></a><pre class="programlisting">gchar*              gimp_memsize_to_string              (guint64 memsize);</pre>
140
148
<p>
141
149
This function returns a human readable, translated representation
142
150
of the passed <em class="parameter"><code>memsize</code></em>. Large values are displayed using a
149
157
<col align="left" valign="top">
150
158
<tbody>
151
159
<tr>
152
 
<td>
153
 
<span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
 
160
<td><span class="term"><em class="parameter"><code>memsize</code></em>&#160;:</span></td>
154
161
<td> A memory size in bytes.
155
162
</td>
156
163
</tr>
157
164
<tr>
158
 
<td>
159
 
<span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
165
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
160
166
<td> A newly allocated human-readable, translated string.
161
167
</td>
162
168
</tr>
165
171
</div>
166
172
<hr>
167
173
<div class="refsect2" lang="en">
168
 
<a name="id2555667"></a><h3>
 
174
<a name="id2558699"></a><h3>
169
175
<a name="GIMP-TYPE-MEMSIZE:CAPS"></a>GIMP_TYPE_MEMSIZE</h3>
170
 
<a class="indexterm" name="id2555678"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE               (gimp_memsize_get_type ())
 
176
<a class="indexterm" name="id2558710"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE               (gimp_memsize_get_type ())
171
177
</pre>
172
178
<p>
173
179
<a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE:CAPS"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <span class="type">GType</span> derived from <span class="type">G_TYPE_UINT64</span>.
175
181
</div>
176
182
<hr>
177
183
<div class="refsect2" lang="en">
178
 
<a name="id2555715"></a><h3>
 
184
<a name="id2558748"></a><h3>
 
185
<a name="GIMP-TYPE-PARAM-MEMSIZE:CAPS"></a>GIMP_TYPE_PARAM_MEMSIZE</h3>
 
186
<a class="indexterm" name="id2558760"></a><pre class="programlisting">#define GIMP_TYPE_PARAM_MEMSIZE           (gimp_param_memsize_get_type ())
 
187
</pre>
 
188
<p>
 
189
 
 
190
</p>
 
191
</div>
 
192
<hr>
 
193
<div class="refsect2" lang="en">
 
194
<a name="id2575872"></a><h3>
 
195
<a name="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS"></a>GIMP_IS_PARAM_SPEC_MEMSIZE()</h3>
 
196
<a class="indexterm" name="id2575883"></a><pre class="programlisting">#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
 
197
</pre>
 
198
<p>
 
199
 
 
200
</p>
 
201
<div class="variablelist"><table border="0">
 
202
<col align="left" valign="top">
 
203
<tbody><tr>
 
204
<td><span class="term"><em class="parameter"><code>pspec</code></em>&#160;:</span></td>
 
205
<td>
 
206
 
 
207
 
 
208
</td>
 
209
</tr></tbody>
 
210
</table></div>
 
211
</div>
 
212
<hr>
 
213
<div class="refsect2" lang="en">
 
214
<a name="id2575919"></a><h3>
 
215
<a name="gimp-param-spec-memsize"></a>gimp_param_spec_memsize ()</h3>
 
216
<a class="indexterm" name="id2575932"></a><pre class="programlisting">GParamSpec*         gimp_param_spec_memsize             (const gchar *name,
 
217
                                                         const gchar *nick,
 
218
                                                         const gchar *blurb,
 
219
                                                         guint64 minimum,
 
220
                                                         guint64 maximum,
 
221
                                                         guint64 default_value,
 
222
                                                         GParamFlags flags);</pre>
 
223
<p>
 
224
Creates a param spec to hold a memory size value.
 
225
See <code class="function">g_param_spec_internal()</code> for more information.</p>
 
226
<p>
 
227
 
 
228
</p>
 
229
<div class="variablelist"><table border="0">
 
230
<col align="left" valign="top">
 
231
<tbody>
 
232
<tr>
 
233
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
234
<td>          Canonical name of the param
 
235
</td>
 
236
</tr>
 
237
<tr>
 
238
<td><span class="term"><em class="parameter"><code>nick</code></em>&#160;:</span></td>
 
239
<td>          Nickname of the param
 
240
</td>
 
241
</tr>
 
242
<tr>
 
243
<td><span class="term"><em class="parameter"><code>blurb</code></em>&#160;:</span></td>
 
244
<td>         Brief desciption of param.
 
245
</td>
 
246
</tr>
 
247
<tr>
 
248
<td><span class="term"><em class="parameter"><code>minimum</code></em>&#160;:</span></td>
 
249
<td>       Smallest allowed value of the parameter.
 
250
</td>
 
251
</tr>
 
252
<tr>
 
253
<td><span class="term"><em class="parameter"><code>maximum</code></em>&#160;:</span></td>
 
254
<td>       Largest allowed value of the parameter.
 
255
</td>
 
256
</tr>
 
257
<tr>
 
258
<td><span class="term"><em class="parameter"><code>default_value</code></em>&#160;:</span></td>
 
259
<td> Value to use if none is assigned.
 
260
</td>
 
261
</tr>
 
262
<tr>
 
263
<td><span class="term"><em class="parameter"><code>flags</code></em>&#160;:</span></td>
 
264
<td>         a combination of <span class="type">GParamFlags</span>
 
265
</td>
 
266
</tr>
 
267
<tr>
 
268
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
269
<td> a newly allocated <span class="type">GParamSpec</span> instance
 
270
 
 
271
</td>
 
272
</tr>
 
273
</tbody>
 
274
</table></div>
 
275
<p class="since">Since  GIMP 2.4
 
276
</p>
 
277
</div>
 
278
<hr>
 
279
<div class="refsect2" lang="en">
 
280
<a name="id2603494"></a><h3>
179
281
<a name="GIMP-VALUE-HOLDS-MEMSIZE:CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3>
180
 
<a class="indexterm" name="id2555727"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
 
282
<a class="indexterm" name="id2603505"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
181
283
</pre>
182
284
<p>
183
285
 
185
287
<div class="variablelist"><table border="0">
186
288
<col align="left" valign="top">
187
289
<tbody><tr>
188
 
<td>
189
 
<span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
 
290
<td><span class="term"><em class="parameter"><code>value</code></em>&#160;:</span></td>
190
291
<td>
191
292
 
192
293