gtksourceviewmm 3.18.0
Gsv::StyleSchemeManager Class Reference

Class providing access to SourceStyleSchemes. More...

#include <gtksourceviewmm/styleschememanager.h>

Inherits Glib::Object.

Public Member Functions

 StyleSchemeManager (StyleSchemeManager&& src) noexcept
 
StyleSchemeManageroperator= (StyleSchemeManager&& src) noexcept
 
 ~StyleSchemeManager () noexcept override
 
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.
 
std::vector< std::stringget_search_path () const
 Returns the current search path for the manager.
 
void set_search_path (const std::vector< std::string >& path)
 Sets the list of directories where the manager looks for style scheme files.
 
void reset_search_path ()
 Resets the list of directories where the manager looks for style scheme files to default.
 
void append_search_path (const std::string& path)
 Appends path to the list of directories where the manager looks for style scheme files.
 
void prepend_search_path (const std::string& path)
 Prepends path to the list of directories where the manager looks for style scheme files.
 
Glib::RefPtr< StyleSchemeget_scheme (const std::string& scheme_id)
 Looks up style scheme by id.
 
Glib::RefPtr< const StyleSchemeget_scheme (const std::string& scheme_id) const
 Looks up style scheme by id.
 
void force_rescan ()
 Mark any currently cached information about the available style schemes as invalid.
 
std::vector< std::stringget_scheme_ids () const
 Returns the ids of the available style schemes.
 
Glib::PropertyProxy< std::vector< std::string > > property_search_path ()
 List of directories and files where the style schemes are located.
 
Glib::PropertyProxy_ReadOnly< std::vector< std::string > > property_search_path () const
 List of directories and files where the style schemes are located.
 
Glib::PropertyProxy_ReadOnly< std::vector< std::string > > property_scheme_ids () const
 List of the ids of the available style schemes.
 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system.
 
static Glib::RefPtr< StyleSchemeManagercreate ()
 Creates a new style manager.
 
static Glib::RefPtr< StyleSchemeManagerget_default ()
 Returns the default StyleSchemeManager instance.
 

Protected Member Functions

 StyleSchemeManager ()
 

Related Symbols

(Note that these are not member symbols.)

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

Detailed Description

Class providing access to SourceStyleSchemes.

Constructor & Destructor Documentation

◆ StyleSchemeManager() [1/2]

Gsv::StyleSchemeManager::StyleSchemeManager ( StyleSchemeManager&& src)
noexcept

◆ ~StyleSchemeManager()

Gsv::StyleSchemeManager::~StyleSchemeManager ( )
overridenoexcept

◆ StyleSchemeManager() [2/2]

Gsv::StyleSchemeManager::StyleSchemeManager ( )
protected

Member Function Documentation

◆ append_search_path()

void Gsv::StyleSchemeManager::append_search_path ( const std::string & path)

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

See set_search_path() for details.

Parameters
pathA directory or a filename.

◆ create()

static Glib::RefPtr< StyleSchemeManager > Gsv::StyleSchemeManager::create ( )
static

Creates a new style manager.

If you do not need more than one style manager then use get_default() instead.

Returns
A StyleSchemeManager.

◆ force_rescan()

void Gsv::StyleSchemeManager::force_rescan ( )

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

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

◆ get_default()

static Glib::RefPtr< StyleSchemeManager > Gsv::StyleSchemeManager::get_default ( )
static

Returns the default StyleSchemeManager instance.

Returns
A StyleSchemeManager.

◆ get_scheme() [1/2]

Glib::RefPtr< StyleScheme > Gsv::StyleSchemeManager::get_scheme ( const std::string & scheme_id)

Looks up style scheme by id.

Parameters
scheme_idStyle scheme id to find.
Returns
A StyleScheme object.

◆ get_scheme() [2/2]

Glib::RefPtr< const StyleScheme > Gsv::StyleSchemeManager::get_scheme ( const std::string & scheme_id) const

Looks up style scheme by id.

Parameters
scheme_idStyle scheme id to find.
Returns
A StyleScheme object.

◆ get_scheme_ids()

std::vector< std::string > Gsv::StyleSchemeManager::get_scheme_ids ( ) const

Returns the ids of the available style schemes.

Returns
An array of string containing the ids of the available style schemes.

◆ get_search_path()

std::vector< std::string > Gsv::StyleSchemeManager::get_search_path ( ) const

Returns the current search path for the manager.

See set_search_path() for details.

Returns
An array of string containing the search path.

◆ get_type()

static GType Gsv::StyleSchemeManager::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

GtkSourceStyleSchemeManager * Gsv::StyleSchemeManager::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkSourceStyleSchemeManager * Gsv::StyleSchemeManager::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkSourceStyleSchemeManager * Gsv::StyleSchemeManager::gobj_copy ( )

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

◆ operator=()

StyleSchemeManager& Gsv::StyleSchemeManager::operator= ( StyleSchemeManager&& src)
noexcept

◆ prepend_search_path()

void Gsv::StyleSchemeManager::prepend_search_path ( const std::string & path)

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

See set_search_path() for details.

Parameters
pathA directory or a filename.

◆ property_scheme_ids()

Glib::PropertyProxy_ReadOnly< std::vector< std::string > > Gsv::StyleSchemeManager::property_scheme_ids ( ) const

List of the ids of the available style schemes.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ property_search_path() [1/2]

Glib::PropertyProxy< std::vector< std::string > > Gsv::StyleSchemeManager::property_search_path ( )

List of directories and files where the style schemes are located.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.

◆ property_search_path() [2/2]

Glib::PropertyProxy_ReadOnly< std::vector< std::string > > Gsv::StyleSchemeManager::property_search_path ( ) const

List of directories and files where the style schemes are located.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

◆ reset_search_path()

void Gsv::StyleSchemeManager::reset_search_path ( )

Resets the list of directories where the manager looks for style scheme files to default.

◆ set_search_path()

void Gsv::StyleSchemeManager::set_search_path ( const std::vector< std::string > & path)

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

Parameters
pathAn empty string terminated array of strings.

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gsv::StyleSchemeManager > wrap ( GtkSourceStyleSchemeManager * object,
bool take_copy = false )
related

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

Parameters
objectThe C instance.
take_copyFalse 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.