gtksourceview::SourceStyleSchemeManager Class Reference

Inherits Glib::Object.

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

List of all members.

Public Member Functions

virtual ~SourceStyleSchemeManager ()
GtkSourceStyleSchemeManager* gobj ()
 Provides access to the underlying C GObject.
const GtkSourceStyleSchemeManager* gobj () const
 Provides access to the underlying C GObject.
GtkSourceStyleSchemeManager* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void set_search_path (const Glib::StringArrayHandle& path)
 Sets the list of directories where the manager looks for style scheme files.
void reset_search_path ()
 Set the search path to the default.
Glib::StringArrayHandle get_search_path () const
 Returns: a 0-terminated array of string containing the search path.
void append_search_path (const Glib::ustring& path)
 Appends path to the list of directories where the manager looks for style scheme files.
void prepend_search_path (const Glib::ustring& path)
 Prepends path to the list of directories where the manager looks for style scheme files.
Glib::RefPtr< SourceStyleSchemeget_scheme (const Glib::ustring& scheme_id)
 Looks up style scheme by id.
Glib::RefPtr< const
SourceStyleScheme
get_scheme (const Glib::ustring& scheme_id) const
 Looks up style scheme by id.
void force_rescan ()
 Mark any currently cached information about the available style scehems as invalid.
Glib::StringArrayHandle get_scheme_ids () const
 Returns: a 0-terminated array of string containing the ids of the.

Static Public Member Functions

static Glib::RefPtr
< SourceStyleSchemeManager
create ()
static Glib::RefPtr
< SourceStyleSchemeManager
get_default ()
 Returns: a Gtk::SourceStyleSchemeManager.

Protected Member Functions

 SourceStyleSchemeManager ()

Related Functions

(Note that these are not member functions.)



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

Constructor & Destructor Documentation

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

Member Function Documentation

void gtksourceview::SourceStyleSchemeManager::append_search_path ( const Glib::ustring path  ) 

Appends path to the list of directories where the manager looks for style scheme files.

See set_search_path() for details.

Parameters:
path A directory or a filename.
static Glib::RefPtr<SourceStyleSchemeManager> gtksourceview::SourceStyleSchemeManager::create (  )  [static]
void gtksourceview::SourceStyleSchemeManager::force_rescan (  ) 

Mark any currently cached information about the available style scehems as invalid.

All the available style schemes will be reloaded next time the manager is accessed.

static Glib::RefPtr<SourceStyleSchemeManager> gtksourceview::SourceStyleSchemeManager::get_default (  )  [static]

Returns: a Gtk::SourceStyleSchemeManager.

Return value is owned

Returns:
A Gtk::SourceStyleSchemeManager. Return value is owned by GtkSourceView library and must not be unref'ed.
Glib::RefPtr<const SourceStyleScheme> gtksourceview::SourceStyleSchemeManager::get_scheme ( const Glib::ustring scheme_id  )  const

Looks up style scheme by id.

Parameters:
scheme_id Style scheme id to find.
Returns:
A Gtk::SourceStyleScheme object. Returned value is owned by manager and must not be unref'ed.
Glib::RefPtr<SourceStyleScheme> gtksourceview::SourceStyleSchemeManager::get_scheme ( const Glib::ustring scheme_id  ) 

Looks up style scheme by id.

Parameters:
scheme_id Style scheme id to find.
Returns:
A Gtk::SourceStyleScheme object. Returned value is owned by manager and must not be unref'ed.
Glib::StringArrayHandle gtksourceview::SourceStyleSchemeManager::get_scheme_ids (  )  const

Returns: a 0-terminated array of string containing the ids of the.

Returns:
A 0-terminated array of string containing the ids of the available style schemes or 0 if no style scheme is available. The array is owned by the manager and must not be modified.
Glib::StringArrayHandle gtksourceview::SourceStyleSchemeManager::get_search_path (  )  const

Returns: a 0-terminated array of string containing the search path.

Returns:
A 0-terminated array of string containing the search path. The array is owned by the manager and must not be modified.
const GtkSourceStyleSchemeManager* gtksourceview::SourceStyleSchemeManager::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkSourceStyleSchemeManager* gtksourceview::SourceStyleSchemeManager::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::ObjectBase.

GtkSourceStyleSchemeManager* gtksourceview::SourceStyleSchemeManager::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::SourceStyleSchemeManager::prepend_search_path ( const Glib::ustring path  ) 

Prepends path to the list of directories where the manager looks for style scheme files.

See set_search_path() for details.

Parameters:
path A directory or a filename.
void gtksourceview::SourceStyleSchemeManager::reset_search_path (  ) 

Set the search path to the default.

void gtksourceview::SourceStyleSchemeManager::set_search_path ( const Glib::StringArrayHandle path  ) 

Sets the list of directories where the manager looks for style scheme files.

If dirs is 0, the search path is reset to default.

Parameters:
path A 0-terminated array of strings or 0.

Friends And Related Function Documentation

Glib::RefPtr< gtksourceview::SourceStyleSchemeManager > wrap ( GtkSourceStyleSchemeManager *  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