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
|
<?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="InfTextUser">
<refmeta>
<refentrytitle role="top_of_page" id="InfTextUser.top_of_page">InfTextUser</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBINFTEXT-0.4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>InfTextUser</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="InfTextUser.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="InfTextUser-struct">InfTextUser</link>;
<link linkend="guint">guint</link> <link linkend="inf-text-user-get-caret-position">inf_text_user_get_caret_position</link> (<link linkend="InfTextUser">InfTextUser</link> *user);
<link linkend="gint">gint</link> <link linkend="inf-text-user-get-selection-length">inf_text_user_get_selection_length</link> (<link linkend="InfTextUser">InfTextUser</link> *user);
<link linkend="void">void</link> <link linkend="inf-text-user-set-selection">inf_text_user_set_selection</link> (<link linkend="InfTextUser">InfTextUser</link> *user,
<link linkend="guint">guint</link> position,
<link linkend="gint">gint</link> length);
<link linkend="gdouble">gdouble</link> <link linkend="inf-text-user-get-hue">inf_text_user_get_hue</link> (<link linkend="InfTextUser">InfTextUser</link> *user);
</synopsis>
</refsynopsisdiv>
<refsect1 id="InfTextUser.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="InfUser">InfUser</link>
+----<link linkend="InfAdoptedUser">InfAdoptedUser</link>
+----InfTextUser
</synopsis>
</refsect1>
<refsect1 id="InfTextUser.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="InfTextUser--caret-position">caret-position</link>" <link linkend="guint">guint</link> : Read / Write / Construct
"<link linkend="InfTextUser--hue">hue</link>" <link linkend="gdouble">gdouble</link> : Read / Write / Construct
"<link linkend="InfTextUser--selection-length">selection-length</link>" <link linkend="gint">gint</link> : Read / Write / Construct
</synopsis>
</refsect1>
<refsect1 id="InfTextUser.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="InfTextUser-selection-changed">selection-changed</link>" : Run Last
</synopsis>
</refsect1>
<refsect1 id="InfTextUser.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="InfTextUser.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="InfTextUser-struct" role="struct">
<title>InfTextUser</title>
<indexterm zone="InfTextUser-struct"><primary sortas="InfTextUser">InfTextUser</primary></indexterm><programlisting>typedef struct _InfTextUser InfTextUser;</programlisting>
<para>
</para></refsect2>
<refsect2 id="inf-text-user-get-caret-position" role="function">
<title>inf_text_user_get_caret_position ()</title>
<indexterm zone="inf-text-user-get-caret-position"><primary sortas="inf_text_user_get_caret_position">inf_text_user_get_caret_position</primary></indexterm><programlisting><link linkend="guint">guint</link> inf_text_user_get_caret_position (<link linkend="InfTextUser">InfTextUser</link> *user);</programlisting>
<para>
Returns the position of <parameter>user</parameter>'s caret.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextUser"><type>InfTextUser</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>user</parameter>'s caret position.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-user-get-selection-length" role="function">
<title>inf_text_user_get_selection_length ()</title>
<indexterm zone="inf-text-user-get-selection-length"><primary sortas="inf_text_user_get_selection_length">inf_text_user_get_selection_length</primary></indexterm><programlisting><link linkend="gint">gint</link> inf_text_user_get_selection_length (<link linkend="InfTextUser">InfTextUser</link> *user);</programlisting>
<para>
Returns the number of characters this user has selected, starting from
the caret position. Negative number mean selection towards the beginning
of the buffer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextUser"><type>InfTextUser</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <parameter>user</parameter>'s selection length in characters.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-user-set-selection" role="function">
<title>inf_text_user_set_selection ()</title>
<indexterm zone="inf-text-user-set-selection"><primary sortas="inf_text_user_set_selection">inf_text_user_set_selection</primary></indexterm><programlisting><link linkend="void">void</link> inf_text_user_set_selection (<link linkend="InfTextUser">InfTextUser</link> *user,
<link linkend="guint">guint</link> position,
<link linkend="gint">gint</link> length);</programlisting>
<para>
Changes <parameter>user</parameter>'s selection (i.e. caret position and selection length).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextUser"><type>InfTextUser</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>position</parameter> :</term>
<listitem><simpara> The new position for the user's caret.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> The number of characters to select. Negative numbers mean
selection towards the beginning.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="inf-text-user-get-hue" role="function">
<title>inf_text_user_get_hue ()</title>
<indexterm zone="inf-text-user-get-hue"><primary sortas="inf_text_user_get_hue">inf_text_user_get_hue</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> inf_text_user_get_hue (<link linkend="InfTextUser">InfTextUser</link> *user);</programlisting>
<para>
Returns the hue of the user's color as a double ranging from 0 to 1.
The other components (saturation and lightness) are not specific to the
user and may be chosen indivudually to optimize the actual visual display.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> A <link linkend="InfTextUser"><type>InfTextUser</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The hue of the <parameter>user</parameter>'s color.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="InfTextUser.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="InfTextUser--caret-position" role="property"><title>The <literal>"caret-position"</literal> property</title>
<indexterm zone="InfTextUser--caret-position"><primary sortas="InfTextUser:caret-position">InfTextUser:caret-position</primary></indexterm><programlisting> "caret-position" <link linkend="guint">guint</link> : Read / Write / Construct</programlisting>
<para>The position of this user's caret.</para><para>Default value: 0</para>
</refsect2>
<refsect2 id="InfTextUser--hue" role="property"><title>The <literal>"hue"</literal> property</title>
<indexterm zone="InfTextUser--hue"><primary sortas="InfTextUser:hue">InfTextUser:hue</primary></indexterm><programlisting> "hue" <link linkend="gdouble">gdouble</link> : Read / Write / Construct</programlisting>
<para>The hue value of the user's color. saturation and lightness are set by each client individually.</para><para>Allowed values: [0,1]</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="InfTextUser--selection-length" role="property"><title>The <literal>"selection-length"</literal> property</title>
<indexterm zone="InfTextUser--selection-length"><primary sortas="InfTextUser:selection-length">InfTextUser:selection-length</primary></indexterm><programlisting> "selection-length" <link linkend="gint">gint</link> : Read / Write / Construct</programlisting>
<para>The number of characters of this user's selection.</para><para>Default value: 0</para>
</refsect2>
</refsect1>
<refsect1 id="InfTextUser.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="InfTextUser-selection-changed" role="signal"><title>The <literal>"selection-changed"</literal> signal</title>
<indexterm zone="InfTextUser-selection-changed"><primary sortas="InfTextUser::selection-changed">InfTextUser::selection-changed</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="InfTextUser">InfTextUser</link> *inftextuser,
<link linkend="guint">guint</link> arg1,
<link linkend="gint">gint</link> arg2,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>inftextuser</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg1</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>arg2</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
