gtksourceview::SourceView Class Reference

Multi-line source editing widget. More...

#include <sourceview.h>

List of all members.

Public Types
typedef SourceView	CppObjectType
typedef SourceView_Class	CppClassType
typedef GtkSourceView	BaseObjectType
typedef GtkSourceViewClass	BaseClassType
Public Member Functions
virtual	~SourceView ()
GtkSourceView *	gobj ()
	Provides access to the underlying C GtkObject.
const GtkSourceView *	gobj () const
	Provides access to the underlying C GtkObject.
	SourceView ()
	default constructor
	SourceView (Glib::RefPtr< SourceBuffer > &buffer)
	constructor.
Glib::RefPtr< const SourceBuffer >	get_source_buffer () const
	get the source buffer associated to the current instance
Glib::RefPtr< SourceBuffer >	get_source_buffer ()
	get the source buffer associated to the current instance
void	set_source_buffer (Glib::RefPtr< SourceBuffer > &source_buffer)
	set the source buffer to be displayed by the SourceView
void	set_show_line_numbers (bool show=true)
	display line numbers beside the text, or not
bool	get_show_line_numbers () const
	test whether line numbers are displayed beside the text
void	set_show_line_markers (bool show=true)
	display line markers beside the text, nor not.
bool	get_show_line_markers () const
	test whether if line markers are displayed beside the text
void	set_tabs_width (guint width)
	set tabs width
guint	get_tabs_width () const
	get tab width
void	set_auto_indent (bool enable=true)
	set automatic text indention or not
bool	get_auto_indent () const
	test whether automatic text indentation is activated
void	set_insert_spaces_instead_of_tabs (bool enable=true)
	activate (or de-activate) the replacement of any inserted tabulator character by a group of space character
bool	get_insert_spaces_instead_of_tabs () const
	test whether the replacement of any inserted tabulator character by a group of space character is activated
void	set_show_margin (bool show=true)
	activate (or de-activate) the display of a margin
bool	get_show_margin () const
	test if a margin is displayed
void	set_highlight_current_line (bool highlight=true)
	do highlight the currently selected line, or not
bool	get_highlight_current_line () const
	test if the currently selected line is to be hightlighted
void	set_margin (guint margin)
	set the position of the right margin
guint	get_margin () const
	get the position of the right margin
void	set_marker_pixbuf (const Glib::ustring &marker, Glib::RefPtr< Gdk::Pixbuf > pixbuf)
	associates a marker pixbuf with a given marker name
Glib::RefPtr< Gdk::Pixbuf >	get_marker_pixbuf (const Glib::ustring &marker)
	get the marker pixbuf associated to a given marker name
Glib::RefPtr< const Gdk::Pixbuf >	get_marker_pixbuf (const Glib::ustring &marker) const
	get the marker pixbuf associated to a given marker name
void	set_smart_home_end (bool enable=true)
	activate whether if HOME and END keys will move to the first/last non space character of the line before moving to the start/end
bool	get_smart_home_end () const
	test whether if HOME and END keys will move to the first/last non space character of the line before moving to the start/end
Glib::SignalProxy0< void >	signal_redo ()
Glib::SignalProxy0< void >	signal_undo ()
Static Public Member Functions
static GType	get_type () G_GNUC_CONST
static GType	get_base_type () G_GNUC_CONST
static Glib::RefPtr< SourceView >	create ()
static Glib::RefPtr< SourceView >	create (Glib::RefPtr< SourceBuffer > &buffer)
Protected Member Functions
	SourceView (const Glib::ConstructParams &construct_params)
	SourceView (GtkSourceView *castitem)
Friends
class	SourceView_Class
Related Functions
(Note that these are not member functions.)
gtksourceview::SourceView *	wrap (GtkSourceView *object, bool take_copy=false)

---

Detailed Description

Multi-line source editing widget.

It displays a Gtk::SourceBuffer.

---

Member Typedef Documentation

typedef GtkSourceViewClass gtksourceview::SourceView::BaseClassType

typedef GtkSourceView gtksourceview::SourceView::BaseObjectType

typedef SourceView_Class gtksourceview::SourceView::CppClassType

typedef SourceView gtksourceview::SourceView::CppObjectType

---

Constructor & Destructor Documentation

virtual gtksourceview::SourceView::~SourceView (   )  [virtual]

gtksourceview::SourceView::SourceView (  const Glib::ConstructParams &  construct_params  )  [explicit, protected]

gtksourceview::SourceView::SourceView (  GtkSourceView *  castitem  )  [explicit, protected]

gtksourceview::SourceView::SourceView (   )  [explicit]

default constructor

gtksourceview::SourceView::SourceView (  Glib::RefPtr< SourceBuffer > &  buffer  )  [explicit]

constructor. create an instance of SourceView displaying a given buffer Parameters: buffer  the buffer to display in the SourceView

---

Member Function Documentation

static Glib::RefPtr<SourceView> gtksourceview::SourceView::create (  Glib::RefPtr< SourceBuffer > &  buffer  )  [static]

static Glib::RefPtr<SourceView> gtksourceview::SourceView::create (   )  [static]

bool gtksourceview::SourceView::get_auto_indent (   )  const

test whether automatic text indentation is activated Returns: true if automatic text indentation is activated, false otherwise

static GType gtksourceview::SourceView::get_base_type (   )  [static]

bool gtksourceview::SourceView::get_highlight_current_line (   )  const

test if the currently selected line is to be hightlighted Returns: true if the currently selected line is to be highlighted, false otherwise

bool gtksourceview::SourceView::get_insert_spaces_instead_of_tabs (   )  const

test whether the replacement of any inserted tabulator character by a group of space character is activated Returns: true if the replacement of any inserted tabulator character by a group of space character is activated, false otherwise

guint gtksourceview::SourceView::get_margin (   )  const

get the position of the right margin Returns: the position of the right margin

Glib::RefPtr<const Gdk::Pixbuf> gtksourceview::SourceView::get_marker_pixbuf (  const Glib::ustring &  marker  )  const

get the marker pixbuf associated to a given marker name Parameters: marker  the marker name to consider Returns: the pixbuf, or nil if no pixbuf is associated to the given marker name

Glib::RefPtr<Gdk::Pixbuf> gtksourceview::SourceView::get_marker_pixbuf (  const Glib::ustring &  marker  )

get the marker pixbuf associated to a given marker name Parameters: marker  the marker name to consider Returns: the pixbuf, or nil if no pixbuf is associated to the given marker name

bool gtksourceview::SourceView::get_show_line_markers (   )  const

test whether if line markers are displayed beside the text Returns: true if line markers are displayed beside the text, false otherwise

bool gtksourceview::SourceView::get_show_line_numbers (   )  const

test whether line numbers are displayed beside the text Returns: true if line numbers are displayed beside the text, false otherwise

bool gtksourceview::SourceView::get_show_margin (   )  const

test if a margin is displayed Returns: true if a margin is displayed, false otherwise

bool gtksourceview::SourceView::get_smart_home_end (   )  const

test whether if HOME and END keys will move to the first/last non space character of the line before moving to the start/end Returns: true if HOME and END keys will move to the first/last non space character of the line before moving to the start/end, false otherwise

Glib::RefPtr<SourceBuffer> gtksourceview::SourceView::get_source_buffer (   )

get the source buffer associated to the current instance Returns: the source buffer associated to the current instance

Glib::RefPtr<const SourceBuffer> gtksourceview::SourceView::get_source_buffer (   )  const

get the source buffer associated to the current instance Returns: the source buffer associated to the current instance

guint gtksourceview::SourceView::get_tabs_width (   )  const

get tab width Returns: the tab width

static GType gtksourceview::SourceView::get_type (   )  [static]

const GtkSourceView* gtksourceview::SourceView::gobj (   )  const [inline]

Provides access to the underlying C GtkObject.

GtkSourceView* gtksourceview::SourceView::gobj (   )  [inline]

Provides access to the underlying C GtkObject.

void gtksourceview::SourceView::set_auto_indent (  bool  enable = true  )

set automatic text indention or not Parameters: enable  if true, automatic text indentation is activated

void gtksourceview::SourceView::set_highlight_current_line (  bool  highlight = true  )

do highlight the currently selected line, or not Parameters: highlight  if true, do highlight the currently selected line

void gtksourceview::SourceView::set_insert_spaces_instead_of_tabs (  bool  enable = true  )

activate (or de-activate) the replacement of any inserted tabulator character by a group of space character Parameters: enable  if true, any tabulator character inserted is replaced by a group of space character

void gtksourceview::SourceView::set_margin (  guint  margin  )

set the position of the right margin Parameters: margin  the position (in pixels) of the right margin

void gtksourceview::SourceView::set_marker_pixbuf (  const Glib::ustring &  marker, Glib::RefPtr< Gdk::Pixbuf >  pixbuf )

associates a marker pixbuf with a given marker name Parameters: marker  the marker name to consider pixbuf  the new pixbuf

void gtksourceview::SourceView::set_show_line_markers (  bool  show = true  )

display line markers beside the text, nor not. Parameters: show  if true, line markers will be displayed beside the text

void gtksourceview::SourceView::set_show_line_numbers (  bool  show = true  )

display line numbers beside the text, or not Parameters: show  if true, line numbers will be displayed beside test text.

void gtksourceview::SourceView::set_show_margin (  bool  show = true  )

activate (or de-activate) the display of a margin Parameters: show  if true, activate the display of a margin

void gtksourceview::SourceView::set_smart_home_end (  bool  enable = true  )

activate whether if HOME and END keys will move to the first/last non space character of the line before moving to the start/end if true, HOME and END keys will move to the first/last non space character of the line before moving to the start/end

void gtksourceview::SourceView::set_source_buffer (  Glib::RefPtr< SourceBuffer > &  source_buffer  )

set the source buffer to be displayed by the SourceView Parameters: source_buffer  the source buffer to set

void gtksourceview::SourceView::set_tabs_width (  guint  width  )

set tabs width Parameters: width  the new tab width

Glib::SignalProxy0< void > gtksourceview::SourceView::signal_redo (   )

Glib::SignalProxy0< void > gtksourceview::SourceView::signal_undo (   )

---

Friends And Related Function Documentation

friend class SourceView_Class [friend]

gtksourceview::SourceView * wrap (  GtkSourceView *  object, bool  take_copy = false )  [related]

Parameters: object  The C instance take_copy  False if the result should take ownership of the C instance. True if it should take a new copy or ref. Returns: A C++ instance that wraps this C instance.

---

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

• sourceview.h

---