gtksourceview::SourceLanguage Class Reference

The abstraction of a language. More...

#include <sourcelanguage.h>

List of all members.

Public Types

typedef SourceLanguage CppObjectType
typedef SourceLanguage_Class CppClassType
typedef GtkSourceLanguage BaseObjectType
typedef GtkSourceLanguageClass BaseClassType

Public Member Functions

virtual ~SourceLanguage ()
GtkSourceLanguagegobj ()
 Provides access to the underlying C GObject.
const GtkSourceLanguagegobj () const
 Provides access to the underlying C GObject.
GtkSourceLanguagegobj_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
 get language ID
Glib::ustring get_name () const
 gets the localized name of the language.
Glib::ustring get_section () const
 the localized section of the language.
Glib::SListHandle< Glib::RefPtr<
SourceTag > > 
get_tags ()
 gets the list of tags associated to the given language.
Glib::SListHandle< Glib::RefPtr<
const SourceTag > > 
get_tags () const
 gets the list of tags associated to the given language.
gunichar get_escape_char () const
 Gets the value of the ESC character in the given language.
Glib::SListHandle< Glib::ustring > get_mime_types () const
 gets the list of mime types for the given language.
void set_mime_types (const Glib::SListHandle< const Glib::ustring > &mime_types)
 Sets a list of mime_types for the given language.
Glib::RefPtr< SourceStyleSchemeget_style_scheme ()
 gets the style scheme associated to the language.
Glib::RefPtr< const SourceStyleSchemeget_style_scheme () const
 gets the style scheme associated to the language.
void set_style_scheme (Glib::RefPtr< SourceStyleScheme > scheme)
 sets the style scheme associated to the language
SourceTagStyle get_tag_style (const Glib::ustring &tag_id) const
 gets the style of the tag which ID is tag_id .
void set_tag_style (const Glib::ustring &tag_id, const SourceTagStyle &style)
 sets the style of the tag which ID is tag_id
SourceTagStyle get_tag_default_style (const Glib::ustring &tag_id) const
 gets the default style of the tag which ID is tag_id

Static Public Member Functions

static GType get_type () G_GNUC_CONST
static GType get_base_type () G_GNUC_CONST
static Glib::RefPtr< SourceLanguagecreate ()
 create a language.

Protected Member Functions

 SourceLanguage (const Glib::ConstructParams &construct_params)
 SourceLanguage (GtkSourceLanguage *castitem)
 SourceLanguage ()

Friends

class SourceLanguage_Class

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< gtksourceview::SourceLanguagewrap (GtkSourceLanguage *object, bool take_copy=false)


Detailed Description

The abstraction of a language.

Languages are used in the syntax highlighting workflow.


Member Typedef Documentation

typedef SourceLanguage gtksourceview::SourceLanguage::CppObjectType

typedef SourceLanguage_Class gtksourceview::SourceLanguage::CppClassType

typedef GtkSourceLanguage gtksourceview::SourceLanguage::BaseObjectType

typedef GtkSourceLanguageClass gtksourceview::SourceLanguage::BaseClassType


Constructor & Destructor Documentation

gtksourceview::SourceLanguage::SourceLanguage ( const Glib::ConstructParams &  construct_params  )  [explicit, protected]

gtksourceview::SourceLanguage::SourceLanguage ( GtkSourceLanguage castitem  )  [explicit, protected]

virtual gtksourceview::SourceLanguage::~SourceLanguage (  )  [virtual]

gtksourceview::SourceLanguage::SourceLanguage (  )  [protected]


Member Function Documentation

static GType gtksourceview::SourceLanguage::get_type (  )  [static]

static GType gtksourceview::SourceLanguage::get_base_type (  )  [static]

GtkSourceLanguage* gtksourceview::SourceLanguage::gobj (  )  [inline]

Provides access to the underlying C GObject.

const GtkSourceLanguage* gtksourceview::SourceLanguage::gobj (  )  const [inline]

Provides access to the underlying C GObject.

GtkSourceLanguage* gtksourceview::SourceLanguage::gobj_copy (  ) 

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

static Glib::RefPtr<SourceLanguage> gtksourceview::SourceLanguage::create (  )  [static]

create a language.

Returns:
the newly created language

Glib::ustring gtksourceview::SourceLanguage::get_id (  )  const

get language ID

a language ID is unique among language IDs.

Returns:
the langugae ID.

Glib::ustring gtksourceview::SourceLanguage::get_name (  )  const

gets the localized name of the language.

Returns:
the localized name of the language

Glib::ustring gtksourceview::SourceLanguage::get_section (  )  const

the localized section of the language.

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

Returns:
the localized section of the language.

Glib::SListHandle<Glib::RefPtr<SourceTag> > gtksourceview::SourceLanguage::get_tags (  ) 

gets the list of tags associated to the given language.

Returns:
the list of tags associated to the language

Glib::SListHandle<Glib::RefPtr<const SourceTag> > gtksourceview::SourceLanguage::get_tags (  )  const

gets the list of tags associated to the given language.

Returns:
the list of tags associated to the language

gunichar gtksourceview::SourceLanguage::get_escape_char (  )  const

Gets the value of the ESC character in the given language.

Returns:
the value of the ESC character in the given language.

Glib::SListHandle<Glib::ustring> gtksourceview::SourceLanguage::get_mime_types (  )  const

gets the list of mime types for the given language.

After usage you should free each element of the list as well as the list itself.

Returns:
the list of mime types for the given language.

void gtksourceview::SourceLanguage::set_mime_types ( const Glib::SListHandle< const Glib::ustring > &  mime_types  ) 

Sets a list of mime_types for the given language.

Parameters:
mime_types the list of new mime types to set.

Glib::RefPtr<SourceStyleScheme> gtksourceview::SourceLanguage::get_style_scheme (  ) 

gets the style scheme associated to the language.

Returns:
the style scheme associated to the language

Glib::RefPtr<const SourceStyleScheme> gtksourceview::SourceLanguage::get_style_scheme (  )  const

gets the style scheme associated to the language.

Returns:
the style scheme associated to the language

void gtksourceview::SourceLanguage::set_style_scheme ( Glib::RefPtr< SourceStyleScheme scheme  ) 

sets the style scheme associated to the language

Parameters:
scheme the new style scheme

SourceTagStyle gtksourceview::SourceLanguage::get_tag_style ( const Glib::ustring &  tag_id  )  const

gets the style of the tag which ID is tag_id .

Parameters:
tag_id the tag ID
Returns:
the style of the tag which ID is tag_id

void gtksourceview::SourceLanguage::set_tag_style ( const Glib::ustring &  tag_id,
const SourceTagStyle style 
)

sets the style of the tag which ID is tag_id

Parameters:
tag_id the tag ID
style the new style.

SourceTagStyle gtksourceview::SourceLanguage::get_tag_default_style ( const Glib::ustring &  tag_id  )  const

gets the default style of the tag which ID is tag_id

Parameters:
tag_id the ID of the tag to consider
Returns:
the default SourceTagStyle.


Friends And Related Function Documentation

friend class SourceLanguage_Class [friend]

Glib::RefPtr< gtksourceview::SourceLanguage > wrap ( GtkSourceLanguage object,
bool  take_copy = false 
) [related]

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 Mon Jan 22 13:39:12 2007 for libgtksourceviewmm by  doxygen 1.5.1