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
|
<?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="InfTextRemoteDeleteOperation">
<refmeta>
<refentrytitle role="top_of_page" id="InfTextRemoteDeleteOperation.top_of_page">InfTextRemoteDeleteOperation</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBINFTEXT-0.4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>InfTextRemoteDeleteOperation</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="InfTextRemoteDeleteOperation.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="InfTextRemoteDeleteOperation-struct">InfTextRemoteDeleteOperation</link>;
<link linkend="InfTextRemoteDeleteOperation">InfTextRemoteDeleteOperation</link> * <link linkend="inf-text-remote-delete-operation-new">inf_text_remote_delete_operation_new</link>
(<link linkend="guint">guint</link> position,
<link linkend="guint">guint</link> length);
</synopsis>
</refsynopsisdiv>
<refsect1 id="InfTextRemoteDeleteOperation.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----InfTextRemoteDeleteOperation
</synopsis>
</refsect1>
<refsect1 id="InfTextRemoteDeleteOperation.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
InfTextRemoteDeleteOperation implements
<link linkend="InfTextDeleteOperation">InfTextDeleteOperation</link> and <link linkend="InfAdoptedOperation">InfAdoptedOperation</link>.</para>
</refsect1>
<refsect1 id="InfTextRemoteDeleteOperation.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="InfTextRemoteDeleteOperation--length">length</link>" <link linkend="guint">guint</link> : Read / Write / Construct Only
"<link linkend="InfTextRemoteDeleteOperation--position">position</link>" <link linkend="guint">guint</link> : Read / Write / Construct Only
</synopsis>
</refsect1>
<refsect1 id="InfTextRemoteDeleteOperation.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="InfTextRemoteDeleteOperation.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InfTextRemoteDeleteOperation-struct" role="struct">
<title>InfTextRemoteDeleteOperation</title>
<indexterm zone="InfTextRemoteDeleteOperation-struct"><primary sortas="InfTextRemoteDeleteOperation">InfTextRemoteDeleteOperation</primary></indexterm><programlisting>typedef struct _InfTextRemoteDeleteOperation InfTextRemoteDeleteOperation;</programlisting>
<para>
</para></refsect2>
<refsect2 id="inf-text-remote-delete-operation-new" role="function">
<title>inf_text_remote_delete_operation_new ()</title>
<indexterm zone="inf-text-remote-delete-operation-new"><primary sortas="inf_text_remote_delete_operation_new">inf_text_remote_delete_operation_new</primary></indexterm><programlisting><link linkend="InfTextRemoteDeleteOperation">InfTextRemoteDeleteOperation</link> * inf_text_remote_delete_operation_new
(<link linkend="guint">guint</link> position,
<link linkend="guint">guint</link> length);</programlisting>
<para>
Creates a new delete operation that, when applied, deletes <parameter>length</parameter>
characters starting from position <parameter>position</parameter>. Note that this operation is
not reversible because it does not know the text to delete and is therefore
only used to transmit a delete operation through the network to reduce
bandwidth usage. The other part can then reconstruct the deleted text
using the make_reversible vfunc.
</para>
<para>
However, it is easier to just use <link linkend="InfTextDefaultDeleteOperation"><type>InfTextDefaultDeleteOperation</type></link> if you
want the operation to be reversible.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> The position at which to delete text.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> The number of characters to delete.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="InfTextRemoteDeleteOperation"><type>InfTextRemoteDeleteOperation</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="InfTextRemoteDeleteOperation.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="InfTextRemoteDeleteOperation--length" role="property"><title>The <literal>"length"</literal> property</title>
<indexterm zone="InfTextRemoteDeleteOperation--length"><primary sortas="InfTextRemoteDeleteOperation:length">InfTextRemoteDeleteOperation:length</primary></indexterm><programlisting> "length" <link linkend="guint">guint</link> : Read / Write / Construct Only</programlisting>
<para>The length of the deleted text.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="InfTextRemoteDeleteOperation--position" role="property"><title>The <literal>"position"</literal> property</title>
<indexterm zone="InfTextRemoteDeleteOperation--position"><primary sortas="InfTextRemoteDeleteOperation:position">InfTextRemoteDeleteOperation:position</primary></indexterm><programlisting> "position" <link linkend="guint">guint</link> : Read / Write / Construct Only</programlisting>
<para>Position where to start deleting characters.</para><para>Default value: 0</para>
</refsect2>
</refsect1>
</refentry>
|
