← Back to branch summary

~ubuntu-branches/ubuntu/vivid/libinfinity/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/libinftext/html/InfTextUser.html

  • Committer: Bazaar Package Importer
  • Author(s): Philipp Kern
  • Date: 2011-08-05 20:09:57 UTC
  • mfrom: (1.1.5 upstream)
  • Revision ID: james.westby@ubuntu.com-20110805200957-wpk147f6xnwnkhj8
Tags: 0.5.1-1
New upstream bugfix release, which fixes a crash in infinoted.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libinftext/html/InfTextUser.html
44
44
<div class="refsynopsisdiv">
45
45
<a name="InfTextUser.synopsis"></a><h2>Synopsis</h2>
46
46
<pre class="synopsis">                    <a class="link" href="InfTextUser.html#InfTextUser-struct" title="InfTextUser">InfTextUser</a>;
47
 
<a class="link" href="InfTextUser.html" title="InfTextUser"><span class="returnvalue">InfTextUser</span></a> *       <a class="link" href="InfTextUser.html#inf-text-user-new" title="inf_text_user_new ()">inf_text_user_new</a>                   (<em class="parameter"><code><span class="type">guint</span> id</code></em>,
48
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
49
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfAdoptedStateVector.html"><span class="type">InfAdoptedStateVector</span></a> *vector</code></em>,
 
47
<a class="link" href="InfTextUser.html" title="InfTextUser"><span class="returnvalue">InfTextUser</span></a> *       <a class="link" href="InfTextUser.html#inf-text-user-new" title="inf_text_user_new ()">inf_text_user_new</a>                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
48
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
49
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfAdoptedStateVector.html"><span class="type">InfAdoptedStateVector</span></a> *vector</code></em>,
50
50
                                                         <em class="parameter"><code><span class="type">double</span> hue</code></em>);
51
 
<span class="returnvalue">guint</span>               <a class="link" href="InfTextUser.html#inf-text-user-get-caret-position" title="inf_text_user_get_caret_position ()">inf_text_user_get_caret_position</a>    (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
52
 
<span class="returnvalue">gint</span>                <a class="link" href="InfTextUser.html#inf-text-user-get-selection-length" title="inf_text_user_get_selection_length ()">inf_text_user_get_selection_length</a>  (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
 
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               <a class="link" href="InfTextUser.html#inf-text-user-get-caret-position" title="inf_text_user_get_caret_position ()">inf_text_user_get_caret_position</a>    (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
 
52
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="InfTextUser.html#inf-text-user-get-selection-length" title="inf_text_user_get_selection_length ()">inf_text_user_get_selection_length</a>  (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="InfTextUser.html#inf-text-user-set-selection" title="inf_text_user_set_selection ()">inf_text_user_set_selection</a>         (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>,
54
 
                                                         <em class="parameter"><code><span class="type">guint</span> position</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">gint</span> length</code></em>,
56
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> by_request</code></em>);
57
 
<span class="returnvalue">gdouble</span>             <a class="link" href="InfTextUser.html#inf-text-user-get-hue" title="inf_text_user_get_hue ()">inf_text_user_get_hue</a>               (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
 
54
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> position</code></em>,
 
55
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> length</code></em>,
 
56
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> by_request</code></em>);
 
57
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             <a class="link" href="InfTextUser.html#inf-text-user-get-hue" title="inf_text_user_get_hue ()">inf_text_user_get_hue</a>               (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);
58
58
</pre>
59
59
</div>
60
60
<div class="refsect1">
61
61
<a name="InfTextUser.object-hierarchy"></a><h2>Object Hierarchy</h2>
62
62
<pre class="synopsis">
63
 
  GObject
64
 
   +----<a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUser.html">InfUser</a>
65
 
         +----<a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfAdoptedUser.html">InfAdoptedUser</a>
 
63
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
64
   +----<a href="../libinfinity-0.5/InfUser.html">InfUser</a>
 
65
         +----<a href="../libinfinity-0.5/InfAdoptedUser.html">InfAdoptedUser</a>
66
66
               +----InfTextUser
67
67
</pre>
68
68
</div>
69
69
<div class="refsect1">
70
70
<a name="InfTextUser.properties"></a><h2>Properties</h2>
71
71
<pre class="synopsis">
72
 
  "<a class="link" href="InfTextUser.html#InfTextUser--caret-position" title='The "caret-position" property'>caret-position</a>"           <span class="type">guint</span>                 : Read / Write / Construct
73
 
  "<a class="link" href="InfTextUser.html#InfTextUser--hue" title='The "hue" property'>hue</a>"                      <span class="type">gdouble</span>               : Read / Write / Construct
74
 
  "<a class="link" href="InfTextUser.html#InfTextUser--selection-length" title='The "selection-length" property'>selection-length</a>"         <span class="type">gint</span>                  : Read / Write / Construct
 
72
  "<a class="link" href="InfTextUser.html#InfTextUser--caret-position" title='The "caret-position" property'>caret-position</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
 
73
  "<a class="link" href="InfTextUser.html#InfTextUser--hue" title='The "hue" property'>hue</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write / Construct
 
74
  "<a class="link" href="InfTextUser.html#InfTextUser--selection-length" title='The "selection-length" property'>selection-length</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
75
75
</pre>
76
76
</div>
77
77
<div class="refsect1">
78
78
<a name="InfTextUser.signals"></a><h2>Signals</h2>
79
79
<pre class="synopsis">
80
 
  "<a class="link" href="InfTextUser.html#InfTextUser-selection-changed" title='The "selection-changed" signal'>selection-changed</a>"                              : <code class="literal">Run Last</code>
 
80
  "<a class="link" href="InfTextUser.html#InfTextUser-selection-changed" title='The "selection-changed" signal'>selection-changed</a>"                              : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
81
81
</pre>
82
82
</div>
83
83
<div class="refsect1">
96
96
<hr>
97
97
<div class="refsect2">
98
98
<a name="inf-text-user-new"></a><h3>inf_text_user_new ()</h3>
99
 
<pre class="programlisting"><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="returnvalue">InfTextUser</span></a> *       inf_text_user_new                   (<em class="parameter"><code><span class="type">guint</span> id</code></em>,
100
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>,
101
 
                                                         <em class="parameter"><code><a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfAdoptedStateVector.html"><span class="type">InfAdoptedStateVector</span></a> *vector</code></em>,
 
99
<pre class="programlisting"><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="returnvalue">InfTextUser</span></a> *       inf_text_user_new                   (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> id</code></em>,
 
100
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>,
 
101
                                                         <em class="parameter"><code><a href="../libinfinity-0.5/InfAdoptedStateVector.html"><span class="type">InfAdoptedStateVector</span></a> *vector</code></em>,
102
102
                                                         <em class="parameter"><code><span class="type">double</span> hue</code></em>);</pre>
103
103
<p>
104
104
Creates a new <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>. <em class="parameter"><code>id</code></em> should be unique for all users working
105
 
together. <a href="http://infinote.0x539.de/libinfinity/API/libinfinity/InfUserTable.html"><span class="type">InfUserTable</span></a> will refuse to add users with duplicate id. If
106
 
<em class="parameter"><code>vector</code></em> is <code class="literal">NULL</code>, then the vector with all components zero is used.
 
105
together. <a href="../libinfinity-0.5/InfUserTable.html"><span class="type">InfUserTable</span></a> will refuse to add users with duplicate id. If
 
106
<em class="parameter"><code>vector</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the vector with all components zero is used.
107
107
</p>
108
108
<div class="variablelist"><table border="0">
109
109
<col align="left" valign="top">
118
118
</tr>
119
119
<tr>
120
120
<td><p><span class="term"><em class="parameter"><code>vector</code></em> :</span></p></td>
121
 
<td>The state at which the user is at, or <code class="literal">NULL</code>.</td>
 
121
<td>The state at which the user is at, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</td>
122
122
</tr>
123
123
<tr>
124
124
<td><p><span class="term"><em class="parameter"><code>hue</code></em> :</span></p></td>
126
126
</tr>
127
127
<tr>
128
128
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
129
 
<td>A new <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>. Free with <code class="function">g_object_unref()</code> when no longer
 
129
<td>A new <a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a>. Free with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer
130
130
needed.</td>
131
131
</tr>
132
132
</tbody>
135
135
<hr>
136
136
<div class="refsect2">
137
137
<a name="inf-text-user-get-caret-position"></a><h3>inf_text_user_get_caret_position ()</h3>
138
 
<pre class="programlisting"><span class="returnvalue">guint</span>               inf_text_user_get_caret_position    (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
 
138
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>               inf_text_user_get_caret_position    (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
139
139
<p>
140
140
Returns the position of <em class="parameter"><code>user</code></em>'s caret.
141
141
</p>
157
157
<hr>
158
158
<div class="refsect2">
159
159
<a name="inf-text-user-get-selection-length"></a><h3>inf_text_user_get_selection_length ()</h3>
160
 
<pre class="programlisting"><span class="returnvalue">gint</span>                inf_text_user_get_selection_length  (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
 
160
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                inf_text_user_get_selection_length  (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
161
161
<p>
162
162
Returns the number of characters this user has selected, starting from
163
163
the caret position. Negative number mean selection towards the beginning
182
182
<div class="refsect2">
183
183
<a name="inf-text-user-set-selection"></a><h3>inf_text_user_set_selection ()</h3>
184
184
<pre class="programlisting"><span class="returnvalue">void</span>                inf_text_user_set_selection         (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>,
185
 
                                                         <em class="parameter"><code><span class="type">guint</span> position</code></em>,
186
 
                                                         <em class="parameter"><code><span class="type">gint</span> length</code></em>,
187
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> by_request</code></em>);</pre>
 
185
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> position</code></em>,
 
186
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> length</code></em>,
 
187
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> by_request</code></em>);</pre>
188
188
<p>
189
189
Changes <em class="parameter"><code>user</code></em>'s selection (i.e. caret position and selection length).
190
190
</p>
210
210
<hr>
211
211
<div class="refsect2">
212
212
<a name="inf-text-user-get-hue"></a><h3>inf_text_user_get_hue ()</h3>
213
 
<pre class="programlisting"><span class="returnvalue">gdouble</span>             inf_text_user_get_hue               (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
 
213
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="returnvalue">gdouble</span></a>             inf_text_user_get_hue               (<em class="parameter"><code><a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *user</code></em>);</pre>
214
214
<p>
215
215
Returns the hue of the user's color as a double ranging from 0 to 1.
216
216
The other components (saturation and lightness) are not specific to the
235
235
<a name="InfTextUser.property-details"></a><h2>Property Details</h2>
236
236
<div class="refsect2">
237
237
<a name="InfTextUser--caret-position"></a><h3>The <code class="literal">"caret-position"</code> property</h3>
238
 
<pre class="programlisting">  "caret-position"           <span class="type">guint</span>                 : Read / Write / Construct</pre>
 
238
<pre class="programlisting">  "caret-position"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
239
239
<p>The position of this user's caret.</p>
240
240
<p>Default value: 0</p>
241
241
</div>
242
242
<hr>
243
243
<div class="refsect2">
244
244
<a name="InfTextUser--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
245
 
<pre class="programlisting">  "hue"                      <span class="type">gdouble</span>               : Read / Write / Construct</pre>
 
245
<pre class="programlisting">  "hue"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write / Construct</pre>
246
246
<p>The hue value of the user's color. saturation and lightness are set by each client individually.</p>
247
247
<p>Allowed values: [0,1]</p>
248
248
<p>Default value: 0</p>
250
250
<hr>
251
251
<div class="refsect2">
252
252
<a name="InfTextUser--selection-length"></a><h3>The <code class="literal">"selection-length"</code> property</h3>
253
 
<pre class="programlisting">  "selection-length"         <span class="type">gint</span>                  : Read / Write / Construct</pre>
 
253
<pre class="programlisting">  "selection-length"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
254
254
<p>The number of characters of this user's selection.</p>
255
255
<p>Default value: 0</p>
256
256
</div>
260
260
<div class="refsect2">
261
261
<a name="InfTextUser-selection-changed"></a><h3>The <code class="literal">"selection-changed"</code> signal</h3>
262
262
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="InfTextUser.html" title="InfTextUser"><span class="type">InfTextUser</span></a> *inftextuser,
263
 
                                                        <span class="type">guint</span>        arg1,
264
 
                                                        <span class="type">gint</span>         arg2,
265
 
                                                        <span class="type">gboolean</span>     arg3,
266
 
                                                        <span class="type">gpointer</span>     user_data)        : <code class="literal">Run Last</code></pre>
 
263
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>        arg1,
 
264
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>         arg2,
 
265
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>     arg3,
 
266
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>     user_data)        : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
267
267
<p>
268
268
</p>
269
269
<div class="variablelist"><table border="0">