← Back to branch summary

~ubuntu-branches/ubuntu/hoary/gimp/hoary

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2005-04-04 14:51:23 UTC
  • Revision ID: james.westby@ubuntu.com-20050404145123-9py049eeelfymur8
Tags: upstream-2.2.2
Import upstream version 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpbase/html/libgimpbase-gimpmemsize.html
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimpmemsize</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="GIMP Base Library Reference Manual"><link rel="up" href="libgimpbase.html" title="Part�I.�GIMP Base Library"><link rel="prev" href="libgimpbase-gimpenv.html" title="gimpenv"><link rel="next" href="libgimpbase-gimpparasite.html" title="gimpparasite"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
 
2
        .synopsis, .classsynopsis {
 
3
            background: #eeeeee;
 
4
            border: solid 1px #aaaaaa;
 
5
            padding: 0.5em;
 
6
        }
 
7
        .programlisting {
 
8
            background: #eeeeff;
 
9
            border: solid 1px #aaaaff;
 
10
            padding: 0.5em;
 
11
        }
 
12
        .variablelist {
 
13
            padding: 4px;
 
14
            margin-left: 3em;
 
15
        }
 
16
        .navigation {
 
17
            background: #ffeeee;
 
18
            border: solid 1px #ffaaaa;
 
19
            margin-top: 0.5em;
 
20
            margin-bottom: 0.5em;
 
21
        }
 
22
        .navigation a {
 
23
            color: #770000;
 
24
        }
 
25
        .navigation a:visited {
 
26
            color: #550000;
 
27
        }
 
28
        .navigation .title {
 
29
            font-size: 200%;
 
30
        }
 
31
      </style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="libgimpbase-gimpenv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="libgimpbase.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 Base Library Reference Manual</th><td><a accesskey="n" href="libgimpbase-gimpparasite.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="libgimpbase-gimpmemsize"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">gimpmemsize</span></h2><p>gimpmemsize &#8212; Functions to (de)serialize a given memory size.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
 
32
 
 
33
 
 
34
 
 
35
<a
 
36
href="../glib/glib-Basic-Types.html#gchar"
 
37
>gchar</a>*      <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize">gimp_memsize_serialize</a>          (<a
 
38
href="../glib/glib-Basic-Types.html#guint64"
 
39
>guint64</a> memsize);
 
40
<a
 
41
href="../glib/glib-Basic-Types.html#gboolean"
 
42
>gboolean</a>    <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize">gimp_memsize_deserialize</a>        (const <a
 
43
href="../glib/glib-Basic-Types.html#gchar"
 
44
>gchar</a> *string,
 
45
                                             <a
 
46
href="../glib/glib-Basic-Types.html#guint64"
 
47
>guint64</a> *memsize);
 
48
<a
 
49
href="../glib/glib-Basic-Types.html#gchar"
 
50
>gchar</a>*      <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string">gimp_memsize_to_string</a>          (<a
 
51
href="../glib/glib-Basic-Types.html#guint64"
 
52
>guint64</a> memsize);
 
53
#define     <a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE-CAPS">GIMP_TYPE_MEMSIZE</a>
 
54
#define     <a href="libgimpbase-gimpmemsize.html#GIMP-VALUE-HOLDS-MEMSIZE-CAPS">GIMP_VALUE_HOLDS_MEMSIZE</a>        (value)
 
55
 
 
56
</pre></div><div class="refsect1" lang="en"><a name="id2535259"></a><h2>Description</h2><p>
 
57
Functions to (de)serialize a given memory size.
 
58
</p></div><div class="refsect1" lang="en"><a name="id2535270"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2535275"></a><h3><a name="gimp-memsize-serialize"></a>gimp_memsize_serialize ()</h3><a class="indexterm" name="id2535283"></a><pre class="programlisting"><a
 
59
href="../glib/glib-Basic-Types.html#gchar"
 
60
>gchar</a>*      gimp_memsize_serialize          (<a
 
61
href="../glib/glib-Basic-Types.html#guint64"
 
62
>guint64</a> memsize);</pre><p>
 
63
Creates a string representation of a given memory size. This string
 
64
can be parsed by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-deserialize"><tt class="function">gimp_memsize_deserialize()</tt></a> and can thus be used in
 
65
config files. It should not be displayed to the user. If you need a
 
66
nice human-readable string please use <a href="libgimpbase-gimpmemsize.html#gimp-memsize-to-string"><tt class="function">gimp_memsize_to_string()</tt></a>.</p><p>
 
67
 
 
68
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>memsize</tt></i>�:</span></td><td> memory size in bytes
 
69
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A newly allocated string representation of <i class="parameter"><tt>memsize</tt></i>.
 
70
 
 
71
</td></tr></tbody></table></div><p>Since  GIMP 2.2
 
72
</p></div><hr><div class="refsect2" lang="en"><a name="id2568192"></a><h3><a name="gimp-memsize-deserialize"></a>gimp_memsize_deserialize ()</h3><a class="indexterm" name="id2568201"></a><pre class="programlisting"><a
 
73
href="../glib/glib-Basic-Types.html#gboolean"
 
74
>gboolean</a>    gimp_memsize_deserialize        (const <a
 
75
href="../glib/glib-Basic-Types.html#gchar"
 
76
>gchar</a> *string,
 
77
                                             <a
 
78
href="../glib/glib-Basic-Types.html#guint64"
 
79
>guint64</a> *memsize);</pre><p>
 
80
Parses a string representation of a memory size as returned by
 
81
<a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><tt class="function">gimp_memsize_serialize()</tt></a>.</p><p>
 
82
 
 
83
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>string</tt></i>�:</span></td><td>  a string as returned by <a href="libgimpbase-gimpmemsize.html#gimp-memsize-serialize"><tt class="function">gimp_memsize_serialize()</tt></a>
 
84
</td></tr><tr><td><span class="term"><i class="parameter"><tt>memsize</tt></i>�:</span></td><td> return location for memory size in bytes
 
85
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> <tt class="literal">TRUE</tt> if the <i class="parameter"><tt>string</tt></i> was successfully parsed and
 
86
              <i class="parameter"><tt>memsize</tt></i> has been set, <tt class="literal">FALSE</tt> otherwise.
 
87
 
 
88
</td></tr></tbody></table></div><p>Since  GIMP 2.2
 
89
</p></div><hr><div class="refsect2" lang="en"><a name="id2581976"></a><h3><a name="gimp-memsize-to-string"></a>gimp_memsize_to_string ()</h3><a class="indexterm" name="id2581984"></a><pre class="programlisting"><a
 
90
href="../glib/glib-Basic-Types.html#gchar"
 
91
>gchar</a>*      gimp_memsize_to_string          (<a
 
92
href="../glib/glib-Basic-Types.html#guint64"
 
93
>guint64</a> memsize);</pre><p>
 
94
This function returns a human readable, translated representation
 
95
of the passed <i class="parameter"><tt>memsize</tt></i>. Large values are displayed using a
 
96
reasonable memsize unit, e.g.: "345" becomes "345 Bytes", "4500"
 
97
becomes "4.4 KB" and so on.</p><p>
 
98
 
 
99
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>memsize</tt></i>�:</span></td><td> A memory size in bytes.
 
100
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> A newly allocated human-readable, translated string.
 
101
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2582038"></a><h3><a name="GIMP-TYPE-MEMSIZE-CAPS"></a>GIMP_TYPE_MEMSIZE</h3><a class="indexterm" name="id2582047"></a><pre class="programlisting">#define GIMP_TYPE_MEMSIZE               (gimp_memsize_get_type ())
 
102
</pre><p>
 
103
<a href="libgimpbase-gimpmemsize.html#GIMP-TYPE-MEMSIZE-CAPS"><span class="type">GIMP_TYPE_MEMSIZE</span></a> is a <a
 
104
href="../gobject/gobject-GType.html#GType"
 
105
><span class="type">GType</span></a> derived from <a
 
106
href="../gobject/gobject-GType.html#G-TYPE-UINT64-CAPS"
 
107
><span class="type">G_TYPE_UINT64</span></a>.
 
108
</p></div><hr><div class="refsect2" lang="en"><a name="id2568731"></a><h3><a name="GIMP-VALUE-HOLDS-MEMSIZE-CAPS"></a>GIMP_VALUE_HOLDS_MEMSIZE()</h3><a class="indexterm" name="id2568740"></a><pre class="programlisting">#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
 
109
</pre><p>
 
110
 
 
111
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>value</tt></i>�:</span></td><td>
 
112
 
 
113
 
 
114
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimpbase-gimpenv.html"><b>&lt;&lt;�gimpenv</b></a></td><td align="right"><a accesskey="n" href="libgimpbase-gimpparasite.html"><b>gimpparasite�&gt;&gt;</b></a></td></tr></table></body></html>