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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkSourceCompletionItem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GtkSourceView 3 Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="GtkSourceCompletionInfo.html" title="GtkSourceCompletionInfo">
<link rel="next" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal">
<meta name="generator" content="GTK-Doc V1.19.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkSourceCompletionInfo.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkSourceView 3 Reference Manual</th>
<td><a accesskey="n" href="GtkSourceCompletionProposal.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkSourceCompletionItem.synopsis" class="shortcut">Top</a>
|
<a href="#GtkSourceCompletionItem.description" class="shortcut">Description</a>
|
<a href="#GtkSourceCompletionItem.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkSourceCompletionItem.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GtkSourceCompletionItem.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkSourceCompletionItem"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkSourceCompletionItem.top_of_page"></a>GtkSourceCompletionItem</span></h2>
<p>GtkSourceCompletionItem — Simple implementation of <a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a></p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkSourceCompletionItem.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtksourceview/gtksource.h>
<a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem-struct" title="GtkSourceCompletionItem">GtkSourceCompletionItem</a>;
<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>
(<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>,
<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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
<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>);
<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>
(<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>,
<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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
<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>);
<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>
(<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>,
<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>,
<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>,
<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>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionItem.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----GtkSourceCompletionItem
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionItem.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkSourceCompletionItem implements
<a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal">GtkSourceCompletionProposal</a>.</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionItem.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem--icon" title='The "icon" property'>icon</a>" <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write
"<a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem--info" title='The "info" property'>info</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem--label" title='The "label" property'>label</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem--markup" title='The "markup" property'>markup</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GtkSourceCompletionItem.html#GtkSourceCompletionItem--text" title='The "text" property'>text</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionItem.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a> class is a simple implementation of the
<a class="link" href="GtkSourceCompletionProposal.html" title="GtkSourceCompletionProposal"><span class="type">GtkSourceCompletionProposal</span></a> interface.
</p>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionItem.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletionItem-struct"></a><h3>GtkSourceCompletionItem</h3>
<pre class="programlisting">typedef struct _GtkSourceCompletionItem GtkSourceCompletionItem;</pre>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-item-new"></a><h3>gtk_source_completion_item_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * gtk_source_completion_item_new
(<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>,
<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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
<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>
<p>
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
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
there will be no icon shown and no extra information available.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>The item label.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The item text.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>The item icon. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>The item extra information. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-item-new-with-markup"></a><h3>gtk_source_completion_item_new_with_markup ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * gtk_source_completion_item_new_with_markup
(<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>,
<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>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *icon</code></em>,
<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>
<p>
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
<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
which case there will be no icon shown and no extra information available.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
<td>The item markup label.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The item text.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
<td>The item icon. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>The item extra information. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-source-completion-item-new-from-stock"></a><h3>gtk_source_completion_item_new_from_stock ()</h3>
<pre class="programlisting"><a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="returnvalue">GtkSourceCompletionItem</span></a> * gtk_source_completion_item_new_from_stock
(<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>,
<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>,
<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>,
<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>
<p>
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>,
the stock label will be used.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>The item label. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>The item text.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stock</code></em> :</span></p></td>
<td>The stock icon.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>info</code></em> :</span></p></td>
<td>The item extra information. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkSourceCompletionItem.html" title="GtkSourceCompletionItem"><span class="type">GtkSourceCompletionItem</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GtkSourceCompletionItem.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkSourceCompletionItem--icon"></a><h3>The <code class="literal">"icon"</code> property</h3>
<pre class="programlisting"> "icon" <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>* : Read / Write</pre>
<p>
Icon to be shown for this proposal.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletionItem--info"></a><h3>The <code class="literal">"info"</code> property</h3>
<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>
<p>
Optional extra information to be shown for this proposal.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletionItem--label"></a><h3>The <code class="literal">"label"</code> property</h3>
<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>
<p>
Label to be shown for this proposal.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletionItem--markup"></a><h3>The <code class="literal">"markup"</code> property</h3>
<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>
<p>
Label with markup to be shown for this proposal.
</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkSourceCompletionItem--text"></a><h3>The <code class="literal">"text"</code> property</h3>
<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>
<p>
Proposal text.
</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19.1</div>
</body>
</html>
|