gtksourceview::SourceGutter Class Reference

Inherits Glib::Object.

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

List of all members.

Public Types

typedef sigc::slot< void,
Gtk::CellRenderer*, int, bool > 
SlotData
 For instance, void on_cell_data(Gtk::CellRenderer& cell, int line_number, bool current_line);.
typedef sigc::slot< void,
Gtk::CellRenderer* > 
SlotSize
 For instance, void on_cell_size(Gtk::CellRenderer& cell);.

Public Member Functions

virtual ~SourceGutter ()
GtkSourceGutter* gobj ()
 Provides access to the underlying C GObject.
const GtkSourceGutter* gobj () const
 Provides access to the underlying C GObject.
GtkSourceGutter* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::RefPtr< Gdk::Windowget_window ()
 Get the Gdk::Window of the gutter.
Glib::RefPtr< const Gdk::Windowget_window () const
 Get the Gdk::Window of the gutter.
void insert (Gtk::CellRenderer* renderer, int position)
 Inserts renderer into gutter at position.
void reorder (Gtk::CellRenderer* renderer, int position)
 Reorders renderer in gutter to new position.
void remove (Gtk::CellRenderer* renderer)
 Removes renderer from gutter.
void queue_draw ()
 Invalidates the drawable area of the gutter.
void set_cell_data_func (Gtk::CellRenderer* renderer, const SlotData& slot)
void set_cell_size_func (Gtk::CellRenderer* renderer, const SlotSize& slot)
void reset_cell_data_func (Gtk::CellRenderer* renderer)
void reset_cell_size_func (Gtk::CellRenderer* renderer)
Glib::PropertyProxy_ReadOnly
< SourceView* > 
property_view () const
 The gutters' GtkSourceView.
Glib::PropertyProxy_ReadOnly
< Gtk::TextWindowType
property_window_type () const
 The gutters text window type.
Glib::SignalProxy3< void,
Gtk::CellRenderer *, const
Gtk::TextIter&, GdkEvent* > 
signal_cell_activated ()
Glib::SignalProxy3< bool,
Gtk::CellRenderer *, const
Gtk::TextIter &, const
Glib::RefPtr< Gtk::Tooltip >& > 
signal_query_tooltip ()

Static Public Member Functions

static Glib::RefPtr< SourceGuttercreate ()

Protected Member Functions

 SourceGutter ()
virtual void on_cell_activated (Gtk::CellRenderer* renderer, const Gtk::TextIter& iter, GdkEvent* event)
virtual bool on_query_tooltip (Gtk::CellRenderer* renderer, const Gtk::TextIter& iter, const Glib::RefPtr< Gtk::Tooltip >& tooltip)

Related Functions

(Note that these are not member functions.)



Glib::RefPtr
< gtksourceview::SourceGutter
wrap (GtkSourceGutter* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Member Typedef Documentation

For instance, void on_cell_data(Gtk::CellRenderer& cell, int line_number, bool current_line);.

For instance, void on_cell_size(Gtk::CellRenderer& cell);.


Constructor & Destructor Documentation

virtual gtksourceview::SourceGutter::~SourceGutter (  )  [virtual]
gtksourceview::SourceGutter::SourceGutter (  )  [protected]

Member Function Documentation

static Glib::RefPtr<SourceGutter> gtksourceview::SourceGutter::create (  )  [static]
Glib::RefPtr<const Gdk::Window> gtksourceview::SourceGutter::get_window (  )  const

Get the Gdk::Window of the gutter.

The window will only be available when the gutter has at least one, non-zero width, cell renderer packed.

Returns:
The Gdk::Window of the gutter, or 0 if the gutter has no window.
Since gtksourceviewmm 2.8:
Glib::RefPtr<Gdk::Window> gtksourceview::SourceGutter::get_window (  ) 

Get the Gdk::Window of the gutter.

The window will only be available when the gutter has at least one, non-zero width, cell renderer packed.

Returns:
The Gdk::Window of the gutter, or 0 if the gutter has no window.
Since gtksourceviewmm 2.8:
const GtkSourceGutter* gtksourceview::SourceGutter::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkSourceGutter* gtksourceview::SourceGutter::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkSourceGutter* gtksourceview::SourceGutter::gobj_copy (  ) 

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

void gtksourceview::SourceGutter::insert ( Gtk::CellRenderer renderer,
int  position 
)

Inserts renderer into gutter at position.

Since gtksourceviewmm 2.8:
Parameters:
renderer A Gtk::CellRenderer.
position The renderers position.
virtual void gtksourceview::SourceGutter::on_cell_activated ( Gtk::CellRenderer renderer,
const Gtk::TextIter iter,
GdkEvent *  event 
) [protected, virtual]
virtual bool gtksourceview::SourceGutter::on_query_tooltip ( Gtk::CellRenderer renderer,
const Gtk::TextIter iter,
const Glib::RefPtr< Gtk::Tooltip > &  tooltip 
) [protected, virtual]
Glib::PropertyProxy_ReadOnly<SourceView*> gtksourceview::SourceGutter::property_view (  )  const

The gutters' GtkSourceView.

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<Gtk::TextWindowType> gtksourceview::SourceGutter::property_window_type (  )  const

The gutters text window type.

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::SourceGutter::queue_draw (  ) 

Invalidates the drawable area of the gutter.

You can use this to force a redraw of the gutter if something has changed and needs to be redrawn.

Since gtksourceviewmm 2.8:
void gtksourceview::SourceGutter::remove ( Gtk::CellRenderer renderer  ) 

Removes renderer from gutter.

Since gtksourceviewmm 2.8:
Parameters:
renderer A Gtk::CellRenderer.
void gtksourceview::SourceGutter::reorder ( Gtk::CellRenderer renderer,
int  position 
)

Reorders renderer in gutter to new position.

Since gtksourceviewmm 2.8:
Parameters:
renderer A Gtk::CellRenderer.
position The new renderer position.
void gtksourceview::SourceGutter::reset_cell_data_func ( Gtk::CellRenderer renderer  ) 
void gtksourceview::SourceGutter::reset_cell_size_func ( Gtk::CellRenderer renderer  ) 
void gtksourceview::SourceGutter::set_cell_data_func ( Gtk::CellRenderer renderer,
const SlotData slot 
)
void gtksourceview::SourceGutter::set_cell_size_func ( Gtk::CellRenderer renderer,
const SlotSize slot 
)
Glib::SignalProxy3< void,Gtk::CellRenderer*,const Gtk::TextIter&,GdkEvent* > gtksourceview::SourceGutter::signal_cell_activated (  ) 
Prototype:
void on_my_cell_activated(Gtk::CellRenderer* renderer, const Gtk::TextIter& iter, GdkEvent* event)
Glib::SignalProxy3< bool,Gtk::CellRenderer*,const Gtk::TextIter&,const Glib::RefPtr<Gtk::Tooltip>& > gtksourceview::SourceGutter::signal_query_tooltip (  ) 
Prototype:
bool on_my_query_tooltip(Gtk::CellRenderer* renderer, const Gtk::TextIter& iter, const Glib::RefPtr<Gtk::Tooltip>& tooltip)

Friends And Related Function Documentation

Glib::RefPtr< gtksourceview::SourceGutter > wrap ( GtkSourceGutter *  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