gtksourceviewmm  2.10.3
Public Member Functions | Related Functions
gtksourceview::SourceLanguage Class Reference

Object representing a syntax highlighted language. More...

#include <gtksourceviewmm/sourcelanguage.h>

Inheritance diagram for gtksourceview::SourceLanguage:
Inheritance graph
[legend]

List of all members.

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.
gboolean get_hidden () const
 Returns whether the language should be hidden from the user.
Glib::StringArrayHandle get_mime_types () const
 Returns the mime types associated to this language.
Glib::StringArrayHandle get_globs () const
 Returns the globs associated to this language.
Glib::StringArrayHandle 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.

Related Functions

(Note that these are not member functions.)

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

Detailed Description

Object representing a syntax highlighted language.

SourceLanguage encapsulates syntax and highlighting styles for a particular language. Use SourceLanguageManager to obtain a SourceLanguage instance, and SourceBuffer::set_language() to apply it to a SourceBuffer.


Member Function Documentation

Glib::StringArrayHandle gtksourceview::SourceLanguage::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.

Returns:
An array containing the globs.
gboolean gtksourceview::SourceLanguage::get_hidden ( ) const

Returns whether the language should be hidden from the user.

Returns:
true if the language should be hidden, false otherwise.
Glib::ustring gtksourceview::SourceLanguage::get_id ( ) const

Returns the ID of a language.

The ID is not locale-dependent.

Returns:
The ID of a language.
Glib::ustring gtksourceview::SourceLanguage::get_metadata ( const Glib::ustring name) const

Returns metadata of a language.

Parameters:
nameMetadata property name.
Returns:
Value of property name stored in the metadata of language or empty string if language doesn't contain that metadata property.
Glib::StringArrayHandle gtksourceview::SourceLanguage::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.

Returns:
An array containing the mime types.
Glib::ustring gtksourceview::SourceLanguage::get_name ( ) const

Returns the localized name of the language.

Returns:
The name of a language.
Glib::ustring gtksourceview::SourceLanguage::get_section ( ) const

Returns the localized section of the language.

Each language belong to a section (ex. HTML belogs to the Markup section).

Returns:
The section of a language.
Glib::StringArrayHandle gtksourceview::SourceLanguage::get_style_ids ( ) const

Returns the ids of the styles defined by this language.

Returns:
An array containing ids of the styles defined by this language.
Glib::ustring gtksourceview::SourceLanguage::get_style_name ( const Glib::ustring style_id) const

Returns the name of the style with ID style_id defined by this language.

Parameters:
style_idA style ID.
Returns:
The name of the style with ID style_id defined by this language or empty string if the style has no name or there is no style with ID style_id defined by this language.

Friends And Related Function Documentation

Glib::RefPtr< gtksourceview::SourceLanguage > wrap ( GtkSourceLanguage *  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.