View

---

Object Hierarchy:

Description:

Content:

Properties:

• public Annotations annotations { get; }
  The [class@Annotations] object associated with the view.
• public bool auto_indent { get; set; }
  Whether to enable auto indentation.
• public BackgroundPatternType background_pattern { get; set; }
  Draw a specific background pattern on the view.
• public Completion completion { get; }
  The completion object associated with the view
• public bool enable_snippets { get; set; }
  The property denotes if snippets should be expanded when the user presses Tab after having typed a word matching the snippets found in [class@SnippetManager].
• public bool highlight_current_line { get; set; }
  Whether to highlight the current line.
• public bool indent_on_tab { get; set; }
  Whether to indent the selected text when the tab key is pressed.
• public int indent_width { get; set; }
  Width of an indentation step expressed in number of spaces.
• public Indenter indenter { get; set; }
  The property is a [iface@Indenter] to use to indent as the user types into the [class@View].
• public bool insert_spaces_instead_of_tabs { get; set; }
  Whether to insert spaces instead of tabs.
• public uint right_margin_position { get; set; }
  Position of the right margin.
• public bool show_line_marks { get; set; }
  Whether to display line mark pixbufs
• public bool show_line_numbers { get; set; }
  Whether to display line numbers
• public bool show_right_margin { get; set; }
  Whether to display the right margin.
• public bool smart_backspace { get; set; }
  Whether smart Backspace should be used.
• public SmartHomeEndType smart_home_end { get; set; }
  Set the behavior of the HOME and END keys.
• public SpaceDrawer space_drawer { get; }
  The [class@SpaceDrawer] object associated with the view.
• public uint tab_width { get; set; }
  Width of a tab character expressed in number of spaces.

Creation methods:

• public View ()
  Creates a new `GtkSourceView`.
• public View.with_buffer (Buffer buffer)
  Creates a new View widget displaying the buffer buffer.

Methods:

• public unowned Annotations get_annotations ()
  Gets the [class@Annotations] associated with this.
• public bool get_auto_indent ()
  Returns whether auto-indentation of text is enabled.
• public BackgroundPatternType get_background_pattern ()
  Returns the BackgroundPatternType specifying if and how the background pattern should be displayed for this this.
• public unowned Completion get_completion ()
  Gets the [class@Completion] associated with this.
• public bool get_enable_snippets ()
  Gets the [property@View:enable-snippets] property.
• public unowned Gutter get_gutter (TextWindowType window_type)
  Returns the [class@Gutter] object associated with window_type for this.
• public bool get_highlight_current_line ()
  Returns whether the current line is highlighted.
• public unowned Hover get_hover ()
  Gets the [class@Hover] associated with this .
• public bool get_indent_on_tab ()
  Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the `\t` character.
• public int get_indent_width ()
  Returns the number of spaces to use for each step of indent.
• public unowned Indenter? get_indenter ()
  Gets the [property@View:indenter] property.
• public bool get_insert_spaces_instead_of_tabs ()
  Returns whether when inserting a tabulator character it should be replaced by a group of space characters.
• public unowned MarkAttributes get_mark_attributes (string category, int priority)
  Gets attributes and priority for the category.
• public uint get_right_margin_position ()
  Gets the position of the right margin in the given this.
• public bool get_show_line_marks ()
  Returns whether line marks are displayed beside the text.
• public bool get_show_line_numbers ()
  Returns whether line numbers are displayed beside the text.
• public bool get_show_right_margin ()
  Returns whether a right margin is displayed.
• public bool get_smart_backspace ()
  Returns true if pressing the Backspace key will try to delete spaces up to the previous tab stop.
• public SmartHomeEndType get_smart_home_end ()
  Returns a [enum@SmartHomeEndType] end value specifying how the cursor will move when HOME and END keys are pressed.
• public unowned SpaceDrawer get_space_drawer ()
  Gets the [class@SpaceDrawer] associated with this.
• public uint get_tab_width ()
  Returns the width of tabulation in characters.
• public uint get_visual_column (TextIter iter)
  Determines the visual column at iter taking into consideration the [property@View:tab-width] of this.
• public void indent_lines (TextIter start, TextIter end)
  Inserts one indentation level at the beginning of the specified lines.
• public void set_auto_indent (bool enable)
  If true auto-indentation of text is enabled.
• public void set_background_pattern (BackgroundPatternType background_pattern)
  Set if and how the background pattern should be displayed.
• public void set_enable_snippets (bool enable_snippets)
  Sets the [property@View:enable-snippets] property.
• public void set_highlight_current_line (bool highlight)
  If highlight is true the current line will be highlighted.
• public void set_indent_on_tab (bool enable)
  If true, when the tab key is pressed when several lines are selected, the selected lines are indented of one level instead of being replaced with a `\t` character.
• public void set_indent_width (int width)
  Sets the number of spaces to use for each step of indent when the tab key is pressed.
• public void set_indenter (Indenter? indenter)
  Sets the indenter for this to indenter.
• public void set_insert_spaces_instead_of_tabs (bool enable)
  If true a tab key pressed is replaced by a group of space characters.
• public void set_mark_attributes (string category, MarkAttributes attributes, int priority)
  Sets attributes and priority for the category.
• public void set_right_margin_position (uint pos)
  Sets the position of the right margin in the given this.
• public void set_show_line_marks (bool show)
  If true line marks will be displayed beside the text.
• public void set_show_line_numbers (bool show)
  If true line numbers will be displayed beside the text.
• public void set_show_right_margin (bool show)
  If true a right margin is displayed.
• public void set_smart_backspace (bool smart_backspace)
  When set to true, pressing the Backspace key will try to delete spaces up to the previous tab stop.
• public void set_smart_home_end (SmartHomeEndType smart_home_end)
  Set the desired movement of the cursor when HOME and END keys are pressed.
• public void set_tab_width (uint width)
  Sets the width of tabulation in characters.
• public void unindent_lines (TextIter start, TextIter end)
  Removes one indentation level at the beginning of the specified lines.

Signals:

• public signal void change_case (ChangeCaseType case_type)
  Keybinding signal to change case of the text at the current cursor position.
• public signal void change_number (int count)
  Keybinding signal to edit a number at the current cursor position.
• public signal void join_lines ()
  Keybinding signal to join the lines currently selected.
• public virtual signal void line_mark_activated (TextIter iter, uint button, ModifierType state, int n_presses)
  Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter).
• public virtual signal void move_lines (bool down)
  The signal is a keybinding which gets emitted when the user initiates moving a line.
• public signal void move_to_matching_bracket (bool extend_selection)
  Keybinding signal to move the cursor to the matching bracket.
• public virtual signal void move_words (int step)
  The signal is a keybinding which gets emitted when the user initiates moving a word.
• public virtual signal void push_snippet (Snippet snippet, ref TextIter location)
  The signal is emitted to insert a new snippet into the view.
• public virtual signal void show_completion ()
  The signal is a key binding signal which gets emitted when the user requests a completion, by pressing <keycombo><keycap>Control</keycap><keycap>space</keycap></keycombo >.

Inherited Members: