Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::SourceView Class Reference

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

Inheritance diagram for Xfc::Gtk::SourceView:

Xfc::Gtk::TextView Xfc::Gtk::Container Xfc::Gtk::Widget Xfc::Gtk::Object Xfc::Atk::Implementor Xfc::G::Object Xfc::G::TypeInterface Xfc::G::TypeInstance Xfc::G::TypeInstance Xfc::Trackable Xfc::Trackable List of all members.

Public Member Functions

Accessors
Methods
Property Proxies

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

Xfc::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).

Xfc::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.

Xfc::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).

Xfc::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> Xfc::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 Xfc::Gtk::SourceView::set_show_line_numbers ( bool  show  ) 

Sets whether line numbers are displayed.

Parameters:
show Set true to display line numbers.

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

Sets whether line marker pixbufs are displayed.

Parameters:
show Set true to display line markers.

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

Sets the tab width.

Parameters:
width The new tab width.

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

Enables auto indentation.

Parameters:
enable Set true to enable auto indentation.

void Xfc::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 Xfc::Gtk::SourceView::set_show_margin ( bool  show  ) 

Sets whether the right margin is displayed.

Parameters:
show Set true to display the right margin.

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

Sets the position of the right margin.

Parameters:
margin The new position of the right margin.

void Xfc::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 Xfc::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 Xfc::Gtk::SourceView::set_source_buffer ( SourceBuffer buffer  ) 

Set up an new buffer for the source view.

Parameters:
buffer the new source view buffer


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3