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::StringArrayHandle get_mime_types () const
 Whether the language should be hidden from the user.gets the list of mime types for the given language.
Glib::ustring get_style_name (const Glib::ustring &style_id) const

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::StringArrayHandle gtksourceview::SourceLanguage::get_mime_types (  )  const

Whether the language should be hidden from the user.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.

Glib::ustring gtksourceview::SourceLanguage::get_style_name ( const Glib::ustring &  style_id  )  const


Friends And Related Function Documentation

friend class SourceLanguage_Class [friend]

Glib::RefPtr< gtksourceview::SourceLanguage > wrap ( GtkSourceLanguage 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 Tue Sep 18 10:57:50 2007 for libgtksourceviewmm by  doxygen 1.5.1