Reference Manual

Inti::Gtk::SourceView Class Reference

A GtkSourceView C++ wrapper class. More...

#include <inti/gtk-sourceview/sourceview.h>

List of all members.

Public Member Functions

Constructors

• SourceView ()

  Constructs a new source view widget with an empty default buffer.
  
  

• SourceView (SourceBuffer &buffer)

  Constructs a new source view widget displaying the SourceBuffer buffer.
  
  

• virtual ~SourceView ()

  Destructor.
  
  

Accessors

• GtkSourceView * gtk_source_view () const

  Get a pointer to the GtkSourceView structure.
  
  

• GtkSourceViewClass * gtk_source_view_class () const

  Get a pointer to the GtkSourceViewClass structure.
  
  

• operator GtkSourceView * () const

  Conversion operator; safely converts a SourceView to a GtkSourceView pointer.
  
  

• bool is_gtk_source_view () const

  Returns true if the object instance is of type GTK_TYPE_SOURCE_VIEW.
  
  

• SourceBuffer * get_source_buffer () const

  Returns a pointer to the buffer being displayed by this source view.
  
  

• bool get_show_line_numbers () const

  Returns true if line numbers are displayed.
  
  

• bool get_show_line_markers () const

  Returns true if line marker pixbufs are displayed.
  
  

• unsigned int get_tabs_width () const

  Returns the current tab width.
  
  

• bool get_auto_indent () const

  Returns true if auto indentation is enabled.
  
  

• bool get_insert_spaces_instead_of_tabs () const

  Returns true if spaces are inserted instead of tabs.
  
  

• bool get_show_margin () const

  Returns true if the right margin is displayed.
  
  

• unsigned int get_margin () const

  Returns the current position of the right margin.
  
  

• Pointer< Gdk::Pixbuf > get_marker_pixbuf (const String &marker_type) const

  Gets the marker pixbuf.
  
  

• bool get_smart_home_end () const

  Returns true if the HOME and END keys move to the first/last characters on a line first before going to the start/end of the line.
  
  

Methods

• void set_show_line_numbers (bool show)

  Sets whether line numbers are displayed.
  
  

• void set_show_line_markers (bool show)

  Sets whether line marker pixbufs are displayed.
  
  

• void set_tabs_width (unsigned int width)

  Sets the tab width.
  
  

• void set_auto_indent (bool enable)

  Enables auto indentation.
  
  

• void set_insert_spaces_instead_of_tabs (bool enable)

  Sets whether spaces should be inserted instead of tabs.
  
  

• void set_show_margin (bool show)

  Sets whether the right margin is displayed.
  
  

• void set_margin (unsigned int margin)

  Sets the position of the right margin.
  
  

• void set_marker_pixbuf (const String &marker_type, Gdk::Pixbuf *pixbuf)

  Sets the line marker pixbuf.
  
  

• void set_smart_home_end (bool enable)

  Sets whether the HOME and END keys move to the first/last characters on a line first before going to the start/end of the line.
  
  

Property Proxies

• const ShowLineNumbersPropertyProxy prop_show_line_numbers ()

  Whether to display line numbers (bool : Read / Write).
  
  

• const ShowLineMarkersPropertyProxy prop_show_line_markers ()

  Whether to display line marker pixbufs (bool : Read / Write).
  
  

• const TabsWidthPropertyProxy prop_tabs_width ()

  Set the tab width (unsigned int : Read / Write).
  
  

• const AutoIndentPropertyProxy prop_auto_indent ()

  Whether to enable auto indentation (bool : Read / Write).
  
  

• const InsertSpacesPropertyProxy prop_insert_spaces ()

  Whether to insert spaces instead of tabs (bool : Read / Write).
  
  

• const ShowMarginPropertyProxy prop_show_margin ()

  Whether to display the right margin (bool : Read / Write).
  
  

• const MarginPropertyProxy prop_margin ()

  Position of the right margin (unsigned int : Read / Write).
  
  

• const SmartHomeEndPropertyProxy prop_smart_home_end ()

  The HOME and END keys move to the first/last characters on a line first before going to the start/end of the line (bool : Read / Write).
  
  

Protected Member Functions

Constructors

• SourceView (GtkSourceView *view, bool reference=false)

  Construct a new SourceView from an existing GtkSourceView.
  
  

---

Detailed Description

A GtkSourceView C++ wrapper class.

SourceView is an enhanced Gtk::TextView widget that implements syntax highlighting and other features typical of a source code editor.

---

Constructor & Destructor Documentation

Inti::Gtk::SourceView::SourceView (  GtkSourceView *  view, bool  reference = false )  [explicit, protected]

Construct a new SourceView from an existing GtkSourceView. Parameters: view  A pointer to a GtkSourceView. reference  Set false if the initial reference count is floating, set true if it's not. The view can be a newly created GtkSourceView or an existing GtkSourceView (see G::Object::Object).

Inti::Gtk::SourceView::SourceView (  SourceBuffer &  buffer  )  [explicit]

Constructs a new source view widget displaying the SourceBuffer buffer. Parameters: buffer  A SourceBuffer. One buffer can be shared among many widgets. The source view adds its own reference count to the buffer; it does not take over an existing reference.

---

Member Function Documentation

Pointer<Gdk::Pixbuf> Inti::Gtk::SourceView::get_marker_pixbuf (  const String &  marker_type  )  const

Gets the marker pixbuf. Parameters: marker_type  A String that indentifies the marker pixbuf. Returns: A smart pointer to a Gdk::Pixbuf.

void Inti::Gtk::SourceView::set_auto_indent (  bool  enable  )

Enables auto indentation. Parameters: enable  Set true to enable auto indentation.

void Inti::Gtk::SourceView::set_insert_spaces_instead_of_tabs (  bool  enable  )

Sets whether spaces should be inserted instead of tabs. Parameters: enable  Set true to insert spaces.

void Inti::Gtk::SourceView::set_margin (  unsigned int  margin  )

Sets the position of the right margin. Parameters: margin  The new position of the right margin.

void Inti::Gtk::SourceView::set_marker_pixbuf (  const String &  marker_type, Gdk::Pixbuf *  pixbuf )

Sets the line marker pixbuf. Parameters: marker_type  A String indentifying the marker pixbuf. pixbuf  A Gdk::Pixbuf.

void Inti::Gtk::SourceView::set_show_line_markers (  bool  show  )

Sets whether line marker pixbufs are displayed. Parameters: show  Set true to display line markers.

void Inti::Gtk::SourceView::set_show_line_numbers (  bool  show  )

Sets whether line numbers are displayed. Parameters: show  Set true to display line numbers.

void Inti::Gtk::SourceView::set_show_margin (  bool  show  )

Sets whether the right margin is displayed. Parameters: show  Set true to display the right margin.

void Inti::Gtk::SourceView::set_smart_home_end (  bool  enable  )

Sets whether the HOME and END keys move to the first/last characters on a line first before going to the start/end of the line. Parameters: enable  Set true to enable smart home/end.

void Inti::Gtk::SourceView::set_tabs_width (  unsigned int  width  )

Sets the tab width. Parameters: width  The new tab width.

---

The documentation for this class was generated from the following file:

• sourceview.h