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
|
<?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="InfTextMoveOperation">
<refmeta>
<refentrytitle role="top_of_page" id="InfTextMoveOperation.top_of_page">InfTextMoveOperation</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBINFTEXT-0.4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>InfTextMoveOperation</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="InfTextMoveOperation.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="InfTextMoveOperation-struct">InfTextMoveOperation</link>;
<link linkend="InfTextMoveOperation">InfTextMoveOperation</link> * <link linkend="inf-text-move-operation-new">inf_text_move_operation_new</link> (<link linkend="guint">guint</link> position,
<link linkend="gint">gint</link> length);
<link linkend="guint">guint</link> <link linkend="inf-text-move-operation-get-position">inf_text_move_operation_get_position</link>
(<link linkend="InfTextMoveOperation">InfTextMoveOperation</link> *operation);
<link linkend="gint">gint</link> <link linkend="inf-text-move-operation-get-length">inf_text_move_operation_get_length</link> (<link linkend="InfTextMoveOperation">InfTextMoveOperation</link> *operation);
<link linkend="void">void</link> <link linkend="inf-text-move-operation-transform-insert">inf_text_move_operation_transform_insert</link>
(<link linkend="guint">guint</link> insert_position,
<link linkend="guint">guint</link> insert_length,
<link linkend="guint">guint</link> *move_position,
<link linkend="gint">gint</link> *move_length,
<link linkend="gboolean">gboolean</link> left_gravity);
<link linkend="void">void</link> <link linkend="inf-text-move-operation-transform-delete">inf_text_move_operation_transform_delete</link>
(<link linkend="guint">guint</link> delete_position,
<link linkend="guint">guint</link> delete_length,
<link linkend="guint">guint</link> *move_position,
<link linkend="gint">gint</link> *move_length);
</synopsis>
</refsynopsisdiv>
<refsect1 id="InfTextMoveOperation.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----InfTextMoveOperation
</synopsis>
</refsect1>
<refsect1 id="InfTextMoveOperation.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
InfTextMoveOperation implements
<link linkend="InfAdoptedOperation">InfAdoptedOperation</link>.</para>
</refsect1>
<refsect1 id="InfTextMoveOperation.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="InfTextMoveOperation--length">length</link>" <link linkend="gint">gint</link> : Read / Write / Construct Only
"<link linkend="InfTextMoveOperation--position">position</link>" <link linkend="guint">guint</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="InfTextMoveOperation.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="InfTextMoveOperation.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InfTextMoveOperation-struct" role="struct">
<title>InfTextMoveOperation</title>
<indexterm zone="InfTextMoveOperation-struct"><primary sortas="InfTextMoveOperation">InfTextMoveOperation</primary></indexterm><programlisting>typedef struct _InfTextMoveOperation InfTextMoveOperation;</programlisting>
<para>
</para></refsect2>
<refsect2 id="inf-text-move-operation-new" role="function">
<title>inf_text_move_operation_new ()</title>
<indexterm zone="inf-text-move-operation-new"><primary sortas="inf_text_move_operation_new">inf_text_move_operation_new</primary></indexterm><programlisting><link linkend="InfTextMoveOperation">InfTextMoveOperation</link> * inf_text_move_operation_new (<link linkend="guint">guint</link> position,
<link linkend="gint">gint</link> length);</programlisting>
<para>
Creates a new move operation that, when applied, changes the caret and
selection of the applying user.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> The position to place the user's caret at.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> The number of characters to select. Negative means selection
towards the beginning of the buffer.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="InfTextMoveOperation"><type>InfTextMoveOperation</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-move-operation-get-position" role="function">
<title>inf_text_move_operation_get_position ()</title>
<indexterm zone="inf-text-move-operation-get-position"><primary sortas="inf_text_move_operation_get_position">inf_text_move_operation_get_position</primary></indexterm><programlisting><link linkend="guint">guint</link> inf_text_move_operation_get_position
(<link linkend="InfTextMoveOperation">InfTextMoveOperation</link> *operation);</programlisting>
<para>
Returns the position at which <parameter>operation</parameter> places the user's cursor.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>operation</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextMoveOperation"><type>InfTextMoveOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The position of <parameter>operation</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-move-operation-get-length" role="function">
<title>inf_text_move_operation_get_length ()</title>
<indexterm zone="inf-text-move-operation-get-length"><primary sortas="inf_text_move_operation_get_length">inf_text_move_operation_get_length</primary></indexterm><programlisting><link linkend="gint">gint</link> inf_text_move_operation_get_length (<link linkend="InfTextMoveOperation">InfTextMoveOperation</link> *operation);</programlisting>
<para>
Returns the length to which <parameter>operation</parameter> changes the user's selection.
Negative means selection towards the beginning of the buffer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>operation</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextMoveOperation"><type>InfTextMoveOperation</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The length of <parameter>operation</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-move-operation-transform-insert" role="function">
<title>inf_text_move_operation_transform_insert ()</title>
<indexterm zone="inf-text-move-operation-transform-insert"><primary sortas="inf_text_move_operation_transform_insert">inf_text_move_operation_transform_insert</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_move_operation_transform_insert
(<link linkend="guint">guint</link> insert_position,
<link linkend="guint">guint</link> insert_length,
<link linkend="guint">guint</link> *move_position,
<link linkend="gint">gint</link> *move_length,
<link linkend="gboolean">gboolean</link> left_gravity);</programlisting>
<para>
Changes *<parameter>move_position</parameter> and *<parameter>move_length</parameter> so that they point to the same
region when <parameter>insert_length</parameter> characters are inserted at <parameter>insert_position</parameter>.
</para>
<para>
If text is inserted at the same position as <parameter>move_position</parameter>, then
<parameter>move_position</parameter> is kept at the position it currently is, otherwise it is
shifted to the right.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>insert_position</parameter> :</term>
<listitem><simpara> The position at which text is inserted.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>insert_length</parameter> :</term>
<listitem><simpara> The number of inserted characters.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>move_position</parameter> :</term>
<listitem><simpara> Points to the character offset to which the caret is moved.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>move_length</parameter> :</term>
<listitem><simpara> Points to the number of characters selected. Negative means
towards the beginning.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>left_gravity</parameter> :</term>
<listitem><simpara> Whether the move position and length have left gravity.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-move-operation-transform-delete" role="function">
<title>inf_text_move_operation_transform_delete ()</title>
<indexterm zone="inf-text-move-operation-transform-delete"><primary sortas="inf_text_move_operation_transform_delete">inf_text_move_operation_transform_delete</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_move_operation_transform_delete
(<link linkend="guint">guint</link> delete_position,
<link linkend="guint">guint</link> delete_length,
<link linkend="guint">guint</link> *move_position,
<link linkend="gint">gint</link> *move_length);</programlisting>
<para>
Changes *<parameter>move_position</parameter> and *<parameter>move_length</parameter> so that they point to the same
region when <parameter>delete_length</parameter> characters are deleted starting from
<parameter>delete_position</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>delete_position</parameter> :</term>
<listitem><simpara> The position at which text is deleted.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>delete_length</parameter> :</term>
<listitem><simpara> The number of deleted characters.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>move_position</parameter> :</term>
<listitem><simpara> Points to the character offset to which the caret is moved.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>move_length</parameter> :</term>
<listitem><simpara> Points to the number of characters selected. Negative means
towards the beginning.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="InfTextMoveOperation.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="InfTextMoveOperation--length" role="property"><title>The <literal>"length"</literal> property</title>
<indexterm zone="InfTextMoveOperation--length"><primary sortas="InfTextMoveOperation:length">InfTextMoveOperation:length</primary></indexterm><programlisting> "length" <link linkend="gint">gint</link> : Read / Write / Construct Only</programlisting>
<para>The number of characters of the selected text.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="InfTextMoveOperation--position" role="property"><title>The <literal>"position"</literal> property</title>
<indexterm zone="InfTextMoveOperation--position"><primary sortas="InfTextMoveOperation:position">InfTextMoveOperation:position</primary></indexterm><programlisting> "position" <link linkend="guint">guint</link> : Read / Write / Construct Only</programlisting>
<para>Position where to place the user's caret at.</para><para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|
