← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/gimp/oneiric-security

« back to all changes in this revision

Viewing changes to devel-docs/libgimpwidgets/xml/gimpmemsizeentry.xml

  • Committer: Bazaar Package Importer
  • Author(s): Robert Ancell
  • Date: 2009-08-31 10:24:10 UTC
  • mfrom: (1.1.21 upstream) (0.1.5 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090831102410-eqawgw6fhdyi91ee
Tags: 2.6.7-1ubuntu1
https://launchpad.net/bugs/419593
* Merge with Debian unstable (LP: #419593), remaining changes:
  - debian/patches/02_help-message.patch,
    debian/patches/03_gimp.desktop.in.in.patch:
    + updated some strings for ubuntu
  - debian/rules:
    + updated translation templates
  - debian/control:
    + Drop webkit build dependency. gimp is the only thing pulling in webkit
      for the desktop CDs, and makes them explode. Without the webkit help
      browser plugin, help will just be displayed in the default browser.
* debian/patches/01_debian-gimprc.patch:
  - Updated
* debian/control:
  - Added a BZR link

Show diffs side-by-side

added added

removed removed

Lines of Context:
devel-docs/libgimpwidgets/xml/gimpmemsizeentry.xml
12
12
<refnamediv>
13
13
<refname>GimpMemsizeEntry</refname>
14
14
<refpurpose>A composite widget that allows to enter a memory size.</refpurpose>
15
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
16
15
</refnamediv>
17
16
 
18
17
<refsynopsisdiv id="GimpMemsizeEntry.synopsis" role="synopsis">
20
19
 
21
20
<synopsis>
22
21
                    <link linkend="GimpMemsizeEntry-struct">GimpMemsizeEntry</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gimp-memsize-entry-new">gimp_memsize_entry_new</link>              (<link linkend="guint64">guint64</link> value,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gimp-memsize-entry-new">gimp_memsize_entry_new</link>              (<link linkend="guint64">guint64</link> value,
24
23
                                                         <link linkend="guint64">guint64</link> lower,
25
24
                                                         <link linkend="guint64">guint64</link> upper);
26
25
<link linkend="void">void</link>                <link linkend="gimp-memsize-entry-set-value">gimp_memsize_entry_set_value</link>        (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry,
41
40
                                 +----<link linkend="GtkHBox">GtkHBox</link>
42
41
                                       +----GimpMemsizeEntry
43
42
</synopsis>
44
 
 
45
43
</refsect1>
46
44
 
47
45
 
50
48
<title role="impl_interfaces.title">Implemented Interfaces</title>
51
49
<para>
52
50
GimpMemsizeEntry implements
53
 
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
54
 
 
 
51
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>
55
52
</refsect1>
56
53
 
57
54
 
77
74
<title role="details.title">Details</title>
78
75
<refsect2 id="GimpMemsizeEntry-struct" role="struct">
79
76
<title>GimpMemsizeEntry</title>
80
 
<indexterm zone="GimpMemsizeEntry-struct"><primary>GimpMemsizeEntry</primary></indexterm><programlisting>typedef struct _GimpMemsizeEntry GimpMemsizeEntry;</programlisting>
 
77
<indexterm zone="GimpMemsizeEntry-struct"><primary sortas="GimpMemsizeEntry">GimpMemsizeEntry</primary></indexterm><programlisting>typedef struct _GimpMemsizeEntry GimpMemsizeEntry;</programlisting>
81
78
<para>
82
79
The <link linkend="GimpSizeEntry"><type>GimpSizeEntry</type></link> struct is considered private.
83
80
</para></refsect2>
84
81
<refsect2 id="gimp-memsize-entry-new" role="function">
85
82
<title>gimp_memsize_entry_new ()</title>
86
 
<indexterm zone="gimp-memsize-entry-new"><primary>gimp_memsize_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gimp_memsize_entry_new              (<link linkend="guint64">guint64</link> value,
 
83
<indexterm zone="gimp-memsize-entry-new"><primary sortas="gimp_memsize_entry_new">gimp_memsize_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gimp_memsize_entry_new              (<link linkend="guint64">guint64</link> value,
87
84
                                                         <link linkend="guint64">guint64</link> lower,
88
85
                                                         <link linkend="guint64">guint64</link> upper);</programlisting>
89
86
<para>
90
87
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>
91
88
and a <link linkend="GtkOptionMenu"><type>GtkOptionMenu</type></link> all setup to allow the user to enter memory sizes.</para>
92
89
<para>
93
 
 
94
90
</para><variablelist role="params">
95
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
91
<varlistentry><term><parameter>value</parameter>&#160;:</term>
96
92
<listitem><simpara> the initial value (in Bytes)
97
93
</simpara></listitem></varlistentry>
98
 
<varlistentry><term><parameter>lower</parameter>&nbsp;:</term>
 
94
<varlistentry><term><parameter>lower</parameter>&#160;:</term>
99
95
<listitem><simpara> the lower limit for the value (in Bytes)
100
96
</simpara></listitem></varlistentry>
101
 
<varlistentry><term><parameter>upper</parameter>&nbsp;:</term>
 
97
<varlistentry><term><parameter>upper</parameter>&#160;:</term>
102
98
<listitem><simpara> the upper limit for the value (in Bytes)
103
99
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Pointer to the new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.
 
100
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Pointer to the new <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.
105
101
</simpara></listitem></varlistentry>
106
102
</variablelist></refsect2>
107
103
<refsect2 id="gimp-memsize-entry-set-value" role="function">
108
104
<title>gimp_memsize_entry_set_value ()</title>
109
 
<indexterm zone="gimp-memsize-entry-set-value"><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,
 
105
<indexterm zone="gimp-memsize-entry-set-value"><primary sortas="gimp_memsize_entry_set_value">gimp_memsize_entry_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                gimp_memsize_entry_set_value        (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *entry,
110
106
                                                         <link linkend="guint64">guint64</link> value);</programlisting>
111
107
<para>
112
108
Sets the <parameter>entry</parameter>'s value. Please note that the <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link> rounds
113
109
the value to full Kilobytes.</para>
114
110
<para>
115
 
 
116
111
</para><variablelist role="params">
117
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
112
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
118
113
<listitem><simpara> a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>
119
114
</simpara></listitem></varlistentry>
120
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
115
<varlistentry><term><parameter>value</parameter>&#160;:</term>
121
116
<listitem><simpara> the new value (in Bytes)
122
117
</simpara></listitem></varlistentry>
123
118
</variablelist></refsect2>
124
119
<refsect2 id="gimp-memsize-entry-get-value" role="function">
125
120
<title>gimp_memsize_entry_get_value ()</title>
126
 
<indexterm zone="gimp-memsize-entry-get-value"><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>
 
121
<indexterm zone="gimp-memsize-entry-get-value"><primary sortas="gimp_memsize_entry_get_value">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>
127
122
<para>
128
123
Retrieves the current value from a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>.</para>
129
124
<para>
130
 
 
131
125
</para><variablelist role="params">
132
 
<varlistentry><term><parameter>entry</parameter>&nbsp;:</term>
 
126
<varlistentry><term><parameter>entry</parameter>&#160;:</term>
133
127
<listitem><simpara> a <link linkend="GimpMemsizeEntry"><type>GimpMemsizeEntry</type></link>
134
128
</simpara></listitem></varlistentry>
135
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current value of <parameter>entry</parameter> (in Bytes).
 
129
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current value of <parameter>entry</parameter> (in Bytes).
136
130
</simpara></listitem></varlistentry>
137
131
</variablelist></refsect2>
138
132
 
140
134
 
141
135
<refsect1 id="GimpMemsizeEntry.signal-details" role="signals">
142
136
<title role="signals.title">Signal Details</title>
143
 
<refsect2 id="GimpMemsizeEntry-value-changed"><title>The <literal>&quot;value-changed&quot;</literal> signal</title>
144
 
<indexterm zone="GimpMemsizeEntry-value-changed"><primary>GimpMemsizeEntry::value-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *gimpmemsizeentry,
 
137
<refsect2 id="GimpMemsizeEntry-value-changed" role="signal"><title>The <literal>&quot;value-changed&quot;</literal> signal</title>
 
138
<indexterm zone="GimpMemsizeEntry-value-changed"><primary sortas="GimpMemsizeEntry::value-changed">GimpMemsizeEntry::value-changed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GimpMemsizeEntry">GimpMemsizeEntry</link> *gimpmemsizeentry,
145
139
                                                        <link linkend="gpointer">gpointer</link>          user_data)             : Run First</programlisting>
146
140
<para>
147
 
 
148
141
</para><variablelist role="params">
149
 
<varlistentry><term><parameter>gimpmemsizeentry</parameter>&nbsp;:</term>
 
142
<varlistentry><term><parameter>gimpmemsizeentry</parameter>&#160;:</term>
150
143
<listitem><simpara>the object which received the signal.
151
 
 
152
144
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
145
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
154
146
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
155
147
</variablelist></refsect2>
156
148
</refsect1>