Reference Manual

Inti::Gtk::SourceLanguage Class Reference

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

#include <inti/gtk-sourceview/sourcelanguage.h>

List of all members.

Public Member Functions

Constructors

• virtual ~SourceLanguage ()

  Destructor.
  
  

Accessors

• GtkSourceLanguage * gtk_source_language () const

  Get a pointer to the GtkSourceLanguage structure.
  
  

• GtkSourceLanguageClass * gtk_source_language_class () const

  Get a pointer to the GtkSourceLanguageClass structure.
  
  

• operator GtkSourceLanguage * () const

  Conversion operator; safely converts a SourceLanguage to a GtkSourceLanguage pointer.
  
  

• bool is_gtk_source_language () const

  Returns true if the object instance is of type GTK_TYPE_SOURCE_LANGUAGE.
  
  

Accessors

• String get_id () const

  Returns the ID of the language (ID is not locale-dependent).
  
  

• String get_name () const

  Returns the name of the language from the language specification file (.lang) or a null String if no language name can be retrieved.
  
  

• String get_section () const

  Returns the name of the section from the language specification file (.lang) or a null String if no section name can be retrieved.
  
  

• bool get_tags (std::vector< Pointer< TextTag > > &tags) const

  Gets a list of the available source tags.
  
  

• G::Unichar get_escape_char () const

  Returns the escape character used for syntax delimiters.
  
  

• bool get_mime_types (std::vector< String > &mime_types) const

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

• SourceStyleScheme * get_style_scheme () const

  Returns the style scheme currently used by the language.
  
  

• SourceTagStyle * get_tag_style (const String &tag_id) const

  Gets the SourceTagStyle used by tag_id.
  
  

• SourceTagStyle * get_tag_default_style (const String &tag_id) const

  Get the default style for tag_id.
  
  

Methods

• void set_mime_types (const std::vector< String > &mime_types)

  Set the mime types.
  
  

• void set_style_scheme (SourceStyleScheme &scheme)

  Set the style scheme used by the language.
  
  

• void set_tag_style (const String &tag_id, const SourceTagStyle &style)

  Set the style of the tag whose ID is tag_id.
  
  

Signal Proxies

• const TagStyleChangedSignalProxy sig_tag_style_changed ()

  Connect to the tag_style_changed_signal; emitted when a tag style is changed.
  
  

Protected Member Functions

Constructors

• SourceLanguage (GtkSourceLanguage *language, bool reference=false)

  Construct a new SourceLanguage from an existing GtkSourceLanguage.
  
  

Signal Handlers

• virtual void on_tag_style_changed (const String &name)

  Called when a tag style is changed.
  
  

---

Detailed Description

A GtkSourceLanguage C++ wrapper class.

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

---

Constructor & Destructor Documentation

Inti::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 Inti::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* Inti::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.

SourceTagStyle* Inti::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.

bool Inti::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.

virtual void Inti::Gtk::SourceLanguage::on_tag_style_changed (  const String &  name  )  [protected, virtual]

Called when a tag style is changed. Parameters: name  The name of the new tag style.

void Inti::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 Inti::Gtk::SourceLanguage::set_style_scheme (  SourceStyleScheme &  scheme  )

Set the style scheme used by the language. Parameters: scheme  The new SourceStyleScheme.

void Inti::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:

• sourcelanguage.h