~ubuntu-branches/ubuntu/precise/gtksourceview2/precise-proposed

« back to all changes in this revision

Viewing changes to docs/reference/html/GtkSourceCompletionItem.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-04-28 15:09:35 UTC
  • mfrom: (1.1.40 upstream) (6.2.6 sid)
  • Revision ID: james.westby@ubuntu.com-20100428150935-4hrru472bmm1ierx
Tags: 2.10.1-0ubuntu1
* New upstream version (lp: #571261):
  - Improvements to some of the lang files
  - Misc bugfixes
  - Updated translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
8
8
<link rel="up" href="rn01.html" title="API reference">
9
9
<link rel="prev" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo">
10
10
<link rel="next" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal">
11
 
<meta name="generator" content="GTK-Doc V1.13 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
 
<link rel="reference" href="rn01.html" title="API reference">
14
 
<link rel="reference" href="rn02.html" title="Syntax highlighting reference">
15
13
</head>
16
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
17
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
50
48
 
51
49
                    <a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem-struct" title="GtkSourceCompletionItem">GtkSourceCompletionItem</a>;
52
50
<a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * <a class="link" href="GtkSourceCompletionItem.html#gtk-source-completion-item-new" title="gtk_source_completion_item_new ()">gtk_source_completion_item_new</a>
53
 
                                                        (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *label,
54
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *text,
55
 
                                                         <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *icon,
56
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *info);
 
51
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
52
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
 
53
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
 
54
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);
57
55
<a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * <a class="link" href="GtkSourceCompletionItem.html#gtk-source-completion-item-new-with-markup" title="gtk_source_completion_item_new_with_markup ()">gtk_source_completion_item_new_with_markup</a>
58
 
                                                        (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *markup,
59
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *text,
60
 
                                                         <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *icon,
61
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *info);
 
56
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>,
 
57
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
 
58
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
 
59
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);
62
60
<a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * <a class="link" href="GtkSourceCompletionItem.html#gtk-source-completion-item-new-from-stock" title="gtk_source_completion_item_new_from_stock ()">gtk_source_completion_item_new_from_stock</a>
63
 
                                                        (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *label,
64
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *text,
65
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *stock,
66
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *info);
 
61
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
62
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
 
63
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock</code></em>,
 
64
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);
67
65
</pre>
68
66
</div>
69
67
<div class="refsect1" title="Object Hierarchy">
91
89
</div>
92
90
<div class="refsect1" title="Description">
93
91
<a name="GtkSourceCompletionItem.description"></a><h2>Description</h2>
94
 
<p>
95
 
</p>
96
92
</div>
97
93
<div class="refsect1" title="Details">
98
94
<a name="GtkSourceCompletionItem.details"></a><h2>Details</h2>
99
95
<div class="refsect2" title="GtkSourceCompletionItem">
100
96
<a name="GtkSourceCompletionItem-struct"></a><h3>GtkSourceCompletionItem</h3>
101
97
<pre class="programlisting">typedef struct _GtkSourceCompletionItem GtkSourceCompletionItem;</pre>
102
 
<p>
103
 
</p>
104
98
</div>
105
99
<hr>
106
100
<div class="refsect2" title="gtk_source_completion_item_new ()">
107
101
<a name="gtk-source-completion-item-new"></a><h3>gtk_source_completion_item_new ()</h3>
108
102
<pre class="programlisting"><a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * gtk_source_completion_item_new
109
 
                                                        (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *label,
110
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *text,
111
 
                                                         <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *icon,
112
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *info);</pre>
 
103
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
104
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
 
105
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
 
106
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);</pre>
113
107
<p>
114
108
Create a new <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a> with label <em class="parameter"><code>label</code></em>, icon <em class="parameter"><code>icon</code></em> and 
115
109
extra information <em class="parameter"><code>info</code></em>. Both <em class="parameter"><code>icon</code></em> and <em class="parameter"><code>info</code></em> can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in which case 
116
 
there will be no icon shown and no extra information available.</p>
 
110
there will be no icon shown and no extra information available.
 
111
</p>
117
112
<div class="variablelist"><table border="0">
118
113
<col align="left" valign="top">
119
114
<tbody>
120
115
<tr>
121
116
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
122
 
<td> The item label
 
117
<td>The item label
123
118
</td>
124
119
</tr>
125
120
<tr>
126
121
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
127
 
<td> The item text
 
122
<td>The item text
128
123
</td>
129
124
</tr>
130
125
<tr>
131
126
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
132
 
<td> The item icon
 
127
<td>The item icon
133
128
</td>
134
129
</tr>
135
130
<tr>
136
131
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
137
 
<td> The item extra information
 
132
<td>The item extra information
138
133
</td>
139
134
</tr>
140
135
<tr>
150
145
<div class="refsect2" title="gtk_source_completion_item_new_with_markup ()">
151
146
<a name="gtk-source-completion-item-new-with-markup"></a><h3>gtk_source_completion_item_new_with_markup ()</h3>
152
147
<pre class="programlisting"><a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * gtk_source_completion_item_new_with_markup
153
 
                                                        (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *markup,
154
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *text,
155
 
                                                         <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="returnvalue">GdkPixbuf</span></a> *icon,
156
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *info);</pre>
 
148
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *markup</code></em>,
 
149
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
 
150
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
 
151
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);</pre>
157
152
<p>
158
153
Create a new <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a> with markup label <em class="parameter"><code>markup</code></em>, icon 
159
154
<em class="parameter"><code>icon</code></em> and extra information <em class="parameter"><code>info</code></em>. Both <em class="parameter"><code>icon</code></em> and <em class="parameter"><code>info</code></em> can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> in 
160
 
which case there will be no icon shown and no extra information available.</p>
 
155
which case there will be no icon shown and no extra information available.
 
156
</p>
161
157
<div class="variablelist"><table border="0">
162
158
<col align="left" valign="top">
163
159
<tbody>
164
160
<tr>
165
161
<td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
166
 
<td> The item markup label
 
162
<td>The item markup label
167
163
</td>
168
164
</tr>
169
165
<tr>
170
166
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
171
 
<td> The item text
 
167
<td>The item text
172
168
</td>
173
169
</tr>
174
170
<tr>
175
171
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
176
 
<td> The item icon
 
172
<td>The item icon
177
173
</td>
178
174
</tr>
179
175
<tr>
180
176
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
181
 
<td> The item extra information
 
177
<td>The item extra information
182
178
</td>
183
179
</tr>
184
180
<tr>
194
190
<div class="refsect2" title="gtk_source_completion_item_new_from_stock ()">
195
191
<a name="gtk-source-completion-item-new-from-stock"></a><h3>gtk_source_completion_item_new_from_stock ()</h3>
196
192
<pre class="programlisting"><a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * gtk_source_completion_item_new_from_stock
197
 
                                                        (const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *label,
198
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *text,
199
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *stock,
200
 
                                                         const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *info);</pre>
 
193
                                                        (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>,
 
194
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>,
 
195
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *stock</code></em>,
 
196
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *info</code></em>);</pre>
201
197
<p>
202
198
Creates a new <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a> from a stock item. If <em class="parameter"><code>label</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, 
203
 
the stock label will be used.</p>
 
199
the stock label will be used.
 
200
</p>
204
201
<div class="variablelist"><table border="0">
205
202
<col align="left" valign="top">
206
203
<tbody>
207
204
<tr>
208
205
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
209
 
<td> The item label
 
206
<td>The item label
210
207
</td>
211
208
</tr>
212
209
<tr>
213
210
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
214
 
<td> The item text
 
211
<td>The item text
215
212
</td>
216
213
</tr>
217
214
<tr>
218
215
<td><p><span class="term"><em class="parameter"><code>stock</code></em> :</span></p></td>
219
 
<td> The stock icon
 
216
<td>The stock icon
220
217
</td>
221
218
</tr>
222
219
<tr>
223
220
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
224
 
<td> The item extra information
 
221
<td>The item extra information
225
222
</td>
226
223
</tr>
227
224
<tr>
240
237
<a name="GtkSourceCompletionItem--icon"></a><h3>The <code class="literal">"icon"</code> property</h3>
241
238
<pre class="programlisting">  "icon"                     <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
242
239
<p>
243
 
Icon to be shown for this proposal.</p>
 
240
Icon to be shown for this proposal.
 
241
</p>
244
242
</div>
245
243
<hr>
246
244
<div class="refsect2" title='The "info" property'>
247
245
<a name="GtkSourceCompletionItem--info"></a><h3>The <code class="literal">"info"</code> property</h3>
248
246
<pre class="programlisting">  "info"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
249
247
<p>
250
 
Optional extra information to be shown for this proposal.</p>
 
248
Optional extra information to be shown for this proposal.
 
249
</p>
251
250
<p>Default value: NULL</p>
252
251
</div>
253
252
<hr>
255
254
<a name="GtkSourceCompletionItem--label"></a><h3>The <code class="literal">"label"</code> property</h3>
256
255
<pre class="programlisting">  "label"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
257
256
<p>
258
 
Label to be shown for this proposal.</p>
 
257
Label to be shown for this proposal.
 
258
</p>
259
259
<p>Default value: NULL</p>
260
260
</div>
261
261
<hr>
263
263
<a name="GtkSourceCompletionItem--markup"></a><h3>The <code class="literal">"markup"</code> property</h3>
264
264
<pre class="programlisting">  "markup"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
265
265
<p>
266
 
Label with markup to be shown for this proposal.</p>
 
266
Label with markup to be shown for this proposal.
 
267
</p>
267
268
<p>Default value: NULL</p>
268
269
</div>
269
270
<hr>
271
272
<a name="GtkSourceCompletionItem--text"></a><h3>The <code class="literal">"text"</code> property</h3>
272
273
<pre class="programlisting">  "text"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
273
274
<p>
274
 
Proposal text.</p>
 
275
Proposal text.
 
276
</p>
275
277
<p>Default value: NULL</p>
276
278
</div>
277
279
</div>
278
280
</div>
279
281
<div class="footer">
280
282
<hr>
281
 
          Generated by GTK-Doc V1.13</div>
 
283
          Generated by GTK-Doc V1.14</div>
282
284
</body>
283
285
</html>
 
 
b'\\ No newline at end of file'