← Back to branch summary

~ubuntu-branches/debian/stretch/gnome-builder/stretch

« back to all changes in this revision

Viewing changes to doc/reference/libide/html/libide-ide-back-forward-list.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2015-10-11 12:38:45 UTC
  • Revision ID: package-import@ubuntu.com-20151011123845-a0hvkz01se0p1p5a
Tags: upstream-3.16.3
Import upstream version 3.16.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/libide/html/libide-ide-back-forward-list.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>ide-back-forward-list: 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="ch11.html" title="Navigation">
 
9
<link rel="prev" href="ch11.html" title="Navigation">
 
10
<link rel="next" href="libide-ide-back-forward-item.html" title="ide-back-forward-item">
 
11
<meta name="generator" content="GTK-Doc V1.21.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
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-back-forward-list.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#libide-ide-back-forward-list.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
 
20
                  <a href="#libide-ide-back-forward-list.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
 
21
                  <a href="#libide-ide-back-forward-list.signals" class="shortcut">Signals</a></span>
 
22
</td>
 
23
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
24
<td><a accesskey="u" href="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
25
<td><a accesskey="p" href="ch11.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
26
<td><a accesskey="n" href="libide-ide-back-forward-item.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
27
</tr></table>
 
28
<div class="refentry">
 
29
<a name="libide-ide-back-forward-list"></a><div class="titlepage"></div>
 
30
<div class="refnamediv"><table width="100%"><tr>
 
31
<td valign="top">
 
32
<h2><span class="refentrytitle"><a name="libide-ide-back-forward-list.top_of_page"></a>ide-back-forward-list</span></h2>
 
33
<p>ide-back-forward-list</p>
 
34
</td>
 
35
<td class="gallery_image" valign="top" align="right"></td>
 
36
</tr></table></div>
 
37
<div class="refsect1">
 
38
<a name="libide-ide-back-forward-list.functions"></a><h2>Functions</h2>
 
39
<div class="informaltable"><table width="100%" border="0">
 
40
<colgroup>
 
41
<col width="150px" class="functions_return">
 
42
<col class="functions_name">
 
43
</colgroup>
 
44
<tbody>
 
45
<tr>
 
46
<td class="define_keyword">#define</td>
 
47
<td class="function_name"><a class="link" href="libide-ide-back-forward-list.html#IDE-TYPE-BACK-FORWARD-LIST:CAPS" title="IDE_TYPE_BACK_FORWARD_LIST">IDE_TYPE_BACK_FORWARD_LIST</a></td>
 
48
</tr>
 
49
<tr>
 
50
<td class="function_type">
 
51
<span class="returnvalue">void</span>
 
52
</td>
 
53
<td class="function_name">
 
54
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-go-backward" title="ide_back_forward_list_go_backward ()">ide_back_forward_list_go_backward</a> <span class="c_punctuation">()</span>
 
55
</td>
 
56
</tr>
 
57
<tr>
 
58
<td class="function_type">
 
59
<span class="returnvalue">void</span>
 
60
</td>
 
61
<td class="function_name">
 
62
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-go-forward" title="ide_back_forward_list_go_forward ()">ide_back_forward_list_go_forward</a> <span class="c_punctuation">()</span>
 
63
</td>
 
64
</tr>
 
65
<tr>
 
66
<td class="function_type">
 
67
<span class="returnvalue">gboolean</span>
 
68
</td>
 
69
<td class="function_name">
 
70
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-get-can-go-backward" title="ide_back_forward_list_get_can_go_backward ()">ide_back_forward_list_get_can_go_backward</a> <span class="c_punctuation">()</span>
 
71
</td>
 
72
</tr>
 
73
<tr>
 
74
<td class="function_type">
 
75
<span class="returnvalue">gboolean</span>
 
76
</td>
 
77
<td class="function_name">
 
78
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-get-can-go-forward" title="ide_back_forward_list_get_can_go_forward ()">ide_back_forward_list_get_can_go_forward</a> <span class="c_punctuation">()</span>
 
79
</td>
 
80
</tr>
 
81
<tr>
 
82
<td class="function_type">
 
83
<a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="returnvalue">IdeBackForwardItem</span></a> *
 
84
</td>
 
85
<td class="function_name">
 
86
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-get-current-item" title="ide_back_forward_list_get_current_item ()">ide_back_forward_list_get_current_item</a> <span class="c_punctuation">()</span>
 
87
</td>
 
88
</tr>
 
89
<tr>
 
90
<td class="function_type">
 
91
<span class="returnvalue">void</span>
 
92
</td>
 
93
<td class="function_name">
 
94
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-push" title="ide_back_forward_list_push ()">ide_back_forward_list_push</a> <span class="c_punctuation">()</span>
 
95
</td>
 
96
</tr>
 
97
<tr>
 
98
<td class="function_type">
 
99
<a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="returnvalue">IdeBackForwardList</span></a> *
 
100
</td>
 
101
<td class="function_name">
 
102
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-branch" title="ide_back_forward_list_branch ()">ide_back_forward_list_branch</a> <span class="c_punctuation">()</span>
 
103
</td>
 
104
</tr>
 
105
<tr>
 
106
<td class="function_type">
 
107
<span class="returnvalue">void</span>
 
108
</td>
 
109
<td class="function_name">
 
110
<a class="link" href="libide-ide-back-forward-list.html#ide-back-forward-list-merge" title="ide_back_forward_list_merge ()">ide_back_forward_list_merge</a> <span class="c_punctuation">()</span>
 
111
</td>
 
112
</tr>
 
113
</tbody>
 
114
</table></div>
 
115
</div>
 
116
<div class="refsect1">
 
117
<a name="libide-ide-back-forward-list.properties"></a><h2>Properties</h2>
 
118
<div class="informaltable"><table border="0">
 
119
<colgroup>
 
120
<col width="150px" class="properties_type">
 
121
<col width="300px" class="properties_name">
 
122
<col width="200px" class="properties_flags">
 
123
</colgroup>
 
124
<tbody>
 
125
<tr>
 
126
<td class="property_type"><span class="type">gboolean</span></td>
 
127
<td class="property_name"><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList--can-go-backward" title="The “can-go-backward” property">can-go-backward</a></td>
 
128
<td class="property_flags">Read</td>
 
129
</tr>
 
130
<tr>
 
131
<td class="property_type"><span class="type">gboolean</span></td>
 
132
<td class="property_name"><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList--can-go-forward" title="The “can-go-forward” property">can-go-forward</a></td>
 
133
<td class="property_flags">Read</td>
 
134
</tr>
 
135
<tr>
 
136
<td class="property_type">
 
137
<a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="type">IdeBackForwardItem</span></a> *</td>
 
138
<td class="property_name"><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList--current-item" title="The “current-item” property">current-item</a></td>
 
139
<td class="property_flags">Read</td>
 
140
</tr>
 
141
</tbody>
 
142
</table></div>
 
143
</div>
 
144
<div class="refsect1">
 
145
<a name="libide-ide-back-forward-list.signals"></a><h2>Signals</h2>
 
146
<div class="informaltable"><table border="0">
 
147
<colgroup>
 
148
<col width="150px" class="signals_return">
 
149
<col width="300px" class="signals_name">
 
150
<col width="200px" class="signals_flags">
 
151
</colgroup>
 
152
<tbody><tr>
 
153
<td class="signal_type"><span class="returnvalue">void</span></td>
 
154
<td class="signal_name"><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList-navigate-to" title="The “navigate-to” signal">navigate-to</a></td>
 
155
<td class="signal_flags">Run Last</td>
 
156
</tr></tbody>
 
157
</table></div>
 
158
</div>
 
159
<a name="IdeBackForwardList"></a><div class="refsect1">
 
160
<a name="libide-ide-back-forward-list.other"></a><h2>Types and Values</h2>
 
161
<div class="informaltable"><table width="100%" border="0">
 
162
<colgroup>
 
163
<col width="150px" class="name">
 
164
<col class="description">
 
165
</colgroup>
 
166
<tbody><tr>
 
167
<td class="datatype_keyword"> </td>
 
168
<td class="function_name"><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList-struct" title="IdeBackForwardList">IdeBackForwardList</a></td>
 
169
</tr></tbody>
 
170
</table></div>
 
171
</div>
 
172
<div class="refsect1">
 
173
<a name="libide-ide-back-forward-list.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
174
<pre class="screen">    GObject
 
175
    <span class="lineart">╰──</span> <a class="link" href="IdeObject.html" title="IdeObject">IdeObject</a>
 
176
        <span class="lineart">╰──</span> IdeBackForwardList
 
177
</pre>
 
178
</div>
 
179
<div class="refsect1">
 
180
<a name="libide-ide-back-forward-list.description"></a><h2>Description</h2>
 
181
</div>
 
182
<div class="refsect1">
 
183
<a name="libide-ide-back-forward-list.functions_details"></a><h2>Functions</h2>
 
184
<div class="refsect2">
 
185
<a name="IDE-TYPE-BACK-FORWARD-LIST:CAPS"></a><h3>IDE_TYPE_BACK_FORWARD_LIST</h3>
 
186
<pre class="programlisting">#define IDE_TYPE_BACK_FORWARD_LIST (ide_back_forward_list_get_type())
 
187
</pre>
 
188
</div>
 
189
<hr>
 
190
<div class="refsect2">
 
191
<a name="ide-back-forward-list-go-backward"></a><h3>ide_back_forward_list_go_backward ()</h3>
 
192
<pre class="programlisting"><span class="returnvalue">void</span>
 
193
ide_back_forward_list_go_backward (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>);</pre>
 
194
</div>
 
195
<hr>
 
196
<div class="refsect2">
 
197
<a name="ide-back-forward-list-go-forward"></a><h3>ide_back_forward_list_go_forward ()</h3>
 
198
<pre class="programlisting"><span class="returnvalue">void</span>
 
199
ide_back_forward_list_go_forward (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>);</pre>
 
200
</div>
 
201
<hr>
 
202
<div class="refsect2">
 
203
<a name="ide-back-forward-list-get-can-go-backward"></a><h3>ide_back_forward_list_get_can_go_backward ()</h3>
 
204
<pre class="programlisting"><span class="returnvalue">gboolean</span>
 
205
ide_back_forward_list_get_can_go_backward
 
206
                               (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>);</pre>
 
207
</div>
 
208
<hr>
 
209
<div class="refsect2">
 
210
<a name="ide-back-forward-list-get-can-go-forward"></a><h3>ide_back_forward_list_get_can_go_forward ()</h3>
 
211
<pre class="programlisting"><span class="returnvalue">gboolean</span>
 
212
ide_back_forward_list_get_can_go_forward
 
213
                               (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>);</pre>
 
214
</div>
 
215
<hr>
 
216
<div class="refsect2">
 
217
<a name="ide-back-forward-list-get-current-item"></a><h3>ide_back_forward_list_get_current_item ()</h3>
 
218
<pre class="programlisting"><a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="returnvalue">IdeBackForwardItem</span></a> *
 
219
ide_back_forward_list_get_current_item
 
220
                               (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>);</pre>
 
221
<p>Retrieves the current <a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="type">IdeBackForwardItem</span></a> or <code class="literal">NULL</code> if no items have been
 
222
added to the <a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a>.</p>
 
223
<div class="refsect3">
 
224
<a name="id-1.2.12.2.10.7.5"></a><h4>Returns</h4>
 
225
<p> An <a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="type">IdeBackForwardItem</span></a> or <code class="literal">NULL</code>. </p>
 
226
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
 
227
</div>
 
228
</div>
 
229
<hr>
 
230
<div class="refsect2">
 
231
<a name="ide-back-forward-list-push"></a><h3>ide_back_forward_list_push ()</h3>
 
232
<pre class="programlisting"><span class="returnvalue">void</span>
 
233
ide_back_forward_list_push (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>,
 
234
                            <em class="parameter"><code><a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="type">IdeBackForwardItem</span></a> *item</code></em>);</pre>
 
235
</div>
 
236
<hr>
 
237
<div class="refsect2">
 
238
<a name="ide-back-forward-list-branch"></a><h3>ide_back_forward_list_branch ()</h3>
 
239
<pre class="programlisting"><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="returnvalue">IdeBackForwardList</span></a> *
 
240
ide_back_forward_list_branch (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>);</pre>
 
241
<p>Branches <em class="parameter"><code>self</code></em>
 
242
 into a newly created <a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a>.</p>
 
243
<p>This can be used independently and then merged back into a global
 
244
<a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a>. This can be useful in situations where you have
 
245
multiple sets of editors.</p>
 
246
<div class="refsect3">
 
247
<a name="id-1.2.12.2.10.9.6"></a><h4>Returns</h4>
 
248
<p> An <a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a>. </p>
 
249
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 
250
</div>
 
251
</div>
 
252
<hr>
 
253
<div class="refsect2">
 
254
<a name="ide-back-forward-list-merge"></a><h3>ide_back_forward_list_merge ()</h3>
 
255
<pre class="programlisting"><span class="returnvalue">void</span>
 
256
ide_back_forward_list_merge (<em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *self</code></em>,
 
257
                             <em class="parameter"><code><a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *branch</code></em>);</pre>
 
258
</div>
 
259
</div>
 
260
<div class="refsect1">
 
261
<a name="libide-ide-back-forward-list.other_details"></a><h2>Types and Values</h2>
 
262
<div class="refsect2">
 
263
<a name="IdeBackForwardList-struct"></a><h3>IdeBackForwardList</h3>
 
264
<pre class="programlisting">typedef struct _IdeBackForwardList IdeBackForwardList;</pre>
 
265
</div>
 
266
</div>
 
267
<div class="refsect1">
 
268
<a name="libide-ide-back-forward-list.property-details"></a><h2>Property Details</h2>
 
269
<div class="refsect2">
 
270
<a name="IdeBackForwardList--can-go-backward"></a><h3>The <code class="literal">“can-go-backward”</code> property</h3>
 
271
<pre class="programlisting">  “can-go-backward”          <span class="type">gboolean</span></pre>
 
272
<p>If there are more backward navigation items.</p>
 
273
<p>Flags: Read</p>
 
274
<p>Default value: FALSE</p>
 
275
</div>
 
276
<hr>
 
277
<div class="refsect2">
 
278
<a name="IdeBackForwardList--can-go-forward"></a><h3>The <code class="literal">“can-go-forward”</code> property</h3>
 
279
<pre class="programlisting">  “can-go-forward”           <span class="type">gboolean</span></pre>
 
280
<p>If there are more forward navigation items.</p>
 
281
<p>Flags: Read</p>
 
282
<p>Default value: FALSE</p>
 
283
</div>
 
284
<hr>
 
285
<div class="refsect2">
 
286
<a name="IdeBackForwardList--current-item"></a><h3>The <code class="literal">“current-item”</code> property</h3>
 
287
<pre class="programlisting">  “current-item”             <a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="type">IdeBackForwardItem</span></a> *</pre>
 
288
<p>The current navigation item.</p>
 
289
<p>Flags: Read</p>
 
290
</div>
 
291
</div>
 
292
<div class="refsect1">
 
293
<a name="libide-ide-back-forward-list.signal-details"></a><h2>Signal Details</h2>
 
294
<div class="refsect2">
 
295
<a name="IdeBackForwardList-navigate-to"></a><h3>The <code class="literal">“navigate-to”</code> signal</h3>
 
296
<pre class="programlisting"><span class="returnvalue">void</span>
 
297
user_function (<a class="link" href="libide-ide-back-forward-list.html#IdeBackForwardList"><span class="type">IdeBackForwardList</span></a> *idebackforwardlist,
 
298
               <a class="link" href="libide-ide-back-forward-item.html#IdeBackForwardItem"><span class="type">IdeBackForwardItem</span></a> *arg1,
 
299
               <span class="type">gpointer</span>            user_data)</pre>
 
300
<p>Flags: Run Last</p>
 
301
</div>
 
302
</div>
 
303
</div>
 
304
<div class="footer">
 
305
<hr>
 
306
          Generated by GTK-Doc V1.21.1</div>
 
307
</body>
 
308
</html>
 
 
b'\\ No newline at end of file'