vos/metaobjects/text/text.hh

Go to the documentation of this file.

/* $Id: text.hh,v 1.4 2003/07/24 05:18:13 tetron Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>. 

   Search for TODO for stuff that needs editing. You will want to especially fill in constructors,
   destructors, message handlers, non-property subobjects...

   I can make no garuntee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file text.hh Defines MetaObject class for Text type (revision 0).

*/ 

#ifndef _TEXT_HH_
#define _TEXT_HH_

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef MISC_EXPORTS
#  define MISC_API __declspec(dllexport)
# else
#  define MISC_API __declspec(dllimport)
# endif
#else
# define MISC_API
#endif

/** 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.   
    
*/

class MISC_API Text : public virtual MetaObject
{


public:

    /** Constructor */
    Text(MetaObject* superobject);


    /** Return type string ("text:text") */
    const string getType();

    /** Register Extenders */
    static void registerExtenders();


    /** Return ISO 639 code for primary language */
    string primaryLanguage();

    /** Return a list of languages available (ISO 639 codes)  */
    deque<string>* listLanguages();

    /** @name Access Subobjects */
    //@{

    /** Return first property that starts with the prefix "text:" */
    Property& getPrimaryProperty();

    /** Return property for a given language */
    Property& getProperty(const string& lang);

    /** Get the text (primary/default language) */
    string getText();

    /** Get the text in the given language. 
        @throws NoSuchObjectError if a property for that language is not found. 
        @param lang Search for a subproperty named "text:"+lang (e.g. "text:eng"). I.e., lang is the ISO-639 code.   
    */

    string getText(string lang);

    /** Get the datatype of primary subproperty. */
    string getTextDatatype();

    /** Get the datatype of a subproperty. */
    string getTextDatatype(string lang);

    /** Set primary  text sub-property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void setText(const string& value, const string& datatype);

    /** Set a text subproperty.
        @param lang ISO 639-2 language code.
        @param value The new value
        @param datatype The new datatype: if ommitted, then the existing datatype will be preserved. */
    void setText(string lang, const string& value, const string& datatype);
    

    //@}



};



/** Local version of Text. */

class MISC_API LocalText : public virtual Text
{
public:

    /** Constructor */
    LocalText(MetaObject* superobject);

    /** Initialize subproperties etc. */
    virtual void initialize();

    /** Static generator, for factory. */
    static MetaObject* new_LocalText(MetaObject* superobject, const string& type);

    /** Called when this object gets a message */
    virtual void sendMessage(Message* m);


};


/** Remote version of Text. */

class MISC_API RemoteText : public virtual Text
{

public:

    /** Constructor */
    RemoteText(MetaObject* superobject);

    /** Static generator, for factory. */
    static MetaObject* new_RemoteText(MetaObject* superobject, const string& type);

    /** Called when this object gets an update message from its Local master across the network. */
    void sendUpdateMessage(Message *m);

};


#endif // #ifdef _TEXT_HH_

---