gtksourceviewmm 3.2.0
|
Object representing a syntax highlighted language. More...
#include <gtksourceviewmm/language.h>
Public Member Functions | |
GtkSourceLanguage* | gobj () |
Provides access to the underlying C GObject. | |
const GtkSourceLanguage* | gobj () const |
Provides access to the underlying C GObject. | |
GtkSourceLanguage* | 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_id () const |
Returns the ID of a language. | |
Glib::ustring | get_name () const |
Returns the localized name of the language. | |
Glib::ustring | get_section () const |
Returns the localized section of the language. | |
bool | get_hidden () const |
Returns whether the language should be hidden from the user. | |
std::vector< Glib::ustring > | get_mime_types () const |
Returns the mime types associated to this language. | |
std::vector< Glib::ustring > | get_globs () const |
Returns the globs associated to this language. | |
std::vector< Glib::ustring > | get_style_ids () const |
Returns the ids of the styles defined by this language. | |
Glib::ustring | get_style_name (const Glib::ustring& style_id) const |
Returns the name of the style with ID style_id defined by this language. | |
Glib::ustring | get_metadata (const Glib::ustring& name) const |
Returns metadata of a language. | |
Glib::PropertyProxy_ReadOnly < std::string > | property_id () const |
Language id. | |
Glib::PropertyProxy_ReadOnly < std::string > | property_name () const |
Language name. | |
Glib::PropertyProxy_ReadOnly < std::string > | property_section () const |
Language section. | |
Glib::PropertyProxy_ReadOnly < bool > | property_hidden () const |
Whether the language should be hidden from the user. | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gsv::Language > | wrap (GtkSourceLanguage* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
Object representing a syntax highlighted language.
Language encapsulates syntax and highlighting styles for a particular language. Use LanguageManager to obtain a Language instance, and Buffer::set_language() to apply it to a Buffer.
std::vector<Glib::ustring> Gsv::Language::get_globs | ( | ) | const |
Returns the globs associated to this language.
This is just a utility wrapper around get_metadata() to retrieve the "globs" metadata property and split it into an array.
bool Gsv::Language::get_hidden | ( | ) | const |
Returns whether the language should be hidden from the user.
true
if the language should be hidden, false
otherwise. Glib::ustring Gsv::Language::get_id | ( | ) | const |
Returns the ID of a language.
The ID is not locale-dependent.
Glib::ustring Gsv::Language::get_metadata | ( | const Glib::ustring & | name | ) | const |
Returns metadata of a language.
name | Metadata property name. |
std::vector<Glib::ustring> Gsv::Language::get_mime_types | ( | ) | const |
Returns the mime types associated to this language.
This is just a utility wrapper around get_metadata() to retrieve the "mimetypes" metadata property and split it into an array.
Glib::ustring Gsv::Language::get_name | ( | ) | const |
Returns the localized name of the language.
Glib::ustring Gsv::Language::get_section | ( | ) | const |
Returns the localized section of the language.
Each language belong to a section (ex. HTML belogs to the Markup section).
std::vector<Glib::ustring> Gsv::Language::get_style_ids | ( | ) | const |
Returns the ids of the styles defined by this language.
Glib::ustring Gsv::Language::get_style_name | ( | const Glib::ustring & | style_id | ) | const |
Returns the name of the style with ID style_id defined by this language.
style_id | A style ID. |
Glib::PropertyProxy_ReadOnly<bool> Gsv::Language::property_hidden | ( | ) | const |
Whether the language should be hidden from the user.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<std::string> Gsv::Language::property_id | ( | ) | const |
Language id.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<std::string> Gsv::Language::property_name | ( | ) | const |
Language name.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<std::string> Gsv::Language::property_section | ( | ) | const |
Language section.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::RefPtr< Gsv::Language > wrap | ( | GtkSourceLanguage * | object, |
bool | take_copy = false |
||
) | [related] |
A Glib::wrap() method for this object.
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. |