SourceView

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool auto_indent { get; set; }
• public SourceBackgroundPatternType background_pattern { get; set; }
  Draw a specific background pattern on the view.
• public SourceCompletion completion { get; }
  The completion object associated with the view
• public bool highlight_current_line { get; set; }
• public bool indent_on_tab { get; set; }
• public int indent_width { get; set; }
  Width of an indentation step expressed in number of spaces.
• public bool insert_spaces_instead_of_tabs { get; set; }
• 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 SourceSmartHomeEndType smart_home_end { get; set; }
  Set the behavior of the HOME and END keys.
• public SourceSpaceDrawer space_drawer { get; }
  The SourceSpaceDrawer object associated with the view.
• public uint tab_width { get; set; }
  Width of a tab character expressed in number of spaces.

Creation methods:

• public SourceView ()
  Creates a new SourceView.
• public SourceView.with_buffer (SourceBuffer buffer)
  Creates a new SourceView widget displaying the buffer buffer.

Methods:

• public bool get_auto_indent ()
  Returns whether auto-indentation of text is enabled.
• public SourceBackgroundPatternType get_background_pattern ()
  Returns the SourceBackgroundPatternType specifying if and how the background pattern should be displayed for this this.
• public unowned SourceCompletion get_completion ()
  Gets the SourceCompletion associated with this.
• public unowned SourceGutter get_gutter (TextWindowType window_type)
  Returns the SourceGutter object associated with window_type for this.
• public bool get_highlight_current_line ()
  Returns whether the current line is highlighted.
• 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 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 SourceMarkAttributes 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 SourceSmartHomeEndType get_smart_home_end ()
  Returns a SourceSmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.
• public unowned SourceSpaceDrawer get_space_drawer ()
  Gets the SourceSpaceDrawer 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 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 (SourceBackgroundPatternType background_pattern)
  Set if and how the background pattern should be displayed.
• 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_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, SourceMarkAttributes 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 (SourceSmartHomeEndType 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 (SourceChangeCaseType 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, Event event)
  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 move_lines 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 move_words signal is a keybinding which gets emitted when the user initiates moving a word.
• public virtual signal void redo ()
• public virtual signal void show_completion ()
  The show_completion 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>.
• public virtual signal void undo ()

Inherited Members: