inf_text_gtk_buffer_new ()

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 .

[constructor]

inf_text_gtk_buffer_get_text_buffer ()

GtkTextBuffer *
inf_text_gtk_buffer_get_text_buffer (InfTextGtkBuffer *buffer);

Returns the underlaying GtkTextBuffer.

inf_text_gtk_buffer_set_active_user ()

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.

inf_text_gtk_buffer_get_active_user ()

InfTextUser *
inf_text_gtk_buffer_get_active_user (InfTextGtkBuffer *buffer);

Returns the current active user for buffer .

inf_text_gtk_buffer_get_author ()

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.

inf_text_gtk_buffer_get_user_for_tag ()

InfTextUser *
inf_text_gtk_buffer_get_user_for_tag (InfTextGtkBuffer *buffer,
                                      GtkTextTag *tag);

If tag is an author tag, i.e. used by buffer to mark text that a certain user has written, then this function returns the InfTextUser whose text is marked by tag . If tag is not an author tag then the function returns NULL.

inf_text_gtk_buffer_is_author_toggle ()

gboolean
inf_text_gtk_buffer_is_author_toggle (InfTextGtkBuffer *buffer,
                                      const GtkTextIter *iter,
                                      InfTextUser **user_on,
                                      InfTextUser **user_off);

This function returns TRUE if the author of the text in buffer changes at iter , or FALSE otherwise. If it returns TRUE, then the user who authored the text to the right hand side of iter is stored in user_on (if non-NULL) and the author of the text to the left hand side of iter is stored in user_off (if non-NULL). Both can also be set to NULL if there is unowned text in the buffer or if iter is at the start or end of the buffer.

inf_text_gtk_buffer_forward_to_author_toggle ()

gboolean
inf_text_gtk_buffer_forward_to_author_toggle
                               (InfTextGtkBuffer *buffer,
                                GtkTextIter *iter,
                                InfTextUser **user_on,
                                InfTextUser **user_off);

Moves iter to the next point in buffer 's underlying GtkTextBuffer where the text has been written by another user. If iter points to the end of the buffer, then the function does nothing and returns FALSE. Otherwise it returns TRUE and sets user_on to the user which has written the text on the right hand side of the location iter has been moved to (if non-NULL) and user_off to the user which has written the left hand side of the location iter has been moved to.

inf_text_gtk_buffer_backward_to_author_toggle ()

gboolean
inf_text_gtk_buffer_backward_to_author_toggle
                               (InfTextGtkBuffer *buffer,
                                GtkTextIter *iter,
                                InfTextUser **user_on,
                                InfTextUser **user_off);

Moves iter to the previous point in buffer 's underlying GtkTextBuffer where the text has been written by another user. If iter points to the beginning of the buffer, then the function does nothing and returns FALSE. Otherwise it returns TRUE and sets user_on to the user which has written the text on the right hand side of the location iter has been moved to (if non-NULL) and user_off to the user which has written the left hand side of the location iter has been moved to.

inf_text_gtk_buffer_set_wake_on_cursor_movement ()

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_INACTIVE.

If wake is TRUE, then the user status changes to INF_USER_ACTIVE in that case. If wake is FALSE, then the user status stays INF_USER_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.

inf_text_gtk_buffer_get_wake_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_INACTIVE. See also inf_text_gtk_buffer_set_wake_on_cursor_movement().

inf_text_gtk_buffer_ensure_author_tags_priority ()

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.

inf_text_gtk_buffer_set_saturation_value ()

void
inf_text_gtk_buffer_set_saturation_value
                               (InfTextGtkBuffer *buffer,
                                gdouble saturation,
                                gdouble value);

Sets the saturation and value to use for user colors in a HSV color model. The hue is defined by each user's individual color. The reason why S and V are set locally the same for all users is that they can be adjusted depending on one's theme: Dark themes want dark user colors, bright themes want bright ones.

inf_text_gtk_buffer_set_fade ()

void
inf_text_gtk_buffer_set_fade (InfTextGtkBuffer *buffer,
                              gdouble alpha);

This functions can be used to show the user background color with limited intensity, such that the background of the GtkTextView showing the buffer partly shines through.

An alpha value of 1.0 means to fully show the user background color, a value of 0.0 means to show the given background color. Values inbetween interpolate linearly between the two colors in RGB color space.

The default value for alpha is 1.0.

inf_text_gtk_buffer_get_saturation ()

gdouble
inf_text_gtk_buffer_get_saturation (InfTextGtkBuffer *buffer);

Returns the saturation part of the HSV user color.

inf_text_gtk_buffer_get_value ()

gdouble
inf_text_gtk_buffer_get_value (InfTextGtkBuffer *buffer);

Returns the value part of the HSV user color.

inf_text_gtk_buffer_set_show_user_colors ()

void
inf_text_gtk_buffer_set_show_user_colors
                               (InfTextGtkBuffer *buffer,
                                gboolean show);

If show is TRUE (the default), then the user color is used as background for newly written text by that user. Otherwise, newly written text has no background color.

Note that this setting is for newly written text only. If you want to show or hide user colors for existing text use inf_text_gtk_buffer_show_user_colors().

inf_text_gtk_buffer_get_show_user_colors ()

gboolean
inf_text_gtk_buffer_get_show_user_colors
                               (InfTextGtkBuffer *buffer);

Returns whether newly written text is attributed with the author's user color or not.

inf_text_gtk_buffer_show_user_colors ()

void
inf_text_gtk_buffer_show_user_colors (InfTextGtkBuffer *buffer,
                                      gboolean show,
                                      GtkTextIter *start,
                                      GtkTextIter *end);

If show is FALSE, then don't show user colors (which user wrote what text) as the background of the text, in the range from start to end . If show is TRUE, show user colors if they have previously been hidden via a call to this function with show being FALSE.

struct InfTextGtkBuffer

struct InfTextGtkBuffer;

InfTextGtkBuffer is an opaque data type. You should only access it via the public API functions.

struct InfTextGtkBufferClass

struct InfTextGtkBufferClass {
};

This structure does not contain any public fields.

The “active-user” property

  “active-user”              InfTextUser *

The user currently inserting text locally.

Owner: InfTextGtkBuffer

Flags: Read / Write

The “alpha” property

  “alpha”                    gdouble

The translucency of the user color.

Owner: InfTextGtkBuffer

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

The “buffer” property

  “buffer”                   GtkTextBuffer *

The underlaying GtkTextBuffer.

Owner: InfTextGtkBuffer

Flags: Read / Write / Construct Only

The “saturation” property

  “saturation”               gdouble

Saturation of user colors in a HSV color model.

Owner: InfTextGtkBuffer

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.35

The “show-user-colors” property

  “show-user-colors”         gboolean

Whether to show user colors initially for newly written text.

Owner: InfTextGtkBuffer

Flags: Read / Write

Default value: TRUE

The “user-table” property

  “user-table”               InfUserTable *

A user table of the participating users.

Owner: InfTextGtkBuffer

Flags: Read / Write / Construct Only

The “value” property

  “value”                    gdouble

Value of user colors in a HSV color model.

Owner: InfTextGtkBuffer

Flags: Read / Write

Allowed values: [0,1]

Default value: 1

The “wake-on-cursor-movement” property

  “wake-on-cursor-movement”  gboolean

Whether to make inactive users active when the insertion mark in the TextBuffer moves.

Owner: InfTextGtkBuffer

Flags: Read / Write

Default value: FALSE