← Back to branch summary

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

« back to all changes in this revision

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

  • 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/xml/gimpmemsize.xml
22
22
 
23
23
 
24
24
 
25
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-memsize-serialize">gimp_memsize_serialize</link>          (<link linkend="guint64">guint64</link> memsize);
26
 
<link linkend="gboolean">gboolean</link>    <link linkend="gimp-memsize-deserialize">gimp_memsize_deserialize</link>        (const <link linkend="gchar">gchar</link> *string,
27
 
                                             <link linkend="guint64">guint64</link> *memsize);
28
 
<link linkend="gchar">gchar</link>*      <link linkend="gimp-memsize-to-string">gimp_memsize_to_string</link>          (<link linkend="guint64">guint64</link> memsize);
29
 
#define     <link linkend="GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</link>
30
 
#define     <link linkend="GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</link>        (value)
 
25
<link linkend="gchar">gchar</link>*              <link linkend="gimp-memsize-serialize">gimp_memsize_serialize</link>              (<link linkend="guint64">guint64</link> memsize);
 
26
<link linkend="gboolean">gboolean</link>            <link linkend="gimp-memsize-deserialize">gimp_memsize_deserialize</link>            (const <link linkend="gchar">gchar</link> *string,
 
27
                                                         <link linkend="guint64">guint64</link> *memsize);
 
28
<link linkend="gchar">gchar</link>*              <link linkend="gimp-memsize-to-string">gimp_memsize_to_string</link>              (<link linkend="guint64">guint64</link> memsize);
 
29
#define             <link linkend="GIMP-TYPE-MEMSIZE:CAPS">GIMP_TYPE_MEMSIZE</link>
 
30
#define             <link linkend="GIMP-TYPE-PARAM-MEMSIZE:CAPS">GIMP_TYPE_PARAM_MEMSIZE</link>
 
31
#define             <link linkend="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS">GIMP_IS_PARAM_SPEC_MEMSIZE</link>          (pspec)
 
32
<link linkend="GParamSpec">GParamSpec</link>*         <link linkend="gimp-param-spec-memsize">gimp_param_spec_memsize</link>             (const <link linkend="gchar">gchar</link> *name,
 
33
                                                         const <link linkend="gchar">gchar</link> *nick,
 
34
                                                         const <link linkend="gchar">gchar</link> *blurb,
 
35
                                                         <link linkend="guint64">guint64</link> minimum,
 
36
                                                         <link linkend="guint64">guint64</link> maximum,
 
37
                                                         <link linkend="guint64">guint64</link> default_value,
 
38
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);
 
39
#define             <link linkend="GIMP-VALUE-HOLDS-MEMSIZE:CAPS">GIMP_VALUE_HOLDS_MEMSIZE</link>            (value)
31
40
 
32
41
</synopsis>
33
42
</refsynopsisdiv>
51
60
<title role="details.title">Details</title>
52
61
<refsect2>
53
62
<title><anchor id="gimp-memsize-serialize" role="function" condition="since:GIMP 2.2"/>gimp_memsize_serialize ()</title>
54
 
<indexterm role="GIMP 2.2"><primary>gimp_memsize_serialize</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_memsize_serialize          (<link linkend="guint64">guint64</link> memsize);</programlisting>
 
63
<indexterm role="GIMP 2.2"><primary>gimp_memsize_serialize</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_memsize_serialize              (<link linkend="guint64">guint64</link> memsize);</programlisting>
55
64
<para>
56
65
Creates a string representation of a given memory size. This string
57
66
can be parsed by <link linkend="gimp-memsize-deserialize"><function>gimp_memsize_deserialize()</function></link> and can thus be used in
66
75
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A newly allocated string representation of <parameter>memsize</parameter>.
67
76
 
68
77
</simpara></listitem></varlistentry>
69
 
</variablelist><para>Since  GIMP 2.2
 
78
</variablelist><para role="since">Since  GIMP 2.2
70
79
</para></refsect2>
71
80
<refsect2>
72
81
<title><anchor id="gimp-memsize-deserialize" role="function" condition="since:GIMP 2.2"/>gimp_memsize_deserialize ()</title>
73
 
<indexterm role="GIMP 2.2"><primary>gimp_memsize_deserialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gimp_memsize_deserialize        (const <link linkend="gchar">gchar</link> *string,
74
 
                                             <link linkend="guint64">guint64</link> *memsize);</programlisting>
 
82
<indexterm role="GIMP 2.2"><primary>gimp_memsize_deserialize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gimp_memsize_deserialize            (const <link linkend="gchar">gchar</link> *string,
 
83
                                                         <link linkend="guint64">guint64</link> *memsize);</programlisting>
75
84
<para>
76
85
Parses a string representation of a memory size as returned by
77
86
<link linkend="gimp-memsize-serialize"><function>gimp_memsize_serialize()</function></link>.</para>
88
97
              <parameter>memsize</parameter> has been set, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
89
98
 
90
99
</simpara></listitem></varlistentry>
91
 
</variablelist><para>Since  GIMP 2.2
 
100
</variablelist><para role="since">Since  GIMP 2.2
92
101
</para></refsect2>
93
102
<refsect2>
94
103
<title><anchor id="gimp-memsize-to-string" role="function"/>gimp_memsize_to_string ()</title>
95
 
<indexterm><primary>gimp_memsize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gimp_memsize_to_string          (<link linkend="guint64">guint64</link> memsize);</programlisting>
 
104
<indexterm><primary>gimp_memsize_to_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*              gimp_memsize_to_string              (<link linkend="guint64">guint64</link> memsize);</programlisting>
96
105
<para>
97
106
This function returns a human readable, translated representation
98
107
of the passed <parameter>memsize</parameter>. Large values are displayed using a
115
124
<link linkend="GIMP-TYPE-MEMSIZE:CAPS"><type>GIMP_TYPE_MEMSIZE</type></link> is a <link linkend="GType"><type>GType</type></link> derived from <link linkend="G-TYPE-UINT64:CAPS"><type>G_TYPE_UINT64</type></link>.
116
125
</para></refsect2>
117
126
<refsect2>
 
127
<title><anchor id="GIMP-TYPE-PARAM-MEMSIZE:CAPS" role="macro"/>GIMP_TYPE_PARAM_MEMSIZE</title>
 
128
<indexterm><primary>GIMP_TYPE_PARAM_MEMSIZE</primary></indexterm><programlisting>#define GIMP_TYPE_PARAM_MEMSIZE           (gimp_param_memsize_get_type ())
 
129
</programlisting>
 
130
<para>
 
131
 
 
132
</para></refsect2>
 
133
<refsect2>
 
134
<title><anchor id="GIMP-IS-PARAM-SPEC-MEMSIZE:CAPS" role="macro"/>GIMP_IS_PARAM_SPEC_MEMSIZE()</title>
 
135
<indexterm><primary>GIMP_IS_PARAM_SPEC_MEMSIZE</primary></indexterm><programlisting>#define GIMP_IS_PARAM_SPEC_MEMSIZE(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GIMP_TYPE_PARAM_MEMSIZE))
 
136
</programlisting>
 
137
<para>
 
138
 
 
139
</para><variablelist role="params">
 
140
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
 
141
<listitem><simpara>
 
142
 
 
143
 
 
144
</simpara></listitem></varlistentry>
 
145
</variablelist></refsect2>
 
146
<refsect2>
 
147
<title><anchor id="gimp-param-spec-memsize" role="function" condition="since:GIMP 2.4"/>gimp_param_spec_memsize ()</title>
 
148
<indexterm role="GIMP 2.4"><primary>gimp_param_spec_memsize</primary></indexterm><programlisting><link linkend="GParamSpec">GParamSpec</link>*         gimp_param_spec_memsize             (const <link linkend="gchar">gchar</link> *name,
 
149
                                                         const <link linkend="gchar">gchar</link> *nick,
 
150
                                                         const <link linkend="gchar">gchar</link> *blurb,
 
151
                                                         <link linkend="guint64">guint64</link> minimum,
 
152
                                                         <link linkend="guint64">guint64</link> maximum,
 
153
                                                         <link linkend="guint64">guint64</link> default_value,
 
154
                                                         <link linkend="GParamFlags">GParamFlags</link> flags);</programlisting>
 
155
<para>
 
156
Creates a param spec to hold a memory size value.
 
157
See <link linkend="g-param-spec-internal"><function>g_param_spec_internal()</function></link> for more information.</para>
 
158
<para>
 
159
 
 
160
</para><variablelist role="params">
 
161
<varlistentry><term><parameter>name</parameter>&nbsp;:</term>
 
162
<listitem><simpara>          Canonical name of the param
 
163
</simpara></listitem></varlistentry>
 
164
<varlistentry><term><parameter>nick</parameter>&nbsp;:</term>
 
165
<listitem><simpara>          Nickname of the param
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><parameter>blurb</parameter>&nbsp;:</term>
 
168
<listitem><simpara>         Brief desciption of param.
 
169
</simpara></listitem></varlistentry>
 
170
<varlistentry><term><parameter>minimum</parameter>&nbsp;:</term>
 
171
<listitem><simpara>       Smallest allowed value of the parameter.
 
172
</simpara></listitem></varlistentry>
 
173
<varlistentry><term><parameter>maximum</parameter>&nbsp;:</term>
 
174
<listitem><simpara>       Largest allowed value of the parameter.
 
175
</simpara></listitem></varlistentry>
 
176
<varlistentry><term><parameter>default_value</parameter>&nbsp;:</term>
 
177
<listitem><simpara> Value to use if none is assigned.
 
178
</simpara></listitem></varlistentry>
 
179
<varlistentry><term><parameter>flags</parameter>&nbsp;:</term>
 
180
<listitem><simpara>         a combination of <link linkend="GParamFlags"><type>GParamFlags</type></link>
 
181
</simpara></listitem></varlistentry>
 
182
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a newly allocated <link linkend="GParamSpec"><type>GParamSpec</type></link> instance
 
183
 
 
184
</simpara></listitem></varlistentry>
 
185
</variablelist><para role="since">Since  GIMP 2.4
 
186
</para></refsect2>
 
187
<refsect2>
118
188
<title><anchor id="GIMP-VALUE-HOLDS-MEMSIZE:CAPS" role="macro"/>GIMP_VALUE_HOLDS_MEMSIZE()</title>
119
189
<indexterm><primary>GIMP_VALUE_HOLDS_MEMSIZE</primary></indexterm><programlisting>#define GIMP_VALUE_HOLDS_MEMSIZE(value) (G_TYPE_CHECK_VALUE_TYPE ((value), GIMP_TYPE_MEMSIZE))
120
190
</programlisting>