Top | ![]() |
![]() |
![]() |
![]() |
guint | caret-position | Read / Write / Construct |
gdouble | hue | Read / Write / Construct |
gint | selection-length | Read / Write / Construct |
InfTextUser * inf_text_user_new (guint id
,const gchar *name
,InfAdoptedStateVector *vector
,double hue
);
Creates a new InfTextUser. id
should be unique for all users working
together. InfUserTable will refuse to add users with duplicate id. If
vector
is NULL
, then the vector with all components zero is used.
[constructor]
id |
The user ID for this user. |
|
name |
The user's name. |
|
vector |
The state at which the user is at, or |
[allow-none] |
hue |
The hue value of the user's color. |
guint
inf_text_user_get_caret_position (InfTextUser *user
);
Returns the position of user
's caret.
gint
inf_text_user_get_selection_length (InfTextUser *user
);
Returns the number of characters this user has selected, starting from the caret position. Negative number mean selection towards the beginning of the buffer.
void inf_text_user_set_selection (InfTextUser *user
,guint position
,gint length
,gboolean by_request
);
Changes user
's selection (i.e. caret position and selection length). The
by_request
parameter should be set to TRUE
if the selection change was
requested explicitly, for example by the user actively moving the cursor
using the mouse or the keyboard. If the cursor position changes only
because another user inserted text at a position before the user's cursor
and this results in a change of the selection position, the by_request
parameter should be set to FALSE
.
user |
A InfTextUser. |
|
position |
The new position for the user's caret. |
|
length |
The number of characters to select. Negative numbers mean selection towards the beginning. |
|
by_request |
|
gdouble
inf_text_user_get_hue (InfTextUser *user
);
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.
“caret-position”
property“caret-position” guint
The position of this user's caret.
Flags: Read / Write / Construct
Default value: 0
“hue”
property“hue” gdouble
The hue value of the user's color. saturation and lightness are set by each client individually.
Flags: Read / Write / Construct
Allowed values: [0,1]
Default value: 0
“selection-length”
property“selection-length” gint
The number of characters of this user's selection.
Flags: Read / Write / Construct
Default value: 0