![]() |
![]() |
![]() |
libinftextgtk-0.5 Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties |
InfTextGtkView; InfTextGtkView * inf_text_gtk_view_new (InfIo *io
,GtkTextView *view
,InfUserTable *user_table
); GtkTextView * inf_text_gtk_view_get_text_view (InfTextGtkView *view
); InfUserTable * inf_text_gtk_view_get_user_table (InfTextGtkView *view
); void inf_text_gtk_view_set_active_user (InfTextGtkView *view
,InfTextUser *user
); InfTextUser * inf_text_gtk_view_get_active_user (InfTextGtkView *view
); void inf_text_gtk_view_set_show_remote_cursors (InfTextGtkView *view
,gboolean show
); void inf_text_gtk_view_set_show_remote_selections (InfTextGtkView *view
,gboolean show
); void inf_text_gtk_view_set_show_remote_current_lines (InfTextGtkView *view
,gboolean show
);
"active-user" InfTextUser* : Read / Write "io" InfIo* : Read / Write / Construct Only "show-remote-current-lines" gboolean : Read / Write "show-remote-cursors" gboolean : Read / Write "show-remote-selections" gboolean : Read / Write "user-table" InfUserTable* : Read / Write / Construct Only "view" GtkTextView* : Read / Write / Construct Only
InfTextGtkView * inf_text_gtk_view_new (InfIo *io
,GtkTextView *view
,InfUserTable *user_table
);
Creates a new InfTextGtkView for view
. This draws remote user's cursors
and selections into the text view.
|
A InfIo. |
|
A GtkTextView. |
|
The InfUserTable for the text session displayed in view .
|
Returns : |
A new InfTextGtkView. |
GtkTextView * inf_text_gtk_view_get_text_view (InfTextGtkView *view
);
Returns the underlying GtkTextView.
|
A InfTextGtkView. |
Returns : |
The InfTextGtkView's GtkTextView. |
InfUserTable * inf_text_gtk_view_get_user_table (InfTextGtkView *view
);
Returns the InfUserTable containing the users of the session the InfTextGtkView's GtkTextView is displaying.
|
A InfTextGtkView. |
Returns : |
The InfGtkTextView's InfUserTable. |
void inf_text_gtk_view_set_active_user (InfTextGtkView *view
,InfTextUser *user
);
Sets the user for which perspective to draw the view. The selection and cursor position is not drawn for this user since it is assumed that the view's buffer cursor position and selection match the active user ones (which is automatically the case if the buffer is managed by a InfTextGtkBuffer).
|
A InfTextGtkView. |
|
A user from view 's user table, or NULL .
|
InfTextUser * inf_text_gtk_view_get_active_user (InfTextGtkView *view
);
Returns the active user of view
. See inf_text_gtk_view_set_active_user()
.
|
A InfTextGtkView. |
Returns : |
The active user of view .
|
void inf_text_gtk_view_set_show_remote_cursors (InfTextGtkView *view
,gboolean show
);
If show
is TRUE
then view
draws a cursor for each non-local user in
INF_USER_ACTIVE
status in that user's color into its underlying
GtkTextView. If it is FALSE
then remote cursors are not drawn.
|
A InfTextGtkView. |
|
Whether to show cursors of non-local users. |
void inf_text_gtk_view_set_show_remote_selections (InfTextGtkView *view
,gboolean show
);
If show
is TRUE
then view
draws the selection ranges for each non-local
user in INF_USER_ACTIVE
status. The selection range is drawn shaded in
that user's color on top of the author color which indicates who wrote the
selected text. If more than one user has a given piece of text selected
then an alternating stripe pattern with each of the user's colors is drawn.
If show
is FALES
then selection ranges of remote users are not drawn.
|
A InfTextGtkView. |
|
Whether to show selections of non-local users. |
void inf_text_gtk_view_set_show_remote_current_lines (InfTextGtkView *view
,gboolean show
);
If show
is TRUE
then all lines in which the cursor of a non-local user
in INF_USER_ACTIVE
status is is highlighted with that user's color, similar
to GtkSourceView's "highlight current line" functionality. If it is FALSE
then the current line of non-local users is not be highlighted.
|
A InfTextGtkView. |
|
Whether to highlight the current line of non-local users. |
"active-user"
property"active-user" InfTextUser* : Read / Write
The user for which to show the view.
"show-remote-current-lines"
property "show-remote-current-lines" gboolean : Read / Write
Whether to highlight the line in which the cursor of non-local users is.
Default value: TRUE
"show-remote-cursors"
property "show-remote-cursors" gboolean : Read / Write
Whether to show cursors of non-local users.
Default value: TRUE
"show-remote-selections"
property "show-remote-selections" gboolean : Read / Write
Whether to highlight text selected by non-local users.
Default value: TRUE
"user-table"
property"user-table" InfUserTable* : Read / Write / Construct Only
The user table containing the users of the session shown in the view.