gtksourceview::SourceView Class Reference

Multi-line source editing widget. More...

Inherits Gtk::TextView.

Collaboration diagram for gtksourceview::SourceView:
Collaboration graph
[legend]

List of all members.

Public Types

typedef sigc::slot
< Glib::ustring, const
Glib::RefPtr< SourceMark >& > 
SlotMarkTooltip
 For instance, Glib::ustring on_mark_tooltip(const Glib::RefPtr<SourceMark>& mark);.

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 (const Glib::RefPtr< SourceBuffer >& buffer)
 constructor.
Glib::RefPtr< const SourceBufferget_source_buffer () const
 get the source buffer associated to the current instance
Glib::RefPtr< SourceBufferget_source_buffer ()
 get the source buffer associated to the current instance
void set_source_buffer (const 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_tab_width (guint width)
 set tabs width
guint get_tab_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_right_margin (bool show=true)
 activate (or de-activate) the display of a margin
bool get_show_right_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_right_margin_position (guint margin)
 set the position of the right margin
guint get_right_margin_position () const
 get the position of the right margin
void set_smart_home_end (SourceSmartHomeEndType smart_he)
 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
SourceSmartHomeEndType 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
void set_show_line_marks (bool show=true)
 if true line marks will be displayed beside the text.
bool get_show_line_marks () const
 Returns whether line marks are displayed beside the text.
void set_indent_on_tab (bool show=true)
 If true, when the tab key is pressed and there is a selection, the selected text is indented of one level instead of being replaced with the characters.
bool get_indent_on_tab () const
 Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the character.
void set_indent_width (gint width)
 Sets the number of spaces to use for each step of indent.
gint get_indent_width () const
 Set Returns the number of spaces to use for each step of indent.
void set_mark_category_priority (const Glib::ustring& category, gint priority)
 Set the priority for the given mark category.
gint get_mark_category_priority (const Glib::ustring& category) const
 Gets the priority which is associated with the given category.
void set_mark_category_pixbuf (const Glib::ustring& category, const Glib::RefPtr< Gdk::Pixbuf >& pixbuf)
 Associates a given pixbuf with a given mark category.
Glib::RefPtr< Gdk::Pixbufget_mark_category_pixbuf (const Glib::ustring& category)
 Gets the pixbuf which is associated with the given mark category.
Glib::RefPtr< const Gdk::Pixbufget_mark_category_pixbuf (const Glib::ustring& category) const
 Gets the pixbuf which is associated with the given mark category.
void set_mark_category_icon (const Glib::ustring& category, const Glib::RefPtr< Gdk::Pixbuf >& pixbuf)
 Sets the icon to be used for category to pixbuf.
void set_mark_category_icon (const Glib::ustring& category, const Gtk::StockID& stock_id)
 Sets the icon to be used for category to the stock item stock_id.
void set_mark_category_icon (const Glib::ustring& category, const Glib::ustring& icon_name)
 Sets the icon to be used for category to the named theme item name.
void set_mark_category_background (const Glib::ustring& category, const Gdk::Color& color)
 Sets given background color for mark category.
bool set_mark_category_background (const Glib::ustring& category, Gdk::Color& dest) const
 Gets the background color associated with given category.
void set_draw_spaces (SourceDrawSpacesFlags flags=SOURCE_DRAW_SPACES_ALL)
 Set if and how the spaces should be visualized.
SourceDrawSpacesFlags get_draw_spaces () const
 Returns the SourceDrawSpacesFlags specifying if and how spaces should be displayed for this view.
void set_mark_category_tooltip_func (const Glib::ustring& category, const SlotMarkTooltip& slot)
void set_mark_category_tooltip_markup_func (const Glib::ustring& category, const SlotMarkTooltip& slot)
void unset_mark_category_tooltip_func (const Glib::ustring& category)
Glib::RefPtr< SourceGutterget_gutter (Gtk::TextWindowType window_type)
 Returns: the Gtk::SourceGutter.
Glib::RefPtr< const SourceGutterget_gutter (Gtk::TextWindowType window_type) const
 Returns: the Gtk::SourceGutter.
SourceCompletionget_completion ()
 Gets the Gtk::SourceCompletion associated with view.
const SourceCompletionget_completion () const
 Gets the Gtk::SourceCompletion associated with view.
Glib::SignalProxy0< void > signal_redo ()
Glib::SignalProxy0< void > signal_undo ()
Glib::SignalProxy0< void > signal_show_completion ()
Glib::SignalProxy2< void,
Gtk::TextIter&, GdkEvent* > 
signal_line_mark_activated ()
Glib::PropertyProxy< bool > property_show_line_numbers ()
 Whether to display line numbers.
Glib::PropertyProxy_ReadOnly
< bool > 
property_show_line_numbers () const
 Whether to display line numbers.
Glib::PropertyProxy< bool > property_show_line_marks ()
 Whether to display line mark pixbufs.
Glib::PropertyProxy_ReadOnly
< bool > 
property_show_line_marks () const
 Whether to display line mark pixbufs.
Glib::PropertyProxy< guint > property_tab_width ()
 Width of an tab character expressed in number of spaces.
Glib::PropertyProxy_ReadOnly
< guint > 
property_tab_width () const
 Width of a tab character expressed in spaces.
Glib::PropertyProxy< int > property_indent_width ()
 Width of an indentation step expressed in number of spaces.
Glib::PropertyProxy_ReadOnly< int > property_indent_width () const
 Number of spaces to use for each step of indent.
Glib::PropertyProxy< bool > property_auto_indent ()
 Whether to enable auto indentation.
Glib::PropertyProxy_ReadOnly
< bool > 
property_auto_indent () const
 Whether to enable auto indentation.
Glib::PropertyProxy< bool > property_insert_spaces_instead_of_tabs ()
 Whether to insert spaces instead of tabs.
Glib::PropertyProxy_ReadOnly
< bool > 
property_insert_spaces_instead_of_tabs () const
 Whether to insert spaces instead of tabs.
Glib::PropertyProxy< bool > property_show_right_margin ()
 Whether to display the right margin.
Glib::PropertyProxy_ReadOnly
< bool > 
property_show_right_margin () const
 Whether to display the right margin.
Glib::PropertyProxy< guint > property_right_margin_position ()
 Position of the right margin.
Glib::PropertyProxy_ReadOnly
< guint > 
property_right_margin_position () const
 Position of the right margin.
Glib::PropertyProxy
< SourceSmartHomeEndType
property_smart_home_end ()
 Set the behavior of the HOME and END keys.
Glib::PropertyProxy_ReadOnly
< SourceSmartHomeEndType
property_smart_home_end () const
 HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line.
Glib::PropertyProxy< bool > property_highlight_current_line ()
 Whether to highlight the current line.
Glib::PropertyProxy_ReadOnly
< bool > 
property_highlight_current_line () const
 Whether to highlight the current line.
Glib::PropertyProxy< bool > property_indent_on_tab ()
 Whether to indent the selected text when the tab key is pressed.
Glib::PropertyProxy_ReadOnly
< bool > 
property_indent_on_tab () const
 Whether to indent the selected text when the tab key is pressed.
Glib::PropertyProxy
< SourceDrawSpacesFlags
property_draw_spaces ()
 Set if and how the spaces should be visualized.
Glib::PropertyProxy_ReadOnly
< SourceDrawSpacesFlags
property_draw_spaces () const
 Set if and how the spaces should be visualized.

Static Public Member Functions

static Glib::RefPtr< SourceViewcreate ()
static Glib::RefPtr< SourceViewcreate (const Glib::RefPtr< SourceBuffer >& buffer)

Protected Member Functions

virtual void on_redo ()
virtual void on_undo ()

Related Functions

(Note that these are not member functions.)



gtksourceview::SourceViewwrap (GtkSourceView* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

Multi-line source editing widget.

It displays a Gtk::SourceBuffer.


Member Typedef Documentation

For instance, Glib::ustring on_mark_tooltip(const Glib::RefPtr<SourceMark>& mark);.


Constructor & Destructor Documentation

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

default constructor

gtksourceview::SourceView::SourceView ( const 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 ( const 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
const SourceCompletion* gtksourceview::SourceView::get_completion (  )  const

Gets the Gtk::SourceCompletion associated with view.

Returns:
The Gtk::SourceCompletion associated with view.
SourceCompletion* gtksourceview::SourceView::get_completion (  ) 

Gets the Gtk::SourceCompletion associated with view.

Returns:
The Gtk::SourceCompletion associated with view.
SourceDrawSpacesFlags gtksourceview::SourceView::get_draw_spaces (  )  const

Returns the SourceDrawSpacesFlags specifying if and how spaces should be displayed for this view.

Returns:
flags the SourceDrawSpacesFlags, 0 if no spaces should be drawn.
Glib::RefPtr<const SourceGutter> gtksourceview::SourceView::get_gutter ( Gtk::TextWindowType  window_type  )  const

Returns: the Gtk::SourceGutter.

Parameters:
window_type The gutter window type.
Returns:
The Gtk::SourceGutter.
Glib::RefPtr<SourceGutter> gtksourceview::SourceView::get_gutter ( Gtk::TextWindowType  window_type  ) 

Returns: the Gtk::SourceGutter.

Parameters:
window_type The gutter window type.
Returns:
The Gtk::SourceGutter.
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_indent_on_tab (  )  const

Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the character.

Returns:
true if the selection is indented when tab is pressed.
gint gtksourceview::SourceView::get_indent_width (  )  const

Set Returns the number of spaces to use for each step of indent.

See SourceView::set_indent_width(gint) for details.

Returns:
indent width.
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
Glib::RefPtr<const Gdk::Pixbuf> gtksourceview::SourceView::get_mark_category_pixbuf ( const Glib::ustring category  )  const

Gets the pixbuf which is associated with the given mark category.

Parameters:
category a mark category.
Returns:
empty Glib::RefPtr<const Gdk::Pixbuf>.
Deprecated:
Don't use it.
Glib::RefPtr<Gdk::Pixbuf> gtksourceview::SourceView::get_mark_category_pixbuf ( const Glib::ustring category  ) 

Gets the pixbuf which is associated with the given mark category.

Parameters:
category a mark category.
Returns:
empty Glib::RefPtr<Gdk::Pixbuf>.
Deprecated:
Don't use it.
gint gtksourceview::SourceView::get_mark_category_priority ( const Glib::ustring category  )  const

Gets the priority which is associated with the given category.

Parameters:
category a mark category.
Returns:
the priority or if category exists but no priority was set, it defaults to 0.
guint gtksourceview::SourceView::get_right_margin_position (  )  const

get the position of the right margin

Returns:
the position of the right margin
bool gtksourceview::SourceView::get_show_line_marks (  )  const

Returns whether line marks are displayed beside the text.

Returns:
true if the line marks are displayed.
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_right_margin (  )  const

test if a margin is displayed

Returns:
true if a margin is displayed, false otherwise
SourceSmartHomeEndType 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_tab_width (  )  const

get tab width

Returns:
the tab width
const GtkSourceView* gtksourceview::SourceView::gobj (  )  const [inline]

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::TextView.

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

Provides access to the underlying C GtkObject.

Reimplemented from Gtk::TextView.

virtual void gtksourceview::SourceView::on_redo (  )  [protected, virtual]
virtual void gtksourceview::SourceView::on_undo (  )  [protected, virtual]
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_auto_indent (  )  const

Whether to enable auto indentation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_auto_indent (  ) 

Whether to enable auto indentation.

Default value is false Whether to enable auto indentation.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<SourceDrawSpacesFlags> gtksourceview::SourceView::property_draw_spaces (  )  const

Set if and how the spaces should be visualized.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<SourceDrawSpacesFlags> gtksourceview::SourceView::property_draw_spaces (  ) 

Set if and how the spaces should be visualized.

Default value is 0. Set if and how the spaces should be visualized.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_highlight_current_line (  )  const

Whether to highlight the current line.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_highlight_current_line (  ) 

Whether to highlight the current line.

Default value is false Whether to highlight the current line.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_indent_on_tab (  )  const

Whether to indent the selected text when the tab key is pressed.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_indent_on_tab (  ) 

Whether to indent the selected text when the tab key is pressed.

Default value is true. Whether to indent the selected text when the tab key is pressed.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<int> gtksourceview::SourceView::property_indent_width (  )  const

Number of spaces to use for each step of indent.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<int> gtksourceview::SourceView::property_indent_width (  ) 

Width of an indentation step expressed in number of spaces.

Allowed values are [-1,32] Default value is -1 Number of spaces to use for each step of indent.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_insert_spaces_instead_of_tabs (  )  const

Whether to insert spaces instead of tabs.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_insert_spaces_instead_of_tabs (  ) 

Whether to insert spaces instead of tabs.

Default value is false Whether to insert spaces instead of tabs.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<guint> gtksourceview::SourceView::property_right_margin_position (  )  const

Position of the right margin.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<guint> gtksourceview::SourceView::property_right_margin_position (  ) 

Position of the right margin.

Allowed values are [1,200] Default value is 80 Position of the right margin.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_show_line_marks (  )  const

Whether to display line mark pixbufs.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_show_line_marks (  ) 

Whether to display line mark pixbufs.

default value is false. Whether to display line mark pixbufs.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_show_line_numbers (  )  const

Whether to display line numbers.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_show_line_numbers (  ) 

Whether to display line numbers.

default value is false Whether to display line numbers.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<bool> gtksourceview::SourceView::property_show_right_margin (  )  const

Whether to display the right margin.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<bool> gtksourceview::SourceView::property_show_right_margin (  ) 

Whether to display the right margin.

Default value is false Whether to display the right margin.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<SourceSmartHomeEndType> gtksourceview::SourceView::property_smart_home_end (  )  const

HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<SourceSmartHomeEndType> gtksourceview::SourceView::property_smart_home_end (  ) 

Set the behavior of the HOME and END keys.

Default value is GTK_SOURCE_SMART_HOME_END_DISABLED HOME and END keys move to first/last non whitespace characters on line before going to the start/end of the line.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly<guint> gtksourceview::SourceView::property_tab_width (  )  const

Width of a tab character expressed in spaces.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
Glib::PropertyProxy<guint> gtksourceview::SourceView::property_tab_width (  ) 

Width of an tab character expressed in number of spaces.

Allowed values are [1,32] Default value is 8 Width of a tab character expressed in spaces.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.
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_draw_spaces ( SourceDrawSpacesFlags  flags = SOURCE_DRAW_SPACES_ALL  ) 

Set if and how the spaces should be visualized.

Parameters:
flags specifing how white spaces should be displayed.
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_indent_on_tab ( bool  show = true  ) 

If true, when the tab key is pressed and there is a selection, the selected text is indented of one level instead of being replaced with the characters.

Shift+Tab unindents the selection.

Parameters:
show true if the selection is indented when tab is pressed.
void gtksourceview::SourceView::set_indent_width ( gint  width  ) 

Sets the number of spaces to use for each step of indent.

If width is -1, the value of the GtkSourceView::tab-width property will be used.

Parameters:
width indent width in characters
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
bool gtksourceview::SourceView::set_mark_category_background ( const Glib::ustring category,
Gdk::Color dest 
) const

Gets the background color associated with given category.

Parameters:
category A mark category.
dest Destination Gdk::Color structure to fill in.
Returns:
true if background color for category was set and dest is set to a valid color, or false otherwise.
Since gtksourceviewmm 2.4:
void gtksourceview::SourceView::set_mark_category_background ( const Glib::ustring category,
const Gdk::Color color 
)

Sets given background color for mark category.

If color is #0, the background color is unset.

Since gtksourceviewmm 2.4:
Parameters:
category A mark category.
color Background color or 0 to unset it.
void gtksourceview::SourceView::set_mark_category_icon ( const Glib::ustring category,
const Glib::ustring icon_name 
)

Sets the icon to be used for category to the named theme item name.

If name is #0, the icon is unset.

Since gtksourceviewmm 2.8:
Parameters:
category A mark category.
name The themed icon name or #0.
void gtksourceview::SourceView::set_mark_category_icon ( const Glib::ustring category,
const Gtk::StockID stock_id 
)

Sets the icon to be used for category to the stock item stock_id.

If stock_id is #0, the icon is unset.

Since gtksourceviewmm 2.8:
Parameters:
category A mark category.
stock_id The stock id or #0.
void gtksourceview::SourceView::set_mark_category_icon ( const Glib::ustring category,
const Glib::RefPtr< Gdk::Pixbuf > &  pixbuf 
)

Sets the icon to be used for category to pixbuf.

If pixbuf is #0, the icon is unset.

Since gtksourceviewmm 2.8:
Parameters:
category A mark category.
pixbuf A Gdk::Pixbuf or #0.
void gtksourceview::SourceView::set_mark_category_pixbuf ( const Glib::ustring category,
const Glib::RefPtr< Gdk::Pixbuf > &  pixbuf 
)

Associates a given pixbuf with a given mark category.

If pixbuf is NULL, the pixbuf is unset.

Parameters:
category a mark category.
pixbuf the pixbuf to associate the mark category to.
Deprecated:
Use set_mark_category_icon().
void gtksourceview::SourceView::set_mark_category_priority ( const Glib::ustring category,
gint  priority 
)

Set the priority for the given mark category.

When there are multiple marks on the same line, marks of categories with higher priorities will be drawn on top.

Parameters:
category a mark category.
priority the priority of category
void gtksourceview::SourceView::set_mark_category_tooltip_func ( const Glib::ustring category,
const SlotMarkTooltip slot 
)
void gtksourceview::SourceView::set_mark_category_tooltip_markup_func ( const Glib::ustring category,
const SlotMarkTooltip slot 
)
void gtksourceview::SourceView::set_right_margin_position ( guint  margin  ) 

set the position of the right margin

Parameters:
margin the position (in pixels) of the right margin
void gtksourceview::SourceView::set_show_line_marks ( bool  show = true  ) 

if true line marks will be displayed beside the text.

Parameters:
show whether line marks should be displayed.
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_right_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 ( SourceSmartHomeEndType  smart_he  ) 

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 ( const 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_tab_width ( guint  width  ) 

set tabs width

Parameters:
width the new tab width
Glib::SignalProxy2< void,Gtk::TextIter&,GdkEvent* > gtksourceview::SourceView::signal_line_mark_activated (  ) 
Prototype:
void on_my_line_mark_activated(Gtk::TextIter& mark, GdkEvent* event)
Glib::SignalProxy0< void > gtksourceview::SourceView::signal_redo (  ) 
Prototype:
void on_my_redo()
Glib::SignalProxy0< void > gtksourceview::SourceView::signal_show_completion (  ) 
Prototype:
void on_my_show_completion()
Glib::SignalProxy0< void > gtksourceview::SourceView::signal_undo (  ) 
Prototype:
void on_my_undo()
void gtksourceview::SourceView::unset_mark_category_tooltip_func ( const Glib::ustring category  ) 

Friends And Related Function Documentation

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

A Glib::wrap() method for this object.

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:

Generated on 13 Jan 2010 for gtksourceviewmm by  doxygen 1.6.1