Text Class Reference

MetaObject implementing Text Object Type. More...

#include <text.hh>

Inheritance diagram for Text:

List of all members.

Public Member Functions

• Text (MetaObject *superobject)

  Constructor.
  
  

• const string getType ()

  Return type string ("text:text").
  
  

• string primaryLanguage ()

  Return ISO 639 code for primary language.
  
  

• deque< string > * listLanguages ()

  Return a list of languages available (ISO 639 codes).
  
  

Access Subobjects

• Property & getPrimaryProperty ()

  Return first property that starts with the prefix "text:".
  
  

• Property & getProperty (const string &lang)

  Return property for a given language.
  
  

• string getText ()

  Get the text (primary/default language).
  
  

• string getText (string lang)

  Get the text in the given language.
  
  

• string getTextDatatype ()

  Get the datatype of primary subproperty.
  
  

• string getTextDatatype (string lang)

  Get the datatype of a subproperty.
  
  

• void setText (const string &value, const string &datatype)

  Set primary text sub-property.
  
  

• void setText (string lang, const string &value, const string &datatype)

  Set a text subproperty.
  
  

Static Public Member Functions

• void registerExtenders ()

  Register Extenders.
  
  

---

Detailed Description

MetaObject implementing Text Object Type.

The "text" object type contains written text of some kind to be displayed. It has one subproperty containing the text, as well as optional subproperties for translations to other languages.

Definition at line 39 of file text.hh.

---

Constructor & Destructor Documentation

Text::Text (  MetaObject *  superobject  )

Constructor. Definition at line 22 of file text.cc.

---

Member Function Documentation

Property & Text::getPrimaryProperty (   )

Return first property that starts with the prefix "text:". Definition at line 106 of file text.cc. Referenced by getText(), getTextDatatype(), and primaryLanguage().

Property & Text::getProperty (  const string &  lang  )

Return property for a given language. Definition at line 123 of file text.cc.

string Text::getText (  string  lang  )

Get the text in the given language. Exceptions: NoSuchObjectError  if a property for that language is not found. Parameters: lang  Search for a subproperty named "text:"+lang (e.g. "text:eng"). I.e., lang is the ISO-639 code. Definition at line 61 of file text.cc.

string Text::getText (   )

Get the text (primary/default language). Definition at line 69 of file text.cc.

string Text::getTextDatatype (  string  lang  )

Get the datatype of a subproperty. Definition at line 75 of file text.cc.

string Text::getTextDatatype (   )

Get the datatype of primary subproperty. Definition at line 81 of file text.cc.

const string Text::getType (   )

Return type string ("text:text"). Definition at line 44 of file text.cc.

deque< string > * Text::listLanguages (   )

Return a list of languages available (ISO 639 codes). Definition at line 89 of file text.cc.

string Text::primaryLanguage (   )

Return ISO 639 code for primary language. Definition at line 127 of file text.cc. Referenced by setText().

void Text::registerExtenders (   )  [static]

Register Extenders. Definition at line 49 of file text.cc.

void Text::setText (  string  lang, const string &  value, const string &  datatype )

Set a text subproperty. Parameters: lang  ISO 639-2 language code. value  The new value datatype  The new datatype: if ommitted, then the existing datatype will be preserved. Definition at line 136 of file text.cc.

void Text::setText (  const string &  value, const string &  datatype )

Set primary text sub-property. Parameters: value  The new value datatype  The new datatype: if omitted, then the existing datatype will be preserved. Definition at line 141 of file text.cc.

---

The documentation for this class was generated from the following files:

• vos/metaobjects/text/text.hh
• vos/metaobjects/text/text.cc

---