Xfce Foundation Classes
Main Page  | IndexNamespace List  |  Alphabetical List  |  Class List  |  File List


Xfc::Gtk::SourceLanguage Class Reference

A GtkSourceLanguage C++ wrapper class. More...

Inheritance diagram for Xfc::Gtk::SourceLanguage:

Xfc::G::Object Xfc::G::TypeInstance Xfc::Trackable List of all members.

Public Member Functions

Accessors
Accessors
Methods
Signal Proxies

Detailed Description

A GtkSourceLanguage C++ wrapper class.

SourceLanguage is an object that represents a SourceBuffer's language.


Constructor & Destructor Documentation

Xfc::Gtk::SourceLanguage::SourceLanguage ( GtkSourceLanguage *  language,
bool  reference = false 
) [explicit, protected]

Construct a new SourceLanguage from an existing GtkSourceLanguage.

Parameters:
language A pointer to a GtkSourceLanguage.
reference Set false if the initial reference count is floating, set true if it's not.

The language can be a newly created GtkSourceLanguage or an existing GtkSourceLanguage (see G::Object::Object).

Xfc::Gtk::SourceLanguage::SourceLanguage ( GtkSourceLanguage *  language,
bool  reference = false 
) [explicit, protected]

Construct a new SourceLanguage from an existing GtkSourceLanguage.

Parameters:
language A pointer to a GtkSourceLanguage.
reference Set false if the initial reference count is floating, set true if it's not.

The language can be a newly created GtkSourceLanguage or an existing GtkSourceLanguage (see G::Object::Object).


Member Function Documentation

bool Xfc::Gtk::SourceLanguage::get_tags ( std::vector< Pointer< TextTag > > &  tags  )  const

Gets a list of the available source tags.

Parameters:
tags A vector of TextTag smart pointers to hold the source tags.
Returns:
true if tags is not empty.

bool Xfc::Gtk::SourceLanguage::get_mime_types ( std::vector< String > &  mime_types  )  const

Gets a list of the mime types set by set_mime_types().

Parameters:
mime_types A vector of String to hold the mime types.
Returns:
true if mime_types is not empty.

SourceTagStyle* Xfc::Gtk::SourceLanguage::get_tag_style ( const String tag_id  )  const

Gets the SourceTagStyle used by tag_id.

Parameters:
tag_id The tag ID.
Returns:
A pointer to the SourceTagStyle.

SourceTagStyle* Xfc::Gtk::SourceLanguage::get_tag_default_style ( const String tag_id  )  const

Get the default style for tag_id.

Parameters:
tag_id The tag ID.
Returns:
A pointer to the default SourceTagStyle.

void Xfc::Gtk::SourceLanguage::set_mime_types ( const std::vector< String > &  mime_types  ) 

Set the mime types.

Parameters:
mime_types A vector of String holding the mime types

void Xfc::Gtk::SourceLanguage::set_style_scheme ( SourceStyleScheme scheme  ) 

Set the style scheme used by the language.

Parameters:
scheme The new SourceStyleScheme.

void Xfc::Gtk::SourceLanguage::set_tag_style ( const String tag_id,
const SourceTagStyle style 
)

Set the style of the tag whose ID is tag_id.

Parameters:
tag_id The ID identifying the source tag.
style The new SourceTagStyle.


The documentation for this class was generated from the following file: Xfce Foundation Classes
Copyright © 2004-2005 The XFC Development Team XFC 4.3