File: inf-text-undo-grouping.xml

package info (click to toggle)
libinfinity 0.4.1-4
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 12,332 kB
  • ctags: 7,384
  • sloc: ansic: 65,073; xml: 36,770; sh: 10,347; makefile: 728
file content (93 lines) | stat: -rw-r--r-- 3,629 bytes parent folder | download
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
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY version SYSTEM "../version.xml">
  <!ENTITY api_version SYSTEM "../api_version.xml">
]>

<refentry id="InfTextUndoGrouping">
<refmeta>
<refentrytitle role="top_of_page" id="InfTextUndoGrouping.top_of_page">InfTextUndoGrouping</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBINFTEXT-0.4 Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>InfTextUndoGrouping</refname>
<refpurpose>Undo grouping for text operations</refpurpose>
</refnamediv>

<refsynopsisdiv id="InfTextUndoGrouping.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;libinftext/inf-text-undo-grouping.h&gt;

                    <link linkend="InfTextUndoGrouping-struct">InfTextUndoGrouping</link>;
<link linkend="InfTextUndoGrouping">InfTextUndoGrouping</link> * <link linkend="inf-text-undo-grouping-new">inf_text_undo_grouping_new</link>        (void);
</synopsis>
</refsynopsisdiv>

<refsect1 id="InfTextUndoGrouping.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="InfAdoptedUndoGrouping">InfAdoptedUndoGrouping</link>
         +----InfTextUndoGrouping
</synopsis>
</refsect1>








<refsect1 id="InfTextUndoGrouping.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="InfTextUndoGrouping"><type>InfTextUndoGrouping</type></link> handles undo grouping for text operations. It makes
sure many insert or delete operations occuring in a row can be undone
simultaneousely, taking into account that other users might have issued
requests inbetween.
</para>
<para>
Using this class you don't need to connect to
<link linkend="InfAdoptedUndoGrouping-group-requests"><type>"group-requests"</type></link> to perform the grouping./</para>
<para>
</para>
</refsect1>

<refsect1 id="InfTextUndoGrouping.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InfTextUndoGrouping-struct" role="struct">
<title>InfTextUndoGrouping</title>
<indexterm zone="InfTextUndoGrouping-struct"><primary sortas="InfTextUndoGrouping">InfTextUndoGrouping</primary></indexterm><programlisting>typedef struct _InfTextUndoGrouping InfTextUndoGrouping;</programlisting>
<para>
<link linkend="InfTextUndoGrouping"><type>InfTextUndoGrouping</type></link> is an opaque data type. You should only access it via
the public API functions.</para>
<para>
</para></refsect2>
<refsect2 id="inf-text-undo-grouping-new" role="function">
<title>inf_text_undo_grouping_new ()</title>
<indexterm zone="inf-text-undo-grouping-new"><primary sortas="inf_text_undo_grouping_new">inf_text_undo_grouping_new</primary></indexterm><programlisting><link linkend="InfTextUndoGrouping">InfTextUndoGrouping</link> * inf_text_undo_grouping_new        (void);</programlisting>
<para>
Creates a new <link linkend="InfTextUndoGrouping"><type>InfTextUndoGrouping</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="InfTextUndoGrouping"><type>InfTextUndoGrouping</type></link>. To be freed with <link linkend="g-object-unref"><function>g_object_unref()</function></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1 id="InfTextUndoGrouping.see-also">
<title>See Also</title>
#InfAdoptedUndoGrouping
</refsect1>

</refentry>