← Back to branch summary

~ubuntu-branches/ubuntu/jaunty/goffice/jaunty-updates

« back to all changes in this revision

Viewing changes to docs/reference/xml/go-action-combo-text.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gauvain Pocentek
  • Date: 2008-11-09 18:10:54 UTC
  • mfrom: (1.1.17 upstream)
  • Revision ID: james.westby@ubuntu.com-20081109181054-uazweo6uci8h7bc5
Tags: 0.6.5-1ubuntu1
* Merge from debian unstable, remaining changes:
  - call intltool-update -p in debian/rules
  - libgoffice-gtk-0-6 is a transitional package
  - libgoffice-0-6 conflicts with libgoffice-gtk-0-6 (<< 0.6.3-1ubuntu2)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/go-action-combo-text.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
<!ENTITY version SYSTEM "version.xml">
 
5
]
 
6
>
 
7
<refentry id="goffice-06-go-action-combo-text">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="goffice-06-go-action-combo-text.top_of_page">go-action-combo-text</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>GOFFICE-0.6 Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>go-action-combo-text</refname>
 
16
<refpurpose></refpurpose>
 
17
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
18
</refnamediv>
 
19
 
 
20
<refsynopsisdiv id="goffice-06-go-action-combo-text.synopsis" role="synopsis">
 
21
<title role="synopsis.title">Synopsis</title>
 
22
<anchor id="GOActionComboText"/>
 
23
<synopsis>
 
24
#define             <link linkend="GO-ACTION-COMBO-TEXT-TYPE:CAPS">GO_ACTION_COMBO_TEXT_TYPE</link>
 
25
#define             <link linkend="GO-ACTION-COMBO-TEXT:CAPS">GO_ACTION_COMBO_TEXT</link>                (o)
 
26
#define             <link linkend="IS-GO-ACTION-COMBO-TEXT:CAPS">IS_GO_ACTION_COMBO_TEXT</link>             (o)
 
27
                    <link linkend="GOActionComboText-struct">GOActionComboText</link>;
 
28
enum                <link linkend="GOActionComboTextSearchDir">GOActionComboTextSearchDir</link>;
 
29
<link linkend="GType">GType</link>               <link linkend="go-action-combo-text-get-type">go_action_combo_text_get_type</link>       (void);
 
30
<link linkend="void">void</link>                <link linkend="go-action-combo-text-add-item">go_action_combo_text_add_item</link>       (<link linkend="GOActionComboText">GOActionComboText</link> *a,
 
31
                                                         <link linkend="char">char</link> const *item);
 
32
<link linkend="void">void</link>                <link linkend="go-action-combo-text-set-width">go_action_combo_text_set_width</link>      (<link linkend="GOActionComboText">GOActionComboText</link> *a,
 
33
                                                         <link linkend="char">char</link> const *largest_elem);
 
34
<link linkend="char">char</link> const *        <link linkend="go-action-combo-text-get-entry">go_action_combo_text_get_entry</link>      (<link linkend="GOActionComboText">GOActionComboText</link> const *a);
 
35
<link linkend="void">void</link>                <link linkend="go-action-combo-text-set-entry">go_action_combo_text_set_entry</link>      (<link linkend="GOActionComboText">GOActionComboText</link> *a,
 
36
                                                         <link linkend="char">char</link> const *text,
 
37
                                                         <link linkend="GOActionComboTextSearchDir">GOActionComboTextSearchDir</link> dir);
 
38
</synopsis>
 
39
</refsynopsisdiv>
 
40
 
 
41
<refsect1 id="goffice-06-go-action-combo-text.object-hierarchy" role="object_hierarchy">
 
42
<title role="object_hierarchy.title">Object Hierarchy</title>
 
43
<synopsis>
 
44
  <link linkend="GObject">GObject</link>
 
45
   +----<link linkend="GtkAction">GtkAction</link>
 
46
         +----GOActionComboText
 
47
</synopsis>
 
48
 
 
49
</refsect1>
 
50
 
 
51
 
 
52
 
 
53
<refsect1 id="goffice-06-go-action-combo-text.implemented-interfaces" role="impl_interfaces">
 
54
<title role="impl_interfaces.title">Implemented Interfaces</title>
 
55
<para>
 
56
GOActionComboText implements
 
57
 <link linkend="GtkBuildable">GtkBuildable</link>.</para>
 
58
 
 
59
</refsect1>
 
60
 
 
61
 
 
62
<refsect1 id="goffice-06-go-action-combo-text.properties" role="properties">
 
63
<title role="properties.title">Properties</title>
 
64
<synopsis>
 
65
  &quot;<link linkend="GOActionComboText--case-sensitive">case-sensitive</link>&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only
 
66
</synopsis>
 
67
</refsect1>
 
68
 
 
69
 
 
70
 
 
71
<refsect1 id="goffice-06-go-action-combo-text.description" role="desc">
 
72
<title role="desc.title">Description</title>
 
73
<para>
 
74
 
 
75
</para>
 
76
</refsect1>
 
77
 
 
78
<refsect1 id="goffice-06-go-action-combo-text.details" role="details">
 
79
<title role="details.title">Details</title>
 
80
<refsect2 id="GO-ACTION-COMBO-TEXT-TYPE:CAPS" role="macro">
 
81
<title>GO_ACTION_COMBO_TEXT_TYPE</title>
 
82
<indexterm zone="GO-ACTION-COMBO-TEXT-TYPE:CAPS"><primary>GO_ACTION_COMBO_TEXT_TYPE</primary></indexterm><programlisting>#define GO_ACTION_COMBO_TEXT_TYPE  (go_action_combo_text_get_type ())
 
83
</programlisting>
 
84
<para>
 
85
 
 
86
</para></refsect2>
 
87
<refsect2 id="GO-ACTION-COMBO-TEXT:CAPS" role="macro">
 
88
<title>GO_ACTION_COMBO_TEXT()</title>
 
89
<indexterm zone="GO-ACTION-COMBO-TEXT:CAPS"><primary>GO_ACTION_COMBO_TEXT</primary></indexterm><programlisting>#define GO_ACTION_COMBO_TEXT(o)    (G_TYPE_CHECK_INSTANCE_CAST ((o), GO_ACTION_COMBO_TEXT_TYPE, GOActionComboText))
 
90
</programlisting>
 
91
<para>
 
92
 
 
93
</para><variablelist role="params">
 
94
<varlistentry><term><parameter>o</parameter>&nbsp;:</term>
 
95
<listitem><simpara>
 
96
 
 
97
 
 
98
</simpara></listitem></varlistentry>
 
99
</variablelist></refsect2>
 
100
<refsect2 id="IS-GO-ACTION-COMBO-TEXT:CAPS" role="macro">
 
101
<title>IS_GO_ACTION_COMBO_TEXT()</title>
 
102
<indexterm zone="IS-GO-ACTION-COMBO-TEXT:CAPS"><primary>IS_GO_ACTION_COMBO_TEXT</primary></indexterm><programlisting>#define IS_GO_ACTION_COMBO_TEXT(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), GO_ACTION_COMBO_TEXT_TYPE))
 
103
</programlisting>
 
104
<para>
 
105
 
 
106
</para><variablelist role="params">
 
107
<varlistentry><term><parameter>o</parameter>&nbsp;:</term>
 
108
<listitem><simpara>
 
109
 
 
110
 
 
111
</simpara></listitem></varlistentry>
 
112
</variablelist></refsect2>
 
113
<refsect2 id="GOActionComboText-struct" role="struct">
 
114
<title>GOActionComboText</title>
 
115
<indexterm zone="GOActionComboText-struct"><primary>GOActionComboText</primary></indexterm><programlisting>typedef struct _GOActionComboText GOActionComboText;</programlisting>
 
116
<para>
 
117
 
 
118
</para></refsect2>
 
119
<refsect2 id="GOActionComboTextSearchDir" role="enum">
 
120
<title>enum GOActionComboTextSearchDir</title>
 
121
<indexterm zone="GOActionComboTextSearchDir"><primary>GOActionComboTextSearchDir</primary></indexterm><programlisting>typedef enum {            /* begin the search from : */
 
122
        GO_ACTION_COMBO_SEARCH_FROM_TOP,        /* the top of the list */
 
123
        GO_ACTION_COMBO_SEARCH_CURRENT,         /* the current selection */
 
124
        GO_ACTION_COMBO_SEARCH_NEXT             /* the next element after current */
 
125
} GOActionComboTextSearchDir;
 
126
</programlisting>
 
127
<para>
 
128
 
 
129
</para></refsect2>
 
130
<refsect2 id="go-action-combo-text-get-type" role="function">
 
131
<title>go_action_combo_text_get_type ()</title>
 
132
<indexterm zone="go-action-combo-text-get-type"><primary>go_action_combo_text_get_type</primary></indexterm><programlisting><link linkend="GType">GType</link>               go_action_combo_text_get_type       (void);</programlisting>
 
133
<para>
 
134
 
 
135
</para><variablelist role="params">
 
136
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
137
 
 
138
 
 
139
</simpara></listitem></varlistentry>
 
140
</variablelist></refsect2>
 
141
<refsect2 id="go-action-combo-text-add-item" role="function">
 
142
<title>go_action_combo_text_add_item ()</title>
 
143
<indexterm zone="go-action-combo-text-add-item"><primary>go_action_combo_text_add_item</primary></indexterm><programlisting><link linkend="void">void</link>                go_action_combo_text_add_item       (<link linkend="GOActionComboText">GOActionComboText</link> *a,
 
144
                                                         <link linkend="char">char</link> const *item);</programlisting>
 
145
<para>
 
146
 
 
147
</para><variablelist role="params">
 
148
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
149
<listitem><simpara>
 
150
</simpara></listitem></varlistentry>
 
151
<varlistentry><term><parameter>item</parameter>&nbsp;:</term>
 
152
<listitem><simpara>
 
153
 
 
154
 
 
155
</simpara></listitem></varlistentry>
 
156
</variablelist></refsect2>
 
157
<refsect2 id="go-action-combo-text-set-width" role="function">
 
158
<title>go_action_combo_text_set_width ()</title>
 
159
<indexterm zone="go-action-combo-text-set-width"><primary>go_action_combo_text_set_width</primary></indexterm><programlisting><link linkend="void">void</link>                go_action_combo_text_set_width      (<link linkend="GOActionComboText">GOActionComboText</link> *a,
 
160
                                                         <link linkend="char">char</link> const *largest_elem);</programlisting>
 
161
<para>
 
162
 
 
163
</para><variablelist role="params">
 
164
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
165
<listitem><simpara>
 
166
</simpara></listitem></varlistentry>
 
167
<varlistentry><term><parameter>largest_elem</parameter>&nbsp;:</term>
 
168
<listitem><simpara>
 
169
 
 
170
 
 
171
</simpara></listitem></varlistentry>
 
172
</variablelist></refsect2>
 
173
<refsect2 id="go-action-combo-text-get-entry" role="function">
 
174
<title>go_action_combo_text_get_entry ()</title>
 
175
<indexterm zone="go-action-combo-text-get-entry"><primary>go_action_combo_text_get_entry</primary></indexterm><programlisting><link linkend="char">char</link> const *        go_action_combo_text_get_entry      (<link linkend="GOActionComboText">GOActionComboText</link> const *a);</programlisting>
 
176
<para>
 
177
 
 
178
</para><variablelist role="params">
 
179
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
180
<listitem><simpara>
 
181
</simpara></listitem></varlistentry>
 
182
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>
 
183
 
 
184
 
 
185
</simpara></listitem></varlistentry>
 
186
</variablelist></refsect2>
 
187
<refsect2 id="go-action-combo-text-set-entry" role="function">
 
188
<title>go_action_combo_text_set_entry ()</title>
 
189
<indexterm zone="go-action-combo-text-set-entry"><primary>go_action_combo_text_set_entry</primary></indexterm><programlisting><link linkend="void">void</link>                go_action_combo_text_set_entry      (<link linkend="GOActionComboText">GOActionComboText</link> *a,
 
190
                                                         <link linkend="char">char</link> const *text,
 
191
                                                         <link linkend="GOActionComboTextSearchDir">GOActionComboTextSearchDir</link> dir);</programlisting>
 
192
<para>
 
193
Set the entry of any toolbar proxies of <parameter>taction</parameter> to <parameter>text</parameter>.  Does not
 
194
generate an 'activate' signal.</para>
 
195
<para>
 
196
 
 
197
</para><variablelist role="params">
 
198
<varlistentry><term><parameter>a</parameter>&nbsp;:</term>
 
199
<listitem><simpara>
 
200
</simpara></listitem></varlistentry>
 
201
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
202
<listitem><simpara>
 
203
</simpara></listitem></varlistentry>
 
204
<varlistentry><term><parameter>dir</parameter>&nbsp;:</term>
 
205
<listitem><simpara>
 
206
</simpara></listitem></varlistentry>
 
207
</variablelist></refsect2>
 
208
 
 
209
</refsect1>
 
210
<refsect1 id="goffice-06-go-action-combo-text.property-details" role="property_details">
 
211
<title role="property_details.title">Property Details</title>
 
212
<refsect2 id="GOActionComboText--case-sensitive"><title>The <literal>&quot;case-sensitive&quot;</literal> property</title>
 
213
<indexterm zone="GOActionComboText--case-sensitive"><primary>GOActionComboText:case-sensitive</primary></indexterm><programlisting>  &quot;case-sensitive&quot;           <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
 
214
<para>Should the text comparison be case sensitive.</para><para>Default value: TRUE</para>
 
215
</refsect2>
 
216
 
 
217
</refsect1>
 
218
 
 
219
 
 
220
 
 
221
 
 
222
</refentry>