WebKitBackForwardList.html 30.9 KB
Newer Older
1 2 3 4
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Alberto Garcia's avatar
Alberto Garcia committed
5
<title>WebKitBackForwardList: WebKitGTK Reference Manual</title>
Alberto Garcia's avatar
Alberto Garcia committed
6
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Alberto Garcia's avatar
Alberto Garcia committed
7
<link rel="home" href="index.html" title="WebKitGTK Reference Manual">
8
<link rel="up" href="ch01.html" title="Class Overview">
9
<link rel="prev" href="WebKitAuthenticationRequest.html" title="WebKitAuthenticationRequest">
10
<link rel="next" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem">
Alberto Garcia's avatar
Alberto Garcia committed
11
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
12 13 14
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<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 18 19
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#WebKitBackForwardList.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#WebKitBackForwardList.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
20
                  <a href="#WebKitBackForwardList.signals" class="shortcut">Signals</a></span>
21 22 23 24 25 26
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="WebKitAuthenticationRequest.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="WebKitBackForwardListItem.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
27 28 29 30 31
<div class="refentry">
<a name="WebKitBackForwardList"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="WebKitBackForwardList.top_of_page"></a>WebKitBackForwardList</span></h2>
Alberto Garcia's avatar
Alberto Garcia committed
32
<p>WebKitBackForwardList — List of visited pages</p>
33
</td>
34
<td class="gallery_image" valign="top" align="right"></td>
35 36
</tr></table></div>
<div class="refsect1">
37
<a name="WebKitBackForwardList.functions"></a><h2>Functions</h2>
38
<div class="informaltable"><table class="informaltable" width="100%" border="0">
39
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
40 41
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
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
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-length" title="webkit_back_forward_list_get_length ()">webkit_back_forward_list_get_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-current-item" title="webkit_back_forward_list_get_current_item ()">webkit_back_forward_list_get_current_item</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-back-item" title="webkit_back_forward_list_get_back_item ()">webkit_back_forward_list_get_back_item</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-forward-item" title="webkit_back_forward_list_get_forward_item ()">webkit_back_forward_list_get_forward_item</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-nth-item" title="webkit_back_forward_list_get_nth_item ()">webkit_back_forward_list_get_nth_item</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-back-list" title="webkit_back_forward_list_get_back_list ()">webkit_back_forward_list_get_back_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-back-list-with-limit" title="webkit_back_forward_list_get_back_list_with_limit ()">webkit_back_forward_list_get_back_list_with_limit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-forward-list" title="webkit_back_forward_list_get_forward_list ()">webkit_back_forward_list_get_forward_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="WebKitBackForwardList.html#webkit-back-forward-list-get-forward-list-with-limit" title="webkit_back_forward_list_get_forward_list_with_limit ()">webkit_back_forward_list_get_forward_list_with_limit</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
118 119 120
</div>
<div class="refsect1">
<a name="WebKitBackForwardList.signals"></a><h2>Signals</h2>
121
<div class="informaltable"><table class="informaltable" border="0">
122
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
123 124 125
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
126 127 128 129
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="WebKitBackForwardList.html#WebKitBackForwardList-changed" title="The “changed” signal">changed</a></td>
Alberto Garcia's avatar
Alberto Garcia committed
130
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
131 132 133 134 135
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WebKitBackForwardList.other"></a><h2>Types and Values</h2>
136
<div class="informaltable"><table class="informaltable" width="100%" border="0">
137
<colgroup>
Alberto Garcia's avatar
Alberto Garcia committed
138 139
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
140 141 142 143 144 145 146 147 148
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="WebKitBackForwardList.html#WebKitBackForwardList-struct" title="struct WebKitBackForwardList">WebKitBackForwardList</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="WebKitBackForwardList.object-hierarchy"></a><h2>Object Hierarchy</h2>
149
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
150
    <span class="lineart">╰──</span> WebKitBackForwardList
151 152 153 154
</pre>
</div>
<div class="refsect1">
<a name="WebKitBackForwardList.description"></a><h2>Description</h2>
Alberto Garcia's avatar
Alberto Garcia committed
155 156 157 158 159 160 161 162 163 164 165 166
<p>WebKitBackForwardList maintains a list of visited pages used to
navigate to recent pages. Items are inserted in the list in the
order they are visited.</p>
<p>WebKitBackForwardList also maintains the notion of the current item
(which is always at index 0), the preceding item (which is at index -1),
and the following item (which is at index 1).
Methods <a class="link" href="WebKitWebView.html#webkit-web-view-go-back" title="webkit_web_view_go_back ()"><code class="function">webkit_web_view_go_back()</code></a> and <a class="link" href="WebKitWebView.html#webkit-web-view-go-forward" title="webkit_web_view_go_forward ()"><code class="function">webkit_web_view_go_forward()</code></a> move
the current item backward or forward by one. Method
<a class="link" href="WebKitWebView.html#webkit-web-view-go-to-back-forward-list-item" title="webkit_web_view_go_to_back_forward_list_item ()"><code class="function">webkit_web_view_go_to_back_forward_list_item()</code></a> sets the current item to the
specified item. All other methods returning <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a>s
do not change the value of the current item, they just return the requested
item or items.</p>
167 168
</div>
<div class="refsect1">
169
<a name="WebKitBackForwardList.functions_details"></a><h2>Functions</h2>
170
<div class="refsect2">
171 172 173
<a name="webkit-back-forward-list-get-length"></a><h3>webkit_back_forward_list_get_length ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
webkit_back_forward_list_get_length (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
<div class="refsect3">
<a name="webkit-back-forward-list-get-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-length.returns"></a><h4>Returns</h4>
<p> the length of <em class="parameter"><code>back_forward_list</code></em>
.</p>
</div>
194
</div>
195 196
<hr>
<div class="refsect2">
197 198 199 200
<a name="webkit-back-forward-list-get-current-item"></a><h3>webkit_back_forward_list_get_current_item ()</h3>
<pre class="programlisting"><a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
webkit_back_forward_list_get_current_item
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
<p>Returns the current item in <em class="parameter"><code>back_forward_list</code></em>
.</p>
<div class="refsect3">
<a name="webkit-back-forward-list-get-current-item.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-current-item.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a>
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>back_forward_list</code></em>
is empty. </p>
Alberto Garcia's avatar
Alberto Garcia committed
223
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
Alberto Garcia's avatar
Alberto Garcia committed
224
</div>
225
</div>
226 227
<hr>
<div class="refsect2">
228 229 230 231
<a name="webkit-back-forward-list-get-back-item"></a><h3>webkit_back_forward_list_get_back_item ()</h3>
<pre class="programlisting"><a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
webkit_back_forward_list_get_back_item
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
<p>Returns the item that precedes the current item.</p>
<div class="refsect3">
<a name="webkit-back-forward-list-get-back-item.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-back-item.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a>
preceding the current item or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
Alberto Garcia's avatar
Alberto Garcia committed
252
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
Alberto Garcia's avatar
Alberto Garcia committed
253
</div>
254
</div>
255 256
<hr>
<div class="refsect2">
257 258 259 260
<a name="webkit-back-forward-list-get-forward-item"></a><h3>webkit_back_forward_list_get_forward_item ()</h3>
<pre class="programlisting"><a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
webkit_back_forward_list_get_forward_item
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
<p>Returns the item that follows the current item.</p>
<div class="refsect3">
<a name="webkit-back-forward-list-get-forward-item.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-forward-item.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a>
following the current item or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
Alberto Garcia's avatar
Alberto Garcia committed
281
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
Alberto Garcia's avatar
Alberto Garcia committed
282
</div>
283
</div>
284 285
<hr>
<div class="refsect2">
286 287 288 289
<a name="webkit-back-forward-list-get-nth-item"></a><h3>webkit_back_forward_list_get_nth_item ()</h3>
<pre class="programlisting"><a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="returnvalue">WebKitBackForwardListItem</span></a> *
webkit_back_forward_list_get_nth_item (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>,
                                       <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> index</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
<p>Returns the item at a given index relative to the current item.</p>
<div class="refsect3">
<a name="webkit-back-forward-list-get-nth-item.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>index</p></td>
<td class="parameter_description"><p>the index of the item</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-nth-item.returns"></a><h4>Returns</h4>
<p>the <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a>
Alberto Garcia's avatar
Alberto Garcia committed
316 317
located at the specified index relative to the current item or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
Alberto Garcia's avatar
Alberto Garcia committed
318
</div>
319
</div>
320 321
<hr>
<div class="refsect2">
322 323 324 325
<a name="webkit-back-forward-list-get-back-list"></a><h3>webkit_back_forward_list_get_back_list ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
webkit_back_forward_list_get_back_list
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
<div class="refsect3">
<a name="webkit-back-forward-list-get-back-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-back-list.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
items preceding the current item. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKit2.BackForwardListItem][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
347
</div>
348 349
<hr>
<div class="refsect2">
350 351 352 353 354
<a name="webkit-back-forward-list-get-back-list-with-limit"></a><h3>webkit_back_forward_list_get_back_list_with_limit ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
webkit_back_forward_list_get_back_list_with_limit
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> limit</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
<div class="refsect3">
<a name="webkit-back-forward-list-get-back-list-with-limit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>limit</p></td>
<td class="parameter_description"><p>the number of items to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-back-list-with-limit.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
items preceding the current item limited by <em class="parameter"><code>limit</code></em>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKit2.BackForwardListItem][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
384
</div>
385 386
<hr>
<div class="refsect2">
387 388 389 390
<a name="webkit-back-forward-list-get-forward-list"></a><h3>webkit_back_forward_list_get_forward_list ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
webkit_back_forward_list_get_forward_list
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
<div class="refsect3">
<a name="webkit-back-forward-list-get-forward-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-forward-list.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
items following the current item. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKit2.BackForwardListItem][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
412
</div>
413 414
<hr>
<div class="refsect2">
415 416 417 418 419
<a name="webkit-back-forward-list-get-forward-list-with-limit"></a><h3>webkit_back_forward_list_get_forward_list_with_limit ()</h3>
<pre class="programlisting"><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
webkit_back_forward_list_get_forward_list_with_limit
                               (<em class="parameter"><code><a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> *back_forward_list</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> limit</code></em>);</pre>
Alberto Garcia's avatar
Alberto Garcia committed
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
<div class="refsect3">
<a name="webkit-back-forward-list-get-forward-list-with-limit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>a <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>limit</p></td>
<td class="parameter_description"><p>the number of items to retrieve</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="webkit-back-forward-list-get-forward-list-with-limit.returns"></a><h4>Returns</h4>
<p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of
items following the current item limited by <em class="parameter"><code>limit</code></em>
. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> WebKit2.BackForwardListItem][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
449
</div>
450 451
</div>
<div class="refsect1">
452
<a name="WebKitBackForwardList.other_details"></a><h2>Types and Values</h2>
453
<div class="refsect2">
454 455 456 457 458 459 460 461 462
<a name="WebKitBackForwardList-struct"></a><h3>struct WebKitBackForwardList</h3>
<pre class="programlisting">struct WebKitBackForwardList;</pre>
</div>
</div>
<div class="refsect1">
<a name="WebKitBackForwardList.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="WebKitBackForwardList-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
Alberto Garcia's avatar
Alberto Garcia committed
463 464 465
user_function (<a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a>     *back_forward_list,
               <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a> *item_added,
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                   items_removed,
466
               <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>                   user_data)</pre>
Alberto Garcia's avatar
Alberto Garcia committed
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
<p>This signal is emitted when <em class="parameter"><code>back_forward_list</code></em>
 changes. This happens
when the current item is updated, a new item is added or one or more
items are removed. Note that both <em class="parameter"><code>item_added</code></em>
 and <em class="parameter"><code>items_removed</code></em>
 can
<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when only the current item is updated. Items are only removed
when the list is cleared or the maximum items limit is reached.</p>
<div class="refsect3">
<a name="WebKitBackForwardList-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>back_forward_list</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitBackForwardList.html" title="WebKitBackForwardList"><span class="type">WebKitBackForwardList</span></a> on which the signal was emitted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>item_added</p></td>
<td class="parameter_description"><p>the <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a> added or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><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 class="parameter_name"><p>items_removed</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a>s</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
Alberto Garcia's avatar
Alberto Garcia committed
507
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
508
</div>
509
</div>
Alberto Garcia's avatar
Alberto Garcia committed
510 511
<div class="refsect1">
<a name="WebKitBackForwardList.see-also"></a><h2>See Also</h2>
Alberto Garcia's avatar
Alberto Garcia committed
512
<p><a class="link" href="WebKitWebView.html" title="The main frame document title of this #WebKitWebView. If the title has not been received yet, it will be %NULL."><span class="type">WebKitWebView</span></a>, <a class="link" href="WebKitBackForwardListItem.html" title="WebKitBackForwardListItem"><span class="type">WebKitBackForwardListItem</span></a></p>
Alberto Garcia's avatar
Alberto Garcia committed
513
</div>
514 515
</div>
<div class="footer">
Alberto Garcia's avatar
Alberto Garcia committed
516
<hr>Generated by GTK-Doc V1.33.0</div>
517 518
</body>
</html>