/usr/share/gtk-doc/html/libinfinity-0.6/InfAdoptedUndoGrouping.html is in libinfinity-0.6-doc 0.6.7-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 287 288 289 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 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 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 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 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 507 508 509 510 511 512 513 514 515 516 517 518 519 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfAdoptedUndoGrouping: libinfinity-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinity-0.6 Reference Manual">
<link rel="up" href="ch03.html" title="Libinfinity's adOPTed implementation">
<link rel="prev" href="InfAdoptedSessionReplay.html" title="InfAdoptedSessionReplay">
<link rel="next" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm">
<meta name="generator" content="GTK-Doc V1.24 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#InfAdoptedUndoGrouping.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#InfAdoptedUndoGrouping.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#InfAdoptedUndoGrouping.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#InfAdoptedUndoGrouping.signals" class="shortcut">Signals</a></span>
</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfAdoptedSessionReplay.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfAdoptedAlgorithm.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="InfAdoptedUndoGrouping"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfAdoptedUndoGrouping.top_of_page"></a>InfAdoptedUndoGrouping</span></h2>
<p>InfAdoptedUndoGrouping — Grouping of requests to be undone simultaneously</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="returnvalue">InfAdoptedUndoGrouping</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-new" title="inf_adopted_undo_grouping_new ()">inf_adopted_undo_grouping_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="returnvalue">InfAdoptedAlgorithm</span></a> *
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-get-algorithm" title="inf_adopted_undo_grouping_get_algorithm ()">inf_adopted_undo_grouping_get_algorithm</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-set-algorithm" title="inf_adopted_undo_grouping_set_algorithm ()">inf_adopted_undo_grouping_set_algorithm</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-start-group" title="inf_adopted_undo_grouping_start_group ()">inf_adopted_undo_grouping_start_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-end-group" title="inf_adopted_undo_grouping_end_group ()">inf_adopted_undo_grouping_end_group</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-get-undo-size" title="inf_adopted_undo_grouping_get_undo_size ()">inf_adopted_undo_grouping_get_undo_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-get-redo-size" title="inf_adopted_undo_grouping_get_redo_size ()">inf_adopted_undo_grouping_get_redo_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping--algorithm" title="The “algorithm” property">algorithm</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *</td>
<td class="property_name"><a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping--user" title="The “user” property">user</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">gboolean</span></td>
<td class="signal_name"><a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-group-requests" title="The “group-requests” signal">group-requests</a></td>
<td class="signal_flags">Run Last</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-struct" title="struct InfAdoptedUndoGrouping">InfAdoptedUndoGrouping</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGroupingClass" title="struct InfAdoptedUndoGroupingClass">InfAdoptedUndoGroupingClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> InfAdoptedUndoGrouping
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libinfinity/adopted/inf-adopted-undo-grouping.h>
</pre>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.description"></a><h2>Description</h2>
<p><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> groups related requests together so that they can
be undone at the same time. For example, Undo in a text editor is normally
expected to operate on written words, not characters. Therefore, multiple
requests need to be undone at once.</p>
<p>The undo grouping helps with this. Everytime it needs to decide whether two
requests should be grouped it emits
<a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-group-requests" title="The “group-requests” signal"><span class="type">“group-requests”</span></a>. If the signal handler returns
<code class="literal">TRUE</code> then the two requests will be undone at the same time, otherwise not.</p>
<p>It is also possible to explicitely group a bunch of requests that would
not be grouped otherwise, by calling <a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-start-group" title="inf_adopted_undo_grouping_start_group ()"><code class="function">inf_adopted_undo_grouping_start_group()</code></a>
and <a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-end-group" title="inf_adopted_undo_grouping_end_group ()"><code class="function">inf_adopted_undo_grouping_end_group()</code></a> before and after issuing the
requests, respectively.</p>
<p>The default signal handler always returns <code class="literal">FALSE</code>. However, this behaviour
can be changed in derived classes.</p>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-new"></a><h3>inf_adopted_undo_grouping_new ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="returnvalue">InfAdoptedUndoGrouping</span></a> *
inf_adopted_undo_grouping_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>. To start grouping requests, set a
user whose requests to group via <a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-set-algorithm" title="inf_adopted_undo_grouping_set_algorithm ()"><code class="function">inf_adopted_undo_grouping_set_algorithm()</code></a>.
Before doing so you might want to connect to
<a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-group-requests" title="The “group-requests” signal"><span class="type">“group-requests”</span></a>, so the user's initial requests can
be grouped correctly.</p>
<div class="refsect3">
<a name="id-1.4.5.11.2.5"></a><h4>Returns</h4>
<p> A new <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>, to be freed via <code class="function">g_object_unref()</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-get-algorithm"></a><h3>inf_adopted_undo_grouping_get_algorithm ()</h3>
<pre class="programlisting"><a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="returnvalue">InfAdoptedAlgorithm</span></a> *
inf_adopted_undo_grouping_get_algorithm
(<em class="parameter"><code><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping</code></em>);</pre>
<p>Returns the <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> for <em class="parameter"><code>grouping</code></em>
.</p>
<div class="refsect3">
<a name="id-1.4.5.11.3.5"></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>grouping</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.11.3.6"></a><h4>Returns</h4>
<p> <em class="parameter"><code>grouping</code></em>
's algorithm.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-set-algorithm"></a><h3>inf_adopted_undo_grouping_set_algorithm ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_undo_grouping_set_algorithm
(<em class="parameter"><code><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> *algorithm</code></em>,
<em class="parameter"><code><a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *user</code></em>);</pre>
<p>Sets the algorithm and user to group requests for. This function will group
all requests in user's request log, and also each new request that is
added to it's log. Requests that cannot be undone anymore (because
they are too old), will be correctly taken care off.</p>
<div class="refsect3">
<a name="id-1.4.5.11.4.5"></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>grouping</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>algorithm</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> for the document to group requests,
or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user</p></td>
<td class="parameter_description"><p>The user for which to group requests, or <code class="literal">NULL</code>. Ignored if
<em class="parameter"><code>algorithm</code></em>
is <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-start-group"></a><h3>inf_adopted_undo_grouping_start_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_undo_grouping_start_group (<em class="parameter"><code><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> allow_group_with_prev</code></em>);</pre>
<p>Makes all requests issued after this call belong into the same group,
i.e. they will be undone at once. This can make sense for example when the
user copy+pastes something into the document which causes multiple requests
to be generated. A call to <a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-end-group" title="inf_adopted_undo_grouping_end_group ()"><code class="function">inf_adopted_undo_grouping_end_group()</code></a> restores
the normal behavior.</p>
<div class="refsect3">
<a name="id-1.4.5.11.5.5"></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>grouping</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>allow_group_with_prev</p></td>
<td class="parameter_description"><p>Whether the new group can be part of the previous
group if <a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-group-requests" title="The “group-requests” signal"><span class="type">“group-requests”</span></a> allows.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-end-group"></a><h3>inf_adopted_undo_grouping_end_group ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
inf_adopted_undo_grouping_end_group (<em class="parameter"><code><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> allow_group_with_next</code></em>);</pre>
<p>When <a class="link" href="InfAdoptedUndoGrouping.html#inf-adopted-undo-grouping-start-group" title="inf_adopted_undo_grouping_start_group ()"><code class="function">inf_adopted_undo_grouping_start_group()</code></a> was called before, then this
function restores the normal behaviour of grouping requests.</p>
<div class="refsect3">
<a name="id-1.4.5.11.6.5"></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>grouping</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>allow_group_with_next</p></td>
<td class="parameter_description"><p>Whether subsequent requests are allow to be part of
this group if <a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-group-requests" title="The “group-requests” signal"><span class="type">“group-requests”</span></a> allows.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-get-undo-size"></a><h3>inf_adopted_undo_grouping_get_undo_size ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_adopted_undo_grouping_get_undo_size
(<em class="parameter"><code><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping</code></em>);</pre>
<p>Returns the number of requests to undo so that a whole group is being
undone. This takes into account that possibly not the whole group cannot
be undone due to the <a class="link" href="InfAdoptedAlgorithm.html#InfAdoptedAlgorithm--max-total-log-size" title="The “max-total-log-size” property"><span class="type">“max-total-log-size”</span></a> constraint.</p>
<div class="refsect3">
<a name="id-1.4.5.11.7.5"></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>grouping</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.11.7.6"></a><h4>Returns</h4>
<p> The number of requests in the current undo group.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-adopted-undo-grouping-get-redo-size"></a><h3>inf_adopted_undo_grouping_get_redo_size ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
inf_adopted_undo_grouping_get_redo_size
(<em class="parameter"><code><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping</code></em>);</pre>
<p>Returns the number of requests to redo so that a whole group is being
redone. This takes into account that possibly not the whole group cannot
be undone due to the <a class="link" href="InfAdoptedAlgorithm.html#InfAdoptedAlgorithm--max-total-log-size" title="The “max-total-log-size” property"><span class="type">“max-total-log-size”</span></a> constraint.</p>
<div class="refsect3">
<a name="id-1.4.5.11.8.5"></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>grouping</p></td>
<td class="parameter_description"><p>A <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.4.5.11.8.6"></a><h4>Returns</h4>
<p> The number of requests in the current redo group.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfAdoptedUndoGrouping-struct"></a><h3>struct InfAdoptedUndoGrouping</h3>
<pre class="programlisting">struct InfAdoptedUndoGrouping;</pre>
<p><a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> is an opaque data type. You should only access it via
the public API functions.</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedUndoGroupingClass"></a><h3>struct InfAdoptedUndoGroupingClass</h3>
<pre class="programlisting">struct InfAdoptedUndoGroupingClass {
gboolean (*group_requests)(InfAdoptedUndoGrouping* grouping,
InfAdoptedRequest* first,
InfAdoptedRequest* second);
};
</pre>
<p>This structure contains default signal handlers for <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a>.</p>
<div class="refsect3">
<a name="id-1.4.5.12.3.5"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="InfAdoptedUndoGroupingClass.group-requests"></a>group_requests</code></em> ()</p></td>
<td class="struct_member_description"><p>Default signal handler for the
<a class="link" href="InfAdoptedUndoGrouping.html#InfAdoptedUndoGrouping-group-requests" title="The “group-requests” signal"><span class="type">“group-requests”</span></a> signal.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfAdoptedUndoGrouping--algorithm"></a><h3>The <code class="literal">“algorithm”</code> property</h3>
<pre class="programlisting"> “algorithm” <a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a> *</pre>
<p>The algorithm for which to group requests.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="InfAdoptedUndoGrouping--user"></a><h3>The <code class="literal">“user”</code> property</h3>
<pre class="programlisting"> “user” <a class="link" href="InfAdoptedUser.html" title="InfAdoptedUser"><span class="type">InfAdoptedUser</span></a> *</pre>
<p>The user for which to group requests.</p>
<p>Flags: Read / Write</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="InfAdoptedUndoGrouping-group-requests"></a><h3>The <code class="literal">“group-requests”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
user_function (<a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> *grouping,
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *first,
<a class="link" href="InfAdoptedRequest.html" title="InfAdoptedRequest"><span class="type">InfAdoptedRequest</span></a> *second,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted whenever the <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> needs to
decide whether to put two requests into the same undo group or not.
A signal handler should return <code class="literal">TRUE</code> if they belong into the same group
or <code class="literal">FALSE</code> otherwise. Note however that the two requests may not
immediately follow each other because other users may have issued
requests inbetween. Check the vector times of the requests to find out,
using <a class="link" href="InfAdoptedRequest.html#inf-adopted-request-get-vector" title="inf_adopted_request_get_vector ()"><code class="function">inf_adopted_request_get_vector()</code></a>.</p>
<div class="refsect3">
<a name="id-1.4.5.14.2.5"></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>grouping</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfAdoptedUndoGrouping.html" title="InfAdoptedUndoGrouping"><span class="type">InfAdoptedUndoGrouping</span></a> which is about to group a request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>first</p></td>
<td class="parameter_description"><p>The previous request.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>second</p></td>
<td class="parameter_description"><p>The current request.</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>
<p>Flags: Run Last</p>
</div>
</div>
<div class="refsect1">
<a name="InfAdoptedUndoGrouping.see-also"></a><h2>See Also</h2>
<p><a class="link" href="InfAdoptedAlgorithm.html" title="InfAdoptedAlgorithm"><span class="type">InfAdoptedAlgorithm</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|