1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="GimpMemsizeEntry">
<refmeta>
<refentrytitle>GimpMemsizeEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GimpMemsizeEntry</refname><refpurpose>A composite widget that allows to enter a memory size.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="GimpMemsizeEntry-struct">GimpMemsizeEntry</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gimp-memsize-entry-new">gimp_memsize_entry_new</link> (<link linkend="guint64">guint64</link> value,
<link linkend="guint64">guint64</link> lower,
<link linkend="guint64">guint64</link> upper);
<link linkend="void">void</link> <link linkend="gimp-memsize-entry-set-value">gimp_memsize_entry_set_value</link> (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry,
<link linkend="guint64">guint64</link> value);
<link linkend="guint64">guint64</link> <link linkend="gimp-memsize-entry-get-value">gimp_memsize_entry_get_value</link> (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GtkObject">GtkObject</link>
+----<link linkend="GtkWidget">GtkWidget</link>
+----<link linkend="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkHBox">GtkHBox</link>
+----GimpMemsizeEntry
</synopsis>
</refsect1>
<refsect1>
<title>Implemented Interfaces</title>
<para>
GimpMemsizeEntry implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>
<refsect1>
<title>Signal Prototypes</title>
<synopsis>
"<link linkend="GimpMemsizeEntry-value-changed">value-changed</link>"
<link linkend="void">void</link> user_function (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *gimpmemsizeentry,
<link linkend="gpointer">gpointer</link> user_data);
</synopsis>
</refsect1>
<refsect1>
<title>Description</title>
<para>
Similar to a <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> 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.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpMemsizeEntry-struct"/>GimpMemsizeEntry</title>
<indexterm><primary>GimpMemsizeEntry</primary></indexterm><programlisting>typedef struct _GimpMemsizeEntry GimpMemsizeEntry;</programlisting>
<para>
The <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> struct is considered private.
</para></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-entry-new"/>gimp_memsize_entry_new ()</title>
<indexterm><primary>gimp_memsize_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gimp_memsize_entry_new (<link linkend="guint64">guint64</link> value,
<link linkend="guint64">guint64</link> lower,
<link linkend="guint64">guint64</link> upper);</programlisting>
<para>
Creates a new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> which is a <link linkend="GtkHBox"><type>GtkHBox</type></link> with a <link linkend="GtkSpinButton"><type>GtkSpinButton</type></link>
and a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> all setup to allow the user to enter memory sizes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the initial value (in Bytes)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>lower</parameter> :</term>
<listitem><simpara> the lower limit for the value (in Bytes)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>upper</parameter> :</term>
<listitem><simpara> the upper limit for the value (in Bytes)
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to the new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-entry-set-value"/>gimp_memsize_entry_set_value ()</title>
<indexterm><primary>gimp_memsize_entry_set_value</primary></indexterm><programlisting><link linkend="void">void</link> gimp_memsize_entry_set_value (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry,
<link linkend="guint64">guint64</link> value);</programlisting>
<para>
Sets the <parameter>entry</parameter>'s value. Please note that the <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> rounds
the value to full Kilobytes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> the new value (in Bytes)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-memsize-entry-get-value"/>gimp_memsize_entry_get_value ()</title>
<indexterm><primary>gimp_memsize_entry_get_value</primary></indexterm><programlisting><link linkend="guint64">guint64</link> gimp_memsize_entry_get_value (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry);</programlisting>
<para>
Retrieves the current value from a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara> a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current value of <parameter>entry</parameter> (in Bytes).
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>Signals</title>
<refsect2><title><anchor id="GimpMemsizeEntry-value-changed"/>The "value-changed" signal</title>
<programlisting><link linkend="void">void</link> user_function (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *gimpmemsizeentry,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gimpmemsizeentry</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
