![]() |
![]() |
![]() |
libinftextgtk-0.3 Reference Manual | ![]() |
---|---|---|---|---|
InfTextGtkBuffer; InfTextGtkBuffer* inf_text_gtk_buffer_new (GtkTextBuffer *buffer, InfUserTable *user_table); GtkTextBuffer* inf_text_gtk_buffer_get_text_buffer (InfTextGtkBuffer *buffer); void inf_text_gtk_buffer_set_active_user (InfTextGtkBuffer *buffer, InfTextUser *user); InfTextUser* inf_text_gtk_buffer_get_active_user (InfTextGtkBuffer *buffer); InfTextUser* inf_text_gtk_buffer_get_author (InfTextGtkBuffer *buffer, GtkTextIter *location); void inf_text_gtk_buffer_set_wake_on_cursor_movement (InfTextGtkBuffer *buffer, gboolean wake); gboolean inf_text_gtk_buffer_get_wake_on_cursor_movement (InfTextGtkBuffer *buffer); void inf_text_gtk_buffer_ensure_author_tags_priority (InfTextGtkBuffer *buffer);
"active-user" InfTextUser* : Read / Write "buffer" GtkTextBuffer* : Read / Write / Construct Only "user-table" InfUserTable* : Read / Write / Construct Only "wake-on-cursor-movement" gboolean : Read / Write
InfTextGtkBuffer* inf_text_gtk_buffer_new (GtkTextBuffer *buffer, InfUserTable *user_table);
Creates a new InfTextGtkBuffer wrapping buffer
. It implements the
InfTextBuffer interface by using buffer
to store the text. User colors
are read from the users from user_table
.
|
The underlaying GtkTextBuffer. |
|
The InfUserTable containing the participating users. |
Returns : |
A InfTextGtkBuffer. |
GtkTextBuffer* inf_text_gtk_buffer_get_text_buffer (InfTextGtkBuffer *buffer);
Returns the underlaying GtkTextBuffer.
|
A InfTextGtkBuffer. |
Returns : |
A GtkTextBuffer. |
void inf_text_gtk_buffer_set_active_user (InfTextGtkBuffer *buffer, InfTextUser *user);
Sets the active user for buffer
. The active user is the user by which
edits not issued through the InfTextBuffer interface are performed (for
example, edits by the user when the underlaying buffer is displayed in
a GtkTextView).
Note that such modifications should not be performed when no active user is
set. Note also the active user must be available and have the
INF_USER_LOCAL
flag set.
|
A InfTextGtkBuffer. |
|
A InfTextUser, or NULL .
|
InfTextUser* inf_text_gtk_buffer_get_active_user (InfTextGtkBuffer *buffer);
Returns the current active user for buffer
.
|
A InfTextGtkBuffer. |
Returns : |
A InfTextUser. |
InfTextUser* inf_text_gtk_buffer_get_author (InfTextGtkBuffer *buffer, GtkTextIter *location);
Returns the InfTextUser which wrote the character at location
. If there
is no such user, then NULL
is returned.
|
A InfTextGtkBuffer. |
|
A GtkTextIter which is not the end iterator. |
Returns : |
A InfTextUser, or NULL .
|
void inf_text_gtk_buffer_set_wake_on_cursor_movement (InfTextGtkBuffer *buffer, gboolean wake);
This function spcecifies whether movement of the insertion point or
selection bound of the underlying text buffer causes the active user
(see inf_text_gtk_buffer_set_active_user()
) to become active when its
status is INF_USER_STATUS_INACTIVE
.
If wake
is TRUE
, then the user status changes to INF_USER_STATUS_ACTIVE
in that case. If wake
is FALSE
, then the user status stays
INF_USER_STATUS_INACTIVE
, and its caret-position and selection-length
properties will be no longer be synchronized to the buffer marks until
the user is set active again.
|
A InfTextGtkBuffer. |
|
Whether to make inactive users active on cursor movement. |
gboolean inf_text_gtk_buffer_get_wake_on_cursor_movement (InfTextGtkBuffer *buffer);
Returns whether movement of the insertion point or selection bound of the
underlying text buffer causes whether the active user (see
inf_text_gtk_buffer_set_active_user()
) to become active when its status
is INF_USER_STATUS_INACTIVE
. See also
inf_text_gtk_buffer_set_wake_on_cursor_movement()
.
|
A InfTextGtkBuffer. |
Returns : |
Whether to make inactive users active when the insertion mark is moved. |
void inf_text_gtk_buffer_ensure_author_tags_priority (InfTextGtkBuffer *buffer);
Ensures that all author tags have the lowest priority of all tags in the underlying GtkTextBuffer's tag table. Normally you do not need to use this function if you do not set the priority for your tags explicitely. However, if you do (or are forced to do, because you are using a library that does this, such as GtkSourceView), then you can call this function afterwards to make sure all the user tags have the lowest priority.
|
A InfTextGtkBuffer. |
"active-user"
property"active-user" InfTextUser* : Read / Write
The user currently inserting text locally.
"buffer"
property"buffer" GtkTextBuffer* : Read / Write / Construct Only
The underlaying GtkTextBuffer.
"user-table"
property"user-table" InfUserTable* : Read / Write / Construct Only
A user table of the participating users.
"wake-on-cursor-movement"
property"wake-on-cursor-movement" gboolean : Read / Write
Whether to make inactive users active when the insertion mark in the TextBuffer moves.
Default value: FALSE