1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>ide-source-snippet-chunk: LibIDE Reference Manual</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
<link rel="home" href="index.html" title="LibIDE Reference Manual">
8
<link rel="up" href="ch06.html" title="Snippets">
9
<link rel="prev" href="libide-ide-source-snippet-context.html" title="ide-source-snippet-context">
10
<link rel="next" href="libide-ide-source-snippets.html" title="ide-source-snippets">
11
<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16
<td width="100%" align="left" class="shortcuts">
17
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
18
<a href="#libide-ide-source-snippet-chunk.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#libide-ide-source-snippet-chunk.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
20
<a href="#libide-ide-source-snippet-chunk.properties" class="shortcut">Properties</a></span>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
<td><a accesskey="p" href="libide-ide-source-snippet-context.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
<td><a accesskey="n" href="libide-ide-source-snippets.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27
<div class="refentry">
28
<a name="libide-ide-source-snippet-chunk"></a><div class="titlepage"></div>
29
<div class="refnamediv"><table width="100%"><tr>
31
<h2><span class="refentrytitle"><a name="libide-ide-source-snippet-chunk.top_of_page"></a>ide-source-snippet-chunk</span></h2>
32
<p>ide-source-snippet-chunk</p>
34
<td class="gallery_image" valign="top" align="right"></td>
36
<div class="refsect1">
37
<a name="libide-ide-source-snippet-chunk.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table width="100%" border="0">
40
<col width="150px" class="functions_return">
41
<col class="functions_name">
45
<td class="define_keyword">#define</td>
46
<td class="function_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IDE-TYPE-SOURCE-SNIPPET-CHUNK:CAPS" title="IDE_TYPE_SOURCE_SNIPPET_CHUNK">IDE_TYPE_SOURCE_SNIPPET_CHUNK</a></td>
49
<td class="function_type">
50
<a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="returnvalue">IdeSourceSnippetChunk</span></a> *
52
<td class="function_name">
53
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-new" title="ide_source_snippet_chunk_new ()">ide_source_snippet_chunk_new</a> <span class="c_punctuation">()</span>
57
<td class="function_type">
58
<a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="returnvalue">IdeSourceSnippetChunk</span></a> *
60
<td class="function_name">
61
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-copy" title="ide_source_snippet_chunk_copy ()">ide_source_snippet_chunk_copy</a> <span class="c_punctuation">()</span>
65
<td class="function_type">
66
<a class="link" href="libide-ide-source-snippet-context.html#IdeSourceSnippetContext"><span class="returnvalue">IdeSourceSnippetContext</span></a> *
68
<td class="function_name">
69
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-get-context" title="ide_source_snippet_chunk_get_context ()">ide_source_snippet_chunk_get_context</a> <span class="c_punctuation">()</span>
73
<td class="function_type">
74
<span class="returnvalue">void</span>
76
<td class="function_name">
77
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-set-context" title="ide_source_snippet_chunk_set_context ()">ide_source_snippet_chunk_set_context</a> <span class="c_punctuation">()</span>
81
<td class="function_type">const <span class="returnvalue">gchar</span> *
83
<td class="function_name">
84
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-get-spec" title="ide_source_snippet_chunk_get_spec ()">ide_source_snippet_chunk_get_spec</a> <span class="c_punctuation">()</span>
88
<td class="function_type">
89
<span class="returnvalue">void</span>
91
<td class="function_name">
92
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-set-spec" title="ide_source_snippet_chunk_set_spec ()">ide_source_snippet_chunk_set_spec</a> <span class="c_punctuation">()</span>
96
<td class="function_type">
97
<span class="returnvalue">gint</span>
99
<td class="function_name">
100
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-get-tab-stop" title="ide_source_snippet_chunk_get_tab_stop ()">ide_source_snippet_chunk_get_tab_stop</a> <span class="c_punctuation">()</span>
104
<td class="function_type">
105
<span class="returnvalue">void</span>
107
<td class="function_name">
108
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-set-tab-stop" title="ide_source_snippet_chunk_set_tab_stop ()">ide_source_snippet_chunk_set_tab_stop</a> <span class="c_punctuation">()</span>
112
<td class="function_type">const <span class="returnvalue">gchar</span> *
114
<td class="function_name">
115
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-get-text" title="ide_source_snippet_chunk_get_text ()">ide_source_snippet_chunk_get_text</a> <span class="c_punctuation">()</span>
119
<td class="function_type">
120
<span class="returnvalue">void</span>
122
<td class="function_name">
123
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-set-text" title="ide_source_snippet_chunk_set_text ()">ide_source_snippet_chunk_set_text</a> <span class="c_punctuation">()</span>
127
<td class="function_type">
128
<span class="returnvalue">gboolean</span>
130
<td class="function_name">
131
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-get-text-set" title="ide_source_snippet_chunk_get_text_set ()">ide_source_snippet_chunk_get_text_set</a> <span class="c_punctuation">()</span>
135
<td class="function_type">
136
<span class="returnvalue">void</span>
138
<td class="function_name">
139
<a class="link" href="libide-ide-source-snippet-chunk.html#ide-source-snippet-chunk-set-text-set" title="ide_source_snippet_chunk_set_text_set ()">ide_source_snippet_chunk_set_text_set</a> <span class="c_punctuation">()</span>
145
<div class="refsect1">
146
<a name="libide-ide-source-snippet-chunk.properties"></a><h2>Properties</h2>
147
<div class="informaltable"><table border="0">
149
<col width="150px" class="properties_type">
150
<col width="300px" class="properties_name">
151
<col width="200px" class="properties_flags">
155
<td class="property_type">
156
<a class="link" href="libide-ide-source-snippet-context.html#IdeSourceSnippetContext"><span class="type">IdeSourceSnippetContext</span></a> *</td>
157
<td class="property_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk--context" title="The “context” property">context</a></td>
158
<td class="property_flags">Read / Write</td>
161
<td class="property_type">
162
<span class="type">gchar</span> *</td>
163
<td class="property_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk--spec" title="The “spec” property">spec</a></td>
164
<td class="property_flags">Read / Write</td>
167
<td class="property_type"><span class="type">gint</span></td>
168
<td class="property_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk--tab-stop" title="The “tab-stop” property">tab-stop</a></td>
169
<td class="property_flags">Read / Write</td>
172
<td class="property_type">
173
<span class="type">gchar</span> *</td>
174
<td class="property_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk--text" title="The “text” property">text</a></td>
175
<td class="property_flags">Read / Write</td>
178
<td class="property_type"><span class="type">gboolean</span></td>
179
<td class="property_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk--text-set" title="The “text-set” property">text-set</a></td>
180
<td class="property_flags">Read / Write</td>
185
<a name="IdeSourceSnippetChunk"></a><div class="refsect1">
186
<a name="libide-ide-source-snippet-chunk.other"></a><h2>Types and Values</h2>
187
<div class="informaltable"><table width="100%" border="0">
189
<col width="150px" class="name">
190
<col class="description">
193
<td class="datatype_keyword"> </td>
194
<td class="function_name"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk-struct" title="IdeSourceSnippetChunk">IdeSourceSnippetChunk</a></td>
198
<div class="refsect1">
199
<a name="libide-ide-source-snippet-chunk.object-hierarchy"></a><h2>Object Hierarchy</h2>
200
<pre class="screen"> GObject
201
<span class="lineart">╰──</span> IdeSourceSnippetChunk
204
<div class="refsect1">
205
<a name="libide-ide-source-snippet-chunk.description"></a><h2>Description</h2>
207
<div class="refsect1">
208
<a name="libide-ide-source-snippet-chunk.functions_details"></a><h2>Functions</h2>
209
<div class="refsect2">
210
<a name="IDE-TYPE-SOURCE-SNIPPET-CHUNK:CAPS"></a><h3>IDE_TYPE_SOURCE_SNIPPET_CHUNK</h3>
211
<pre class="programlisting">#define IDE_TYPE_SOURCE_SNIPPET_CHUNK (ide_source_snippet_chunk_get_type())
215
<div class="refsect2">
216
<a name="ide-source-snippet-chunk-new"></a><h3>ide_source_snippet_chunk_new ()</h3>
217
<pre class="programlisting"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="returnvalue">IdeSourceSnippetChunk</span></a> *
218
ide_source_snippet_chunk_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
221
<div class="refsect2">
222
<a name="ide-source-snippet-chunk-copy"></a><h3>ide_source_snippet_chunk_copy ()</h3>
223
<pre class="programlisting"><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="returnvalue">IdeSourceSnippetChunk</span></a> *
224
ide_source_snippet_chunk_copy (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>);</pre>
225
<p>Copies the source snippet.</p>
226
<div class="refsect3">
227
<a name="id-1.2.7.5.9.4.5"></a><h4>Returns</h4>
228
<p> An <a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a>. </p>
229
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
233
<div class="refsect2">
234
<a name="ide-source-snippet-chunk-get-context"></a><h3>ide_source_snippet_chunk_get_context ()</h3>
235
<pre class="programlisting"><a class="link" href="libide-ide-source-snippet-context.html#IdeSourceSnippetContext"><span class="returnvalue">IdeSourceSnippetContext</span></a> *
236
ide_source_snippet_chunk_get_context (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>);</pre>
237
<p>Gets the context for the snippet insertion.</p>
238
<div class="refsect3">
239
<a name="id-1.2.7.5.9.5.5"></a><h4>Returns</h4>
240
<p> An <a class="link" href="libide-ide-source-snippet-context.html#IdeSourceSnippetContext"><span class="type">IdeSourceSnippetContext</span></a>. </p>
241
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
245
<div class="refsect2">
246
<a name="ide-source-snippet-chunk-set-context"></a><h3>ide_source_snippet_chunk_set_context ()</h3>
247
<pre class="programlisting"><span class="returnvalue">void</span>
248
ide_source_snippet_chunk_set_context (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>,
249
<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-context.html#IdeSourceSnippetContext"><span class="type">IdeSourceSnippetContext</span></a> *context</code></em>);</pre>
252
<div class="refsect2">
253
<a name="ide-source-snippet-chunk-get-spec"></a><h3>ide_source_snippet_chunk_get_spec ()</h3>
254
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
255
ide_source_snippet_chunk_get_spec (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>);</pre>
258
<div class="refsect2">
259
<a name="ide-source-snippet-chunk-set-spec"></a><h3>ide_source_snippet_chunk_set_spec ()</h3>
260
<pre class="programlisting"><span class="returnvalue">void</span>
261
ide_source_snippet_chunk_set_spec (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>,
262
<em class="parameter"><code>const <span class="type">gchar</span> *spec</code></em>);</pre>
265
<div class="refsect2">
266
<a name="ide-source-snippet-chunk-get-tab-stop"></a><h3>ide_source_snippet_chunk_get_tab_stop ()</h3>
267
<pre class="programlisting"><span class="returnvalue">gint</span>
268
ide_source_snippet_chunk_get_tab_stop (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>);</pre>
271
<div class="refsect2">
272
<a name="ide-source-snippet-chunk-set-tab-stop"></a><h3>ide_source_snippet_chunk_set_tab_stop ()</h3>
273
<pre class="programlisting"><span class="returnvalue">void</span>
274
ide_source_snippet_chunk_set_tab_stop (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>,
275
<em class="parameter"><code><span class="type">gint</span> tab_stop</code></em>);</pre>
278
<div class="refsect2">
279
<a name="ide-source-snippet-chunk-get-text"></a><h3>ide_source_snippet_chunk_get_text ()</h3>
280
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
281
ide_source_snippet_chunk_get_text (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>);</pre>
284
<div class="refsect2">
285
<a name="ide-source-snippet-chunk-set-text"></a><h3>ide_source_snippet_chunk_set_text ()</h3>
286
<pre class="programlisting"><span class="returnvalue">void</span>
287
ide_source_snippet_chunk_set_text (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>,
288
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
291
<div class="refsect2">
292
<a name="ide-source-snippet-chunk-get-text-set"></a><h3>ide_source_snippet_chunk_get_text_set ()</h3>
293
<pre class="programlisting"><span class="returnvalue">gboolean</span>
294
ide_source_snippet_chunk_get_text_set (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>);</pre>
297
<div class="refsect2">
298
<a name="ide-source-snippet-chunk-set-text-set"></a><h3>ide_source_snippet_chunk_set_text_set ()</h3>
299
<pre class="programlisting"><span class="returnvalue">void</span>
300
ide_source_snippet_chunk_set_text_set (<em class="parameter"><code><a class="link" href="libide-ide-source-snippet-chunk.html#IdeSourceSnippetChunk"><span class="type">IdeSourceSnippetChunk</span></a> *chunk</code></em>,
301
<em class="parameter"><code><span class="type">gboolean</span> text_set</code></em>);</pre>
304
<div class="refsect1">
305
<a name="libide-ide-source-snippet-chunk.other_details"></a><h2>Types and Values</h2>
306
<div class="refsect2">
307
<a name="IdeSourceSnippetChunk-struct"></a><h3>IdeSourceSnippetChunk</h3>
308
<pre class="programlisting">typedef struct _IdeSourceSnippetChunk IdeSourceSnippetChunk;</pre>
311
<div class="refsect1">
312
<a name="libide-ide-source-snippet-chunk.property-details"></a><h2>Property Details</h2>
313
<div class="refsect2">
314
<a name="IdeSourceSnippetChunk--context"></a><h3>The <code class="literal">“context”</code> property</h3>
315
<pre class="programlisting"> “context” <a class="link" href="libide-ide-source-snippet-context.html#IdeSourceSnippetContext"><span class="type">IdeSourceSnippetContext</span></a> *</pre>
316
<p>The snippet context.</p>
317
<p>Flags: Read / Write</p>
320
<div class="refsect2">
321
<a name="IdeSourceSnippetChunk--spec"></a><h3>The <code class="literal">“spec”</code> property</h3>
322
<pre class="programlisting"> “spec” <span class="type">gchar</span> *</pre>
323
<p>The specification to expand using the context.</p>
324
<p>Flags: Read / Write</p>
325
<p>Default value: NULL</p>
328
<div class="refsect2">
329
<a name="IdeSourceSnippetChunk--tab-stop"></a><h3>The <code class="literal">“tab-stop”</code> property</h3>
330
<pre class="programlisting"> “tab-stop” <span class="type">gint</span></pre>
331
<p>The tab stop for the chunk.</p>
332
<p>Flags: Read / Write</p>
333
<p>Allowed values: >= -1</p>
334
<p>Default value: -1</p>
337
<div class="refsect2">
338
<a name="IdeSourceSnippetChunk--text"></a><h3>The <code class="literal">“text”</code> property</h3>
339
<pre class="programlisting"> “text” <span class="type">gchar</span> *</pre>
340
<p>The text for the chunk.</p>
341
<p>Flags: Read / Write</p>
342
<p>Default value: NULL</p>
345
<div class="refsect2">
346
<a name="IdeSourceSnippetChunk--text-set"></a><h3>The <code class="literal">“text-set”</code> property</h3>
347
<pre class="programlisting"> “text-set” <span class="type">gboolean</span></pre>
348
<p>If the text property has been manually set.</p>
349
<p>Flags: Read / Write</p>
350
<p>Default value: FALSE</p>
356
Generated by GTK-Doc V1.21.1</div>
b'\\ No newline at end of file'