← Back to branch summary

~ubuntu-branches/ubuntu/saucy/gnomescan/saucy

« back to all changes in this revision

Viewing changes to doc/ref/xml/gnome-scan-param-widget.xml

  • Committer: Bazaar Package Importer
  • Author(s): Devid Antonio Filoni
  • Date: 2009-06-29 21:59:52 UTC
  • mfrom: (1.1.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20090629215952-pkuzs5p6j0zewmvp
Tags: 0.6.2-0ubuntu1
* New upstream release 0.6.2 (0.7.1 seems to crash and still doesn't have
  all 0.6.2 features).
* Fix debhelper-but-no-misc-depends lintian warnings.
* Fix substvar-source-version-is-deprecated lintian warnings.
* Bump Standards-Version to 3.8.2.
* Fix binary-control-field-duplicates-source lintian infos.
* Fix duplicate-short-description lintian infos.
* debian/control: add libgegl-0.0-dev (>= 0.0.21) to Build-Depends field.
* Don't provide libgnomescanui* packages, upstream doesn't ship
  libgnomescanui files anymore.
* Update debian/watch file.
* debian/rules: do not include simple-patchsys.mk.
* debian/control: adjust dependencies.
* debian/control: add libglade2-dev (>= 2.6) to Build-Depends field.
* Update debian/copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/ref/xml/gnome-scan-param-widget.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
 
3
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
 
4
          [
 
5
          <!ENTITY version SYSTEM "version.xml">
 
6
          ]>
 
7
<refentry id="GnomeScanParamWidget">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="GnomeScanParamWidget.top_of_page">GnomeScanParamWidget</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GNOME-SCAN-1.0 Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>GnomeScanParamWidget</refname>
 
16
<refpurpose>A generic parameter widget</refpurpose>
 
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
18
</refnamediv>
 
19
 
 
20
<refsynopsisdiv id="GnomeScanParamWidget.synopsis" role="synopsis">
 
21
<title role="synopsis.title">Synopsis</title>
 
22
 
 
23
<synopsis>
 
24
#define             <link linkend="GS-DEFINE-PARAM-WIDGET:CAPS">GS_DEFINE_PARAM_WIDGET</link>              (TypeName, type_name)
 
25
#define             <link linkend="GS-DEFINE-PARAM-WIDGET-HEADER:CAPS">GS_DEFINE_PARAM_WIDGET_HEADER</link>       (TypeName, type_name)
 
26
                    <link linkend="GnomeScanParamWidget-struct">GnomeScanParamWidget</link>;
 
27
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="gnome-scan-param-widget-new">gnome_scan_param_widget_new</link>         (<link linkend="GnomeScanSettings">GnomeScanSettings</link> *settings,
 
28
                                                         <link linkend="GnomeScanPlugin">GnomeScanPlugin</link> *plugin,
 
29
                                                         <link linkend="GParamSpec">GParamSpec</link> *pspec);
 
30
<link linkend="void">void</link>                <link linkend="gnome-scan-param-widget-set-value">gnome_scan_param_widget_set_value</link>   (<link linkend="GnomeScanParamWidget">GnomeScanParamWidget</link> *widget,
 
31
                                                         <link linkend="GValue">GValue</link> *value);
 
32
<link linkend="void">void</link>                <link linkend="gnome-scan-param-widget-changed">gnome_scan_param_widget_changed</link>     (<link linkend="GnomeScanParamWidget">GnomeScanParamWidget</link> *widget);
 
33
</synopsis>
 
34
</refsynopsisdiv>
 
35
 
 
36
<refsect1 id="GnomeScanParamWidget.object-hierarchy" role="object_hierarchy">
 
37
<title role="object_hierarchy.title">Object Hierarchy</title>
 
38
<synopsis>
 
39
  <link linkend="GObject">GObject</link>
 
40
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
41
         +----<link linkend="GtkObject">GtkObject</link>
 
42
               +----<link linkend="GtkWidget">GtkWidget</link>
 
43
                     +----<link linkend="GtkContainer">GtkContainer</link>
 
44
                           +----<link linkend="GtkBox">GtkBox</link>
 
45
                                 +----<link linkend="GtkHBox">GtkHBox</link>
 
46
                                       +----GnomeScanParamWidget
 
47
</synopsis>
 
48
 
 
49
</refsect1>
 
50
 
 
51
 
 
52
 
 
53
<refsect1 id="GnomeScanParamWidget.implemented-interfaces" role="impl_interfaces">
 
54
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
55
<para>
 
56
GnomeScanParamWidget implements
 
57
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
 
58
 
 
59
</refsect1>
 
60
 
 
61
 
 
62
<refsect1 id="GnomeScanParamWidget.properties" role="properties">
 
63
<title role="properties.title">Properties</title>
 
64
<synopsis>
 
65
  &quot;<link linkend="GnomeScanParamWidget--param-spec">param-spec</link>&quot;               <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only
 
66
  &quot;<link linkend="GnomeScanParamWidget--plugin">plugin</link>&quot;                   <link linkend="GnomeScanPlugin">GnomeScanPlugin</link>*      : Read / Write / Construct Only
 
67
  &quot;<link linkend="GnomeScanParamWidget--settings">settings</link>&quot;                 <link linkend="GnomeScanSettings">GnomeScanSettings</link>*    : Read / Write / Construct Only
 
68
  &quot;<link linkend="GnomeScanParamWidget--value">value</link>&quot;                    <link linkend="GValue">GValue</link>*               : Read / Write
 
69
</synopsis>
 
70
</refsect1>
 
71
 
 
72
 
 
73
 
 
74
<refsect1 id="GnomeScanParamWidget.description" role="desc">
 
75
<title role="desc.title">Description</title>
 
76
<para>
 
77
This widget build it self automatically considering the <link linkend="GParamSpec"><type>GParamSpec</type></link>
 
78
passed to the constructor.</para>
 
79
<para>
 
80
 
 
81
</para>
 
82
</refsect1>
 
83
 
 
84
<refsect1 id="GnomeScanParamWidget.details" role="details">
 
85
<title role="details.title">Details</title>
 
86
<refsect2 id="GS-DEFINE-PARAM-WIDGET:CAPS" role="macro">
 
87
<title>GS_DEFINE_PARAM_WIDGET()</title>
 
88
<indexterm zone="GS-DEFINE-PARAM-WIDGET:CAPS"><primary>GS_DEFINE_PARAM_WIDGET</primary></indexterm><programlisting>#define             GS_DEFINE_PARAM_WIDGET(TypeName, type_name)</programlisting>
 
89
<para>
 
90
Generate all boiler plate code for creating a new <link linkend="GnomeScanParamWidget"><type>GnomeScanParamWidget</type></link>
 
91
derived class.</para>
 
92
<para>
 
93
 
 
94
</para><variablelist role="params">
 
95
<varlistentry><term><parameter>TypeName</parameter>&nbsp;:</term>
 
96
<listitem><simpara>   class name
 
97
</simpara></listitem></varlistentry>
 
98
<varlistentry><term><parameter>type_name</parameter>&nbsp;:</term>
 
99
<listitem><simpara>  function prefix
 
100
</simpara></listitem></varlistentry>
 
101
</variablelist></refsect2>
 
102
<refsect2 id="GS-DEFINE-PARAM-WIDGET-HEADER:CAPS" role="macro">
 
103
<title>GS_DEFINE_PARAM_WIDGET_HEADER()</title>
 
104
<indexterm zone="GS-DEFINE-PARAM-WIDGET-HEADER:CAPS"><primary>GS_DEFINE_PARAM_WIDGET_HEADER</primary></indexterm><programlisting>#define             GS_DEFINE_PARAM_WIDGET_HEADER(TypeName, type_name)</programlisting>
 
105
<para>
 
106
Generate all boiler plate header declaration for creating a new
 
107
<link linkend="GnomeScanParamWidget"><type>GnomeScanParamWidget</type></link> derived class.</para>
 
108
<para>
 
109
 
 
110
</para><variablelist role="params">
 
111
<varlistentry><term><parameter>TypeName</parameter>&nbsp;:</term>
 
112
<listitem><simpara>   class name
 
113
</simpara></listitem></varlistentry>
 
114
<varlistentry><term><parameter>type_name</parameter>&nbsp;:</term>
 
115
<listitem><simpara>  function prefix
 
116
</simpara></listitem></varlistentry>
 
117
</variablelist></refsect2>
 
118
<refsect2 id="GnomeScanParamWidget-struct" role="struct">
 
119
<title>GnomeScanParamWidget</title>
 
120
<indexterm zone="GnomeScanParamWidget-struct"><primary>GnomeScanParamWidget</primary></indexterm><programlisting>typedef struct {
 
121
  GnomeScanSettings*    settings;
 
122
  GnomeScanPlugin*      plugin;
 
123
  GParamSpec            *pspec;
 
124
  GValue                *value;
 
125
 
 
126
  gboolean              shows_label;
 
127
  gboolean              expands;
 
128
  gboolean              shows_unit;
 
129
} GnomeScanParamWidget;
 
130
</programlisting>
 
131
<para>
 
132
 
 
133
</para></refsect2>
 
134
<refsect2 id="gnome-scan-param-widget-new" role="function">
 
135
<title>gnome_scan_param_widget_new ()</title>
 
136
<indexterm zone="gnome-scan-param-widget-new"><primary>gnome_scan_param_widget_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          gnome_scan_param_widget_new         (<link linkend="GnomeScanSettings">GnomeScanSettings</link> *settings,
 
137
                                                         <link linkend="GnomeScanPlugin">GnomeScanPlugin</link> *plugin,
 
138
                                                         <link linkend="GParamSpec">GParamSpec</link> *pspec);</programlisting>
 
139
<para>
 
140
Build a new <link linkend="GnomeScanParamWidget"><type>GnomeScanParamWidget</type></link> from <parameter>pspec</parameter>
 
141
widget_type. Initialize settings with <parameter>pspec</parameter> default value if
 
142
needed.</para>
 
143
<para>
 
144
 
 
145
</para><variablelist role="params">
 
146
<varlistentry><term><parameter>settings</parameter>&nbsp;:</term>
 
147
<listitem><simpara>     The <link linkend="GnomeScanSettings"><type>GnomeScanSettings</type></link> where to store values
 
148
</simpara></listitem></varlistentry>
 
149
<varlistentry><term><parameter>plugin</parameter>&nbsp;:</term>
 
150
<listitem><simpara>     The <link linkend="GnomeScanPlugin"><type>GnomeScanPlugin</type></link> to configure
 
151
</simpara></listitem></varlistentry>
 
152
<varlistentry><term><parameter>pspec</parameter>&nbsp;:</term>
 
153
<listitem><simpara>     The <link linkend="GParamSpec"><type>GParamSpec</type></link> to be managed
 
154
</simpara></listitem></varlistentry>
 
155
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new <link linkend="GnomeScanParamWidget"><type>GnomeScanParamWidget</type></link>
 
156
</simpara></listitem></varlistentry>
 
157
</variablelist></refsect2>
 
158
<refsect2 id="gnome-scan-param-widget-set-value" role="function">
 
159
<title>gnome_scan_param_widget_set_value ()</title>
 
160
<indexterm zone="gnome-scan-param-widget-set-value"><primary>gnome_scan_param_widget_set_value</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_scan_param_widget_set_value   (<link linkend="GnomeScanParamWidget">GnomeScanParamWidget</link> *widget,
 
161
                                                         <link linkend="GValue">GValue</link> *value);</programlisting>
 
162
<para>
 
163
Set the value of the widget. It's up to you to ensure the value
 
164
correspond to the param spec.</para>
 
165
<para>
 
166
 
 
167
</para><variablelist role="params">
 
168
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
169
<listitem><simpara> a <link linkend="GnomeScanParamWidget"><type>GnomeScanParamWidget</type></link>
 
170
</simpara></listitem></varlistentry>
 
171
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
172
<listitem><simpara> a <link linkend="GValue"><type>GValue</type></link>
 
173
</simpara></listitem></varlistentry>
 
174
</variablelist></refsect2>
 
175
<refsect2 id="gnome-scan-param-widget-changed" role="function">
 
176
<title>gnome_scan_param_widget_changed ()</title>
 
177
<indexterm zone="gnome-scan-param-widget-changed"><primary>gnome_scan_param_widget_changed</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_scan_param_widget_changed     (<link linkend="GnomeScanParamWidget">GnomeScanParamWidget</link> *widget);</programlisting>
 
178
<para>
 
179
Trigger changed signal, as if user have touched the GUI.</para>
 
180
<para>
 
181
 
 
182
</para><variablelist role="params">
 
183
<varlistentry><term><parameter>widget</parameter>&nbsp;:</term>
 
184
<listitem><simpara>     a <link linkend="GnomeScanParamWidget"><type>GnomeScanParamWidget</type></link>
 
185
</simpara></listitem></varlistentry>
 
186
</variablelist></refsect2>
 
187
 
 
188
</refsect1>
 
189
<refsect1 id="GnomeScanParamWidget.property-details" role="property_details">
 
190
<title role="property_details.title">Property Details</title>
 
191
<refsect2 id="GnomeScanParamWidget--param-spec"><title>The <literal>&quot;param-spec&quot;</literal> property</title>
 
192
<indexterm zone="GnomeScanParamWidget--param-spec"><primary>GnomeScanParamWidget:param-spec</primary></indexterm><programlisting>  &quot;param-spec&quot;               <link linkend="gpointer">gpointer</link>              : Read / Write / Construct Only</programlisting>
 
193
<para>
 
194
The param spec the widget is representing. A widget can handle
 
195
only one <link linkend="GParamSpec"><type>GParamSpec</type></link> per instance, the widget being builded
 
196
upon construction depending on the <link linkend="GParamSpec"><type>GParamSpec</type></link>.</para>
 
197
<para>
 
198
 
 
199
</para></refsect2>
 
200
<refsect2 id="GnomeScanParamWidget--plugin"><title>The <literal>&quot;plugin&quot;</literal> property</title>
 
201
<indexterm zone="GnomeScanParamWidget--plugin"><primary>GnomeScanParamWidget:plugin</primary></indexterm><programlisting>  &quot;plugin&quot;                   <link linkend="GnomeScanPlugin">GnomeScanPlugin</link>*      : Read / Write / Construct Only</programlisting>
 
202
<para>
 
203
</para>
 
204
<para>
 
205
 
 
206
</para></refsect2>
 
207
<refsect2 id="GnomeScanParamWidget--settings"><title>The <literal>&quot;settings&quot;</literal> property</title>
 
208
<indexterm zone="GnomeScanParamWidget--settings"><primary>GnomeScanParamWidget:settings</primary></indexterm><programlisting>  &quot;settings&quot;                 <link linkend="GnomeScanSettings">GnomeScanSettings</link>*    : Read / Write / Construct Only</programlisting>
 
209
<para>
 
210
</para>
 
211
<para>
 
212
 
 
213
</para></refsect2>
 
214
<refsect2 id="GnomeScanParamWidget--value"><title>The <literal>&quot;value&quot;</literal> property</title>
 
215
<indexterm zone="GnomeScanParamWidget--value"><primary>GnomeScanParamWidget:value</primary></indexterm><programlisting>  &quot;value&quot;                    <link linkend="GValue">GValue</link>*               : Read / Write</programlisting>
 
216
<para>
 
217
The current value associated with the param-spec.</para>
 
218
<para>
 
219
 
 
220
</para></refsect2>
 
221
 
 
222
</refsect1>
 
223
 
 
224
 
 
225
 
 
226
 
 
227
</refentry>