Top | ![]() |
![]() |
![]() |
![]() |
guint | completion-n-rows | Read / Write |
gint | count | Read / Write |
IdeFileSettings * | file-settings | Read |
PangoFontDescription * | font-desc | Read / Write |
gchar * | font-name | Write / Construct |
IdeIndentStyle | indent-style | Write |
IdeIndenter * | indenter | Read |
gboolean | insert-matching-brace | Read / Write |
gboolean | interactive-completion | Read / Write |
gchar * | mode-display-name | Read |
gint | overscroll | Read / Write |
gboolean | overwrite-braces | Read / Write |
guint | scroll-offset | Read / Write |
gboolean | show-grid-lines | Read / Write |
gboolean | show-line-changes | Read / Write |
gboolean | show-line-diagnostics | Read / Write |
#define | IDE_TYPE_SOURCE_VIEW |
enum | IdeCursorType |
enum | IdeSourceViewModeType |
enum | IdeSourceViewTheatric |
enum | IdeSourceViewMovement |
enum | IdeSourceScrollAlign |
struct | IdeSourceViewClass |
IdeSourceView |
GEnum ├── IdeCursorType ├── IdeSourceViewModeType ├── IdeSourceViewMovement ╰── IdeSourceViewTheatric GFlags ╰── IdeSourceScrollAlign GObject ╰── GInitiallyUnowned ╰── GtkWidget ╰── GtkContainer ╰── GtkTextView ╰── GtkSourceView ╰── IdeSourceView
IdeSourceView implements AtkImplementorIface, GtkBuildable and GtkScrollable.
gboolean
ide_source_view_has_snippet (IdeSourceView *self
);
Checks if there is an active snippet.
Since: 3.30
IdeSnippet *
ide_source_view_get_current_snippet (IdeSourceView *self
);
Gets the current snippet if there is one, otherwise NULL
.
guint ide_source_view_get_visual_column (IdeSourceView *self
,const GtkTextIter *location
);
void ide_source_view_get_visual_position (IdeSourceView *self
,guint *line
,guint *line_column
);
IdeFileSettings *
ide_source_view_get_file_settings (IdeSourceView *self
);
Gets the “file-settings” property. This contains various settings for how the file should be rendered in the view, and preferences such as spaces vs tabs.
const PangoFontDescription *
ide_source_view_get_font_desc (IdeSourceView *self
);
PangoFontDescription *
ide_source_view_get_scaled_font_desc (IdeSourceView *self
);
Like ide_source_view_get_font_desc()
but takes the editor zoom into
account. You must free the result with pango_font_description_free()
.
gboolean
ide_source_view_get_highlight_current_line
(IdeSourceView *self
);
gboolean
ide_source_view_get_insert_matching_brace
(IdeSourceView *self
);
void ide_source_view_get_iter_at_visual_column (IdeSourceView *self
,guint column
,GtkTextIter *location
);
const gchar *
ide_source_view_get_mode_display_name (IdeSourceView *self
);
gboolean
ide_source_view_get_overwrite_braces (IdeSourceView *self
);
guint
ide_source_view_get_scroll_offset (IdeSourceView *self
);
Gets the “scroll-offset” property. This property contains the number of lines that should be kept above or below the line containing the insertion cursor relative to the top and bottom of the visible text window.
gboolean
ide_source_view_get_show_grid_lines (IdeSourceView *self
);
gboolean
ide_source_view_get_show_line_changes (IdeSourceView *self
);
gboolean
ide_source_view_get_show_line_diagnostics
(IdeSourceView *self
);
gboolean
ide_source_view_get_show_line_numbers (IdeSourceView *self
);
gboolean
ide_source_view_get_snippet_completion
(IdeSourceView *self
);
gboolean
ide_source_view_get_spell_checking (IdeSourceView *self
);
void ide_source_view_get_visible_rect (IdeSourceView *self
,GdkRectangle *visible_rect
);
Gets the visible region in buffer coordinates that is the visible area of the buffer. This
is similar to gtk_text_view_get_visible_area()
except that it takes into account the
“scroll-offset” property to ensure there is space above and below the
visible_rect.
void ide_source_view_jump (IdeSourceView *self
,const GtkTextIter *from
,const GtkTextIter *to
);
void ide_source_view_push_snippet (IdeSourceView *self
,IdeSnippet *snippet
,const GtkTextIter *location
);
Pushes a new snippet onto the source view.
void ide_source_view_save_search (IdeSourceView *self
,const gchar *search_text
);
void ide_source_view_set_font_desc (IdeSourceView *self
,const PangoFontDescription *font_desc
);
void ide_source_view_set_font_name (IdeSourceView *self
,const gchar *font_name
);
void ide_source_view_set_highlight_current_line (IdeSourceView *self
,gboolean highlight_current_line
);
void ide_source_view_set_insert_matching_brace (IdeSourceView *self
,gboolean insert_matching_brace
);
void ide_source_view_set_misspelled_word (IdeSourceView *self
,GtkTextIter *start
,GtkTextIter *end
);
void ide_source_view_set_overwrite_braces (IdeSourceView *self
,gboolean overwrite_braces
);
void ide_source_view_set_scroll_offset (IdeSourceView *self
,guint scroll_offset
);
Sets the “scroll-offset” property. See ide_source_view_get_scroll_offset()
for
more information. Set to 0 to unset this property.
void ide_source_view_set_show_grid_lines (IdeSourceView *self
,gboolean show_grid_lines
);
void ide_source_view_set_show_line_changes (IdeSourceView *self
,gboolean show_line_changes
);
void ide_source_view_set_show_line_diagnostics (IdeSourceView *self
,gboolean show_line_diagnostics
);
void ide_source_view_set_show_line_numbers (IdeSourceView *self
,gboolean show_line_numbers
);
void ide_source_view_set_snippet_completion (IdeSourceView *self
,gboolean snippet_completion
);
void ide_source_view_set_spell_checking (IdeSourceView *self
,gboolean enable
);
gboolean ide_source_view_move_mark_onscreen (IdeSourceView *self
,GtkTextMark *mark
);
gboolean
ide_source_view_place_cursor_onscreen (IdeSourceView *self
);
void ide_source_view_scroll_mark_onscreen (IdeSourceView *self
,GtkTextMark *mark
,IdeSourceScrollAlign use_align
,gdouble alignx
,gdouble aligny
);
void ide_source_view_scroll_to_mark (IdeSourceView *self
,GtkTextMark *mark
,gdouble within_margin
,IdeSourceScrollAlign use_align
,gdouble xalign
,gdouble yalign
,gboolean animate_scroll
);
void ide_source_view_scroll_to_iter (IdeSourceView *self
,const GtkTextIter *iter
,gdouble within_margin
,IdeSourceScrollAlign use_align
,gdouble xalign
,gdouble yalign
,gboolean animate_scroll
);
IdeCompletion *
ide_source_view_get_completion (IdeSourceView *self
);
Get the completion for the IdeSourceView
Since: 3.30
gboolean
ide_source_view_is_processing_key (IdeSourceView *self
);
The type of movement.
Some of these movements may be modified by using the modify-repeat action. First adjust the repeat and then perform the "movement" action.
move to previous character in the file. This includes line breaks. |
||
move to next character in the file. This includes line breaks. |
||
move to nth character in line. Use a repeat to specify the target character within the line. |
||
move to previous character in line. |
||
move to next character in line. |
||
move to line offset of zero. |
||
move to first non-whitespace character in line. |
||
move to the middle character in the line. |
||
move to the last character in the line. this can be
inclusve or exclusive. inclusive is equivalent to |
||
move to beginning of next word. |
||
move to the next sub-word start, similar to the default in GtkTextView. This includes the underline character as a word break, as is common in Emacs. |
||
move to the previous sub-wird start, similar to the default in GtkTextView. This includes the underline character as a word break, as is common in Emacs. |
||
move to beginning of previous word. |
||
move to end of previous word. |
||
move to end of next word. |
||
IDE_SOURCE_VIEW_MOVEMENT_PREVIOUS_FULL_WORD_START_NEWLINE_STOP |
||
IDE_SOURCE_VIEW_MOVEMENT_PREVIOUS_FULL_WORD_END_NEWLINE_STOP |
||
move to beginning of sentance. |
||
move to end of sentance. |
||
move to start of paragraph. |
||
move to end of paragraph. |
||
move to previous line, keeping line offset if possible. |
||
move to next line, keeping line offset if possible. |
||
move to first line in file, line offset of zero. |
||
move to nth line, line offset of zero. use repeat to select the given line number. |
||
move to last line in file, with line offset of zero. |
||
move to line based on percentage. Use repeat to specify the percentage, 0 to 100. |
||
special selection to select all line characters up to the cursor position. special care will be taken if the line is blank to select only the blank space if any. otherwise, the line break will be selected. |
||
This will move you to the location of the newline at the end of the current line. It does not support exclusive will not select the newline, while inclusive will select the newline. |
||
move half a page up. |
||
move half a page down. |
||
move half a page left. |
||
move half a page right. |
||
move a full page up. |
||
move a full page up, but extend to whole line. |
||
move a full page down. |
||
move a full page down, but extend to whole line. |
||
move to viewport up by visible line, adjusting cursor to stay on screen if necessary. |
||
move to viewport down by visible line, adjusting cursor to stay on screen if necessary. |
||
move to viewport left by visible char, adjusting cursor to stay on screen if necessary. |
||
move to viewport right by visible char, adjusting cursor to stay on screen if necessary. |
||
move to the top of the screen. |
||
move to the middle of the screen. |
||
move to the bottom of the screen. |
||
move to match of brace, bracket, comment. |
||
scroll until insert cursor or [count]th line is at screen top. |
||
scroll until insert cursor or [count]th line is at screen center. |
||
scroll until insert cursor or [count]th line is at screen bottom. |
||
scroll until insert cursor or [count]th char is at screen left. |
||
scroll until insert cursor or [count]th char is at screen right. |
||
move to the next matching char according to f and t in vim. |
||
move to the previous matching char according to F and T in vim. |
||
Moves to the first non-whitespace character unless already positioned there. Otherwise, it moves to the first character. |
struct IdeSourceViewClass { GtkSourceViewClass parent_class; void (*append_to_count) (IdeSourceView *self, gint digit); void (*auto_indent) (IdeSourceView *self); void (*begin_macro) (IdeSourceView *self); void (*capture_modifier) (IdeSourceView *self); void (*clear_count) (IdeSourceView *self); void (*clear_modifier) (IdeSourceView *self); void (*clear_search) (IdeSourceView *self); void (*clear_selection) (IdeSourceView *self); void (*clear_snippets) (IdeSourceView *self); void (*cycle_completion) (IdeSourceView *self, GtkDirectionType direction); void (*delete_selection) (IdeSourceView *self); void (*end_macro) (IdeSourceView *self); void (*focus_location) (IdeSourceView *self, IdeSourceLocation *location); void (*goto_definition) (IdeSourceView *self); void (*hide_completion) (IdeSourceView *self); void (*indent_selection) (IdeSourceView *self, gint level); void (*insert_at_cursor_and_indent) (IdeSourceView *self, const gchar *str); void (*insert_modifier) (IdeSourceView *self, gboolean use_count); void (*jump) (IdeSourceView *self, const GtkTextIter *from, const GtkTextIter *to); void (*movement) (IdeSourceView *self, IdeSourceViewMovement movement, gboolean extend_selection, gboolean exclusive, gboolean apply_count); void (*move_error) (IdeSourceView *self, GtkDirectionType dir); void (*move_search) (IdeSourceView *self, GtkDirectionType dir, gboolean extend_selection, gboolean select_match, gboolean exclusive, gboolean apply_count, gboolean at_word_boundaries); void (*paste_clipboard_extended) (IdeSourceView *self, gboolean smart_lines, gboolean after_cursor, gboolean place_cursor_at_original); void (*push_selection) (IdeSourceView *self); void (*pop_selection) (IdeSourceView *self); void (*rebuild_highlight) (IdeSourceView *self); void (*replay_macro) (IdeSourceView *self, gboolean use_count); void (*request_documentation) (IdeSourceView *self); void (*restore_insert_mark) (IdeSourceView *self); void (*save_command) (IdeSourceView *self); void (*save_search_char) (IdeSourceView *self); void (*save_insert_mark) (IdeSourceView *self); void (*select_inner) (IdeSourceView *self, const gchar *inner_left, const gchar *inner_right, gboolean exclusive, gboolean string_mode); void (*select_tag) (IdeSourceView *self, gboolean exclusive); void (*selection_theatric) (IdeSourceView *self, IdeSourceViewTheatric theatric); void (*set_mode) (IdeSourceView *self, const gchar *mode, IdeSourceViewModeType type); void (*set_overwrite) (IdeSourceView *self, gboolean overwrite); void (*set_search_text) (IdeSourceView *self, const gchar *search_text, gboolean from_selection); void (*sort) (IdeSourceView *self, gboolean ignore_case, gboolean reverse); void (*swap_selection_bounds) (IdeSourceView *self); void (*increase_font_size) (IdeSourceView *self); void (*decrease_font_size) (IdeSourceView *self); void (*reset_font_size) (IdeSourceView *self); void (*begin_rename) (IdeSourceView *self); void (*add_cursor) (IdeSourceView *self, guint type); void (*remove_cursors) (IdeSourceView *self); void (*copy_clipboard_extended) (IdeSourceView *self); };
“completion-n-rows”
property “completion-n-rows” guint
The number of completion rows to display to the user.
Flags: Read / Write
Allowed values: [1,32]
Default value: 5
“count”
property “count” gint
The count for movements.
Flags: Read / Write
Allowed values: >= -1
Default value: 0
“file-settings”
property“file-settings” IdeFileSettings *
The file settings that have been loaded for the file.
Flags: Read
“font-desc”
property“font-desc” PangoFontDescription *
The Pango font description to use for rendering source.
Flags: Read / Write
“font-name”
property “font-name” gchar *
The Pango font name to use for rendering source.
Flags: Write / Construct
Default value: "Monospace"
“indent-style”
property“indent-style” IdeIndentStyle
Indent Style.
Flags: Write
Default value: IDE_INDENT_STYLE_TABS
“insert-matching-brace”
property “insert-matching-brace” gboolean
Insert a matching brace/bracket/quotation/parenthesis.
Flags: Read / Write
Default value: FALSE
“interactive-completion”
property “interactive-completion” gboolean
If completion should be completed interactively.
Flags: Read / Write
Default value: TRUE
“mode-display-name”
property “mode-display-name” gchar *
The display name of the keybinding mode.
Flags: Read
Default value: NULL
“overscroll”
property “overscroll” gint
The number of lines to scroll beyond the end of the buffer. A negative number of lines will scroll until only that number of lines is visible.
Flags: Read / Write
Default value: 1
“overwrite-braces”
property “overwrite-braces” gboolean
Overwrite a matching brace/bracket/quotation/parenthesis.
Flags: Read / Write
Default value: FALSE
“scroll-offset”
property “scroll-offset” guint
The number of lines between the insertion cursor and screen boundary.
Flags: Read / Write
Default value: 0
“show-grid-lines”
property “show-grid-lines” gboolean
If the background grid should be shown.
Flags: Read / Write
Default value: FALSE
“show-line-changes”
property “show-line-changes” gboolean
If line changes should be shown in the left gutter.
Flags: Read / Write
Default value: FALSE
“action”
signalvoid user_function (IdeSourceView *idesourceview, gchar *arg1, gchar *arg2, gchar *arg3, gpointer user_data)
Flags: Action
“add-cursor”
signalvoid user_function (IdeSourceView *idesourceview, IdeCursorType arg1, gpointer user_data)
Flags: Action
“append-to-count”
signalvoid user_function (IdeSourceView *idesourceview, gint arg1, gpointer user_data)
Flags: Action
“begin-macro”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
This signal will begin recording input to the IdeSourceView. This includes the current IdeSourceViewMode, “count” and “modifier” which will be used to replay the sequence starting from the correct state.
Pair this with an emission of “end-macro” to complete the sequence.
Flags: Action
“begin-rename”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
This signal is emitted when the source view should begin a rename operation using the IdeRenameProvider from the underlying buffer. The cursor position will be used as the location when sending the request to the provider.
Flags: Action
“begin-user-action”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“capture-modifier”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
This signal will block the main loop in a similar fashion to how
gtk_dialog_run()
performs until a key-press has occurred that can be
captured for use in movements.
Pressing Escape or unfocusing the widget will break from this loop.
Use of this signal is not recommended except in very specific cases.
Flags: Action
“clear-count”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“clear-modifier”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“clear-search”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“clear-selection”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“clear-snippets”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“copy-clipboard-extended”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“cycle-completion”
signalvoid user_function (IdeSourceView *idesourceview, GtkDirectionType arg1, gpointer user_data)
Flags: Action
“decrease-font-size”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“delete-selection”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“draw-bubbles”
signalvoid user_function (IdeSourceView *idesourceview, CairoContext *arg1, gpointer user_data)
Flags: Run Last
“duplicate-entire-line”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“end-macro”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
You should call “begin-macro” before emitting this signal.
Complete a macro recording sequence. This may be called more times than is necessary, since IdeSourceView will only keep the most recent macro recording. This can be helpful when implementing recording sequences such as in Vim.
Flags: Action
“end-user-action”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“find-references”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“focus-location”
signalvoid user_function (IdeSourceView *idesourceview, IdeSourceLocation *arg1, gpointer user_data)
Flags: Run Last
“format-selection”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“goto-definition”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“hide-completion”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“increase-font-size”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“indent-selection”
signalvoid user_function (IdeSourceView *idesourceview, gint arg1, gpointer user_data)
Flags: Action
“insert-modifier”
signalvoid user_function (IdeSourceView *self, gboolean use_count, gpointer user_data)
Inserts the current modifier character at the insert mark in the buffer.
If use_count
is TRUE
, then the character will be inserted
“count” times.
self |
||
use_count |
If the count property should be used to repeat. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“jump”
signalvoid user_function (IdeSourceView *idesourceview, GtkTextIter *arg1, GtkTextIter *arg2, gpointer user_data)
Flags: Run Last
“move-error”
signalvoid user_function (IdeSourceView *self, GtkDirectionType dir, gpointer user_data)
Moves to the next search result either forwards or backwards.
self |
An IdeSourceView. |
|
dir |
The direction to move. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“move-search”
signalvoid user_function (IdeSourceView *idesourceview, GtkDirectionType arg1, gboolean arg2, gboolean arg3, gboolean arg4, gboolean arg5, gint arg6, gpointer user_data)
Flags: Action
“movement”
signalvoid user_function (IdeSourceView *idesourceview, IdeSourceViewMovement arg1, gboolean arg2, gboolean arg3, gboolean arg4, gpointer user_data)
Flags: Action
“paste-clipboard-extended”
signalvoid user_function (IdeSourceView *idesourceview, gboolean arg1, gboolean arg2, gboolean arg3, gpointer user_data)
Flags: Action
“pop-selection”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Reselects a previousl selected range of text that was saved using IdeSourceView::push-selection.
Flags: Action
“pop-snippet”
signalvoid user_function (IdeSourceView *self, gpointer user_data)
Pops the current snippet from the sourceview if there is one.
self |
||
snippet |
An IdeSnippet. |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“push-selection”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Saves the current selection away to be restored by a call to IdeSourceView::pop-selection. You must pop the selection to keep the selection stack in consistent order.
Flags: Action
“push-snippet”
signalvoid user_function (IdeSourceView *self, IdeSnippet *snippet, GtkTextIter *iter, gpointer user_data)
Pushes snippet
onto the snippet stack at either iter
or the insertion
mark if iter
is not provided.
self |
||
snippet |
An IdeSnippet. |
|
iter |
The location for the snippet, or |
[allow-none] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“rebuild-highlight”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“reindent”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“remove-cursors”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“replay-macro”
signalvoid user_function (IdeSourceView *idesourceview, gboolean arg1, gpointer user_data)
Flags: Action
“request-documentation”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“reset”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
This is a helper signal that will try to reset keyboard input and various stateful settings of the sourceview. This is a good signal to map to the "Escape" key.
Flags: Action
Since: 3.26
“reset-font-size”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“restore-insert-mark”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“save-command”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“save-insert-mark”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“save-search-char”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action
“select-inner”
signalvoid user_function (IdeSourceView *idesourceview, gchar *arg1, gchar *arg2, gboolean arg3, gboolean arg4, gpointer user_data)
Flags: Action
“select-tag”
signalvoid user_function (IdeSourceView *idesourceview, gboolean arg1, gpointer user_data)
Flags: Action
“selection-theatric”
signalvoid user_function (IdeSourceView *idesourceview, IdeSourceViewTheatric arg1, gpointer user_data)
Flags: Action
“set-mode”
signalvoid user_function (IdeSourceView *idesourceview, gchar *arg1, IdeSourceViewModeType arg2, gpointer user_data)
Flags: Action
“set-overwrite”
signalvoid user_function (IdeSourceView *idesourceview, gboolean arg1, gpointer user_data)
Flags: Action
“set-search-text”
signalvoid user_function (IdeSourceView *idesourceview, gchar *arg1, gboolean arg2, gpointer user_data)
Flags: Action
“sort”
signalvoid user_function (IdeSourceView *self, gboolean ignore_case, gboolean reverse, gpointer user_data)
This signal is meant to be activated from keybindings to sort the currently selected lines.
The lines are sorted using qsort()
and either strcmp()
or strcasecmp()
.
self |
an IdeSourceView. |
|
ignore_case |
If character case should be ignored. |
|
reverse |
If the lines should be sorted in reverse order |
|
user_data |
user data set when the signal handler was connected. |
Flags: Action
“swap-selection-bounds”
signalvoid user_function (IdeSourceView *idesourceview, gpointer user_data)
Flags: Action