gtksourceview::SourceMark Class Reference

Inherits Gtk::TextMark.

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

List of all members.

Public Member Functions

virtual ~SourceMark ()
GtkSourceMark* gobj ()
 Provides access to the underlying C GObject.
const GtkSourceMark* gobj () const
 Provides access to the underlying C GObject.
GtkSourceMark* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ustring get_category () const
 Returns: the category of the Gtk::SourceMark.
Glib::RefPtr< SourceMarknext (const Glib::ustring& category)
 Returns: the next Gtk::SourceMark or 0.
Glib::RefPtr< const SourceMarknext (const Glib::ustring& category) const
 Returns: the next Gtk::SourceMark or 0.
Glib::RefPtr< SourceMarknext ()
Glib::RefPtr< const SourceMarknext () const
Glib::RefPtr< SourceMarkprev (const Glib::ustring& category)
 Returns: the previous Gtk::SourceMark or 0.
Glib::RefPtr< const SourceMarkprev (const Glib::ustring& category) const
 Returns: the previous Gtk::SourceMark or 0.
Glib::RefPtr< SourceMarkprev ()
Glib::RefPtr< const SourceMarkprev () const
Glib::PropertyProxy_ReadOnly
< Glib::ustring
property_category () const
 The mark category.

Static Public Member Functions

static Glib::RefPtr< SourceMarkcreate (const Glib::ustring& category, const Glib::ustring& name=Glib::ustring())

Protected Member Functions

 SourceMark ()
 SourceMark (const Glib::ustring& category, const Glib::ustring& name=Glib::ustring())

Related Functions

(Note that these are not member functions.)



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

Constructor & Destructor Documentation

virtual gtksourceview::SourceMark::~SourceMark (  )  [virtual]
gtksourceview::SourceMark::SourceMark (  )  [protected]
gtksourceview::SourceMark::SourceMark ( const Glib::ustring category,
const Glib::ustring name = Glib::ustring() 
) [explicit, protected]

Member Function Documentation

static Glib::RefPtr<SourceMark> gtksourceview::SourceMark::create ( const Glib::ustring category,
const Glib::ustring name = Glib::ustring() 
) [static]
Glib::ustring gtksourceview::SourceMark::get_category (  )  const

Returns: the category of the Gtk::SourceMark.

Returns:
The category of the Gtk::SourceMark
Since gtksourceviewmm 2.2:
const GtkSourceMark* gtksourceview::SourceMark::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gtk::TextMark.

GtkSourceMark* gtksourceview::SourceMark::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Gtk::TextMark.

GtkSourceMark* gtksourceview::SourceMark::gobj_copy (  ) 

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

Reimplemented from Gtk::TextMark.

Glib::RefPtr<const SourceMark> gtksourceview::SourceMark::next (  )  const
Glib::RefPtr<SourceMark> gtksourceview::SourceMark::next (  ) 
Glib::RefPtr<const SourceMark> gtksourceview::SourceMark::next ( const Glib::ustring category  )  const

Returns: the next Gtk::SourceMark or 0.

Parameters:
category A string specifying the mark category or 0.
Returns:
The next Gtk::SourceMark or 0
Since gtksourceviewmm 2.2:
Glib::RefPtr<SourceMark> gtksourceview::SourceMark::next ( const Glib::ustring category  ) 

Returns: the next Gtk::SourceMark or 0.

Parameters:
category A string specifying the mark category or 0.
Returns:
The next Gtk::SourceMark or 0
Since gtksourceviewmm 2.2:
Glib::RefPtr<const SourceMark> gtksourceview::SourceMark::prev (  )  const
Glib::RefPtr<SourceMark> gtksourceview::SourceMark::prev (  ) 
Glib::RefPtr<const SourceMark> gtksourceview::SourceMark::prev ( const Glib::ustring category  )  const

Returns: the previous Gtk::SourceMark or 0.

Parameters:
category A string specifying the mark category or 0.
Returns:
The previous Gtk::SourceMark or 0
Since gtksourceviewmm 2.2:
Glib::RefPtr<SourceMark> gtksourceview::SourceMark::prev ( const Glib::ustring category  ) 

Returns: the previous Gtk::SourceMark or 0.

Parameters:
category A string specifying the mark category or 0.
Returns:
The previous Gtk::SourceMark or 0
Since gtksourceviewmm 2.2:
Glib::PropertyProxy_ReadOnly<Glib::ustring> gtksourceview::SourceMark::property_category (  )  const

The mark category.

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.

Friends And Related Function Documentation

Glib::RefPtr< gtksourceview::SourceMark > wrap ( GtkSourceMark *  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