File: inf-text-insert-operation.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 (197 lines) | stat: -rw-r--r-- 13,841 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
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
<?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="libinftext-04-inf-text-insert-operation">
<refmeta>
<refentrytitle role="top_of_page" id="libinftext-04-inf-text-insert-operation.top_of_page">inf-text-insert-operation</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBINFTEXT-0.4 Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>inf-text-insert-operation</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="libinftext-04-inf-text-insert-operation.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="InfTextInsertOperationIface">InfTextInsertOperationIface</link>;
<link linkend="guint">guint</link>               <link linkend="inf-text-insert-operation-get-position">inf_text_insert_operation_get_position</link>
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation);
<link linkend="guint">guint</link>               <link linkend="inf-text-insert-operation-get-length">inf_text_insert_operation_get_length</link>
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation);
<link linkend="gboolean">gboolean</link>            <link linkend="inf-text-insert-operation-need-concurrency-id">inf_text_insert_operation_need_concurrency_id</link>
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *op,
                                                         <link linkend="InfAdoptedOperation">InfAdoptedOperation</link> *against);
<link linkend="InfAdoptedConcurrencyId">InfAdoptedConcurrencyId</link>  <link linkend="inf-text-insert-operation-get-concurrency-id">inf_text_insert_operation_get_concurrency_id</link>
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *op,
                                                         <link linkend="InfAdoptedOperation">InfAdoptedOperation</link> *against);
<link linkend="InfAdoptedOperation">InfAdoptedOperation</link> * <link linkend="inf-text-insert-operation-transform-insert">inf_text_insert_operation_transform_insert</link>
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation,
                                                         <link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *against,
                                                         <link linkend="InfAdoptedConcurrencyId">InfAdoptedConcurrencyId</link> cid);
<link linkend="InfAdoptedOperation">InfAdoptedOperation</link> * <link linkend="inf-text-insert-operation-transform-delete">inf_text_insert_operation_transform_delete</link>
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation,
                                                         <link linkend="InfTextDeleteOperation">InfTextDeleteOperation</link> *against,
                                                         <link linkend="InfAdoptedConcurrencyId">InfAdoptedConcurrencyId</link> cid);
</synopsis>
</refsynopsisdiv>









<refsect1 id="libinftext-04-inf-text-insert-operation.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="libinftext-04-inf-text-insert-operation.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InfTextInsertOperationIface" role="struct">
<title>InfTextInsertOperationIface</title>
<indexterm zone="InfTextInsertOperationIface"><primary sortas="InfTextInsertOperationIface">InfTextInsertOperationIface</primary></indexterm><programlisting>typedef struct {
  GTypeInterface parent;

  /* Virtual table */
  guint(*get_position)(InfTextInsertOperation* operation);

  guint(*get_length)(InfTextInsertOperation* operation);

  InfTextInsertOperation*(*transform_position)(InfTextInsertOperation* op,
                                               guint position);
} InfTextInsertOperationIface;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="inf-text-insert-operation-get-position" role="function">
<title>inf_text_insert_operation_get_position ()</title>
<indexterm zone="inf-text-insert-operation-get-position"><primary sortas="inf_text_insert_operation_get_position">inf_text_insert_operation_get_position</primary></indexterm><programlisting><link linkend="guint">guint</link>               inf_text_insert_operation_get_position
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation);</programlisting>
<para>
Returns the position at which <parameter>operation</parameter> inserts text.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>operation</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The position to insert text.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-insert-operation-get-length" role="function">
<title>inf_text_insert_operation_get_length ()</title>
<indexterm zone="inf-text-insert-operation-get-length"><primary sortas="inf_text_insert_operation_get_length">inf_text_insert_operation_get_length</primary></indexterm><programlisting><link linkend="guint">guint</link>               inf_text_insert_operation_get_length
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation);</programlisting>
<para>
Returns the length of the text inserted by <parameter>operation</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>operation</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The length of <parameter>operation</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-insert-operation-need-concurrency-id" role="function">
<title>inf_text_insert_operation_need_concurrency_id ()</title>
<indexterm zone="inf-text-insert-operation-need-concurrency-id"><primary sortas="inf_text_insert_operation_need_concurrency_id">inf_text_insert_operation_need_concurrency_id</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            inf_text_insert_operation_need_concurrency_id
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *op,
                                                         <link linkend="InfAdoptedOperation">InfAdoptedOperation</link> *against);</programlisting>
<para>
Returns whether transforming <parameter>op</parameter> against <parameter>against</parameter> requires a concurrency ID
(see <link linkend="inf-adopted-operation-need-concurrency-id"><function>inf_adopted_operation_need_concurrency_id()</function></link> for further information).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>op</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>against</parameter>&#160;:</term>
<listitem><simpara> Another <link linkend="InfAdoptedOperation"><type>InfAdoptedOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Whether transforming <parameter>op</parameter> against <parameter>against</parameter> requires a concurrency
ID.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-insert-operation-get-concurrency-id" role="function">
<title>inf_text_insert_operation_get_concurrency_id ()</title>
<indexterm zone="inf-text-insert-operation-get-concurrency-id"><primary sortas="inf_text_insert_operation_get_concurrency_id">inf_text_insert_operation_get_concurrency_id</primary></indexterm><programlisting><link linkend="InfAdoptedConcurrencyId">InfAdoptedConcurrencyId</link>  inf_text_insert_operation_get_concurrency_id
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *op,
                                                         <link linkend="InfAdoptedOperation">InfAdoptedOperation</link> *against);</programlisting>
<para>
Returns a concurrency ID for transformation of <parameter>op</parameter> against <parameter>against</parameter>
(see <link linkend="inf-adopted-operation-get-concurrency-id"><function>inf_adopted_operation_get_concurrency_id()</function></link> for further information).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>op</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>against</parameter>&#160;:</term>
<listitem><simpara> Another <link linkend="InfAdoptedOperation"><type>InfAdoptedOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A concurrency ID between <parameter>op</parameter> and <parameter>against</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-insert-operation-transform-insert" role="function">
<title>inf_text_insert_operation_transform_insert ()</title>
<indexterm zone="inf-text-insert-operation-transform-insert"><primary sortas="inf_text_insert_operation_transform_insert">inf_text_insert_operation_transform_insert</primary></indexterm><programlisting><link linkend="InfAdoptedOperation">InfAdoptedOperation</link> * inf_text_insert_operation_transform_insert
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation,
                                                         <link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *against,
                                                         <link linkend="InfAdoptedConcurrencyId">InfAdoptedConcurrencyId</link> cid);</programlisting>
<para>
Returns a new operation that includes the effect of <parameter>against</parameter> into
<parameter>operation</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>operation</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>against</parameter>&#160;:</term>
<listitem><simpara> Another <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cid</parameter>&#160;:</term>
<listitem><simpara> The concurrency ID for the transformation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="InfAdoptedOperation"><type>InfAdoptedOperation</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-insert-operation-transform-delete" role="function">
<title>inf_text_insert_operation_transform_delete ()</title>
<indexterm zone="inf-text-insert-operation-transform-delete"><primary sortas="inf_text_insert_operation_transform_delete">inf_text_insert_operation_transform_delete</primary></indexterm><programlisting><link linkend="InfAdoptedOperation">InfAdoptedOperation</link> * inf_text_insert_operation_transform_delete
                                                        (<link linkend="InfTextInsertOperation">InfTextInsertOperation</link> *operation,
                                                         <link linkend="InfTextDeleteOperation">InfTextDeleteOperation</link> *against,
                                                         <link linkend="InfAdoptedConcurrencyId">InfAdoptedConcurrencyId</link> cid);</programlisting>
<para>
Returns a new operation that includes the effect of <parameter>against</parameter> into
<parameter>operation</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>operation</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextInsertOperation"><type>InfTextInsertOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>against</parameter>&#160;:</term>
<listitem><simpara> A <link linkend="InfTextDeleteOperation"><type>InfTextDeleteOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cid</parameter>&#160;:</term>
<listitem><simpara> The concurrency ID for the transformation.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A new <link linkend="InfAdoptedOperation"><type>InfAdoptedOperation</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>