vos/metaobjects/misc/hypercard.hh

Go to the documentation of this file.

/* $Id: hypercard.hh,v 1.12 2003/07/24 05:18:21 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 hypercard.hh Defines MetaObject class for Hypercard type (revision 0).

*/ 

#ifndef _HYPERCARD_HH_
#define _HYPERCARD_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 Hypercard Object Type. 
    
        An object bearing this type suggests to the application that it may load the 
        child object named "link" as a new document or enterable space for the user.
    
*/

class MISC_API Hypercard : public virtual MetaObject
{

public:

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


    /** Return type string ("hypercard") */
    const string getType();

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


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

    /** Get link (
            This child may link to any object, but is recommended to link to the top level of
            a document or space, or a property containing data for display.         
        ). */
    Vobject& getLink();

    /** @deprecated use getLink. */
    Vobject& get_link() { return getLink(); }

    /** Set link.
        @param newobj   The new subobject. */
    void setLink(Vobject* newobj);

    /// @deprecated use setLink. */
    void set_link(Vobject* newobj) { setLink(newobj); }

    /** Get description */
    string getDescription();

    /// @deprecated use getDescription
    string get_description() { return getDescription(); }

    /** Set description
     * @param description   The new description
     * @param type           New description's data type. Default is text/plain.
     * @param accesscontrol  Property access control policy. Default is policy set
     * with initialize().
     */
    void setDescription(const string& description, const string& type = "text/plain", PropertyAccessControl* accesscontrol = NULL);

    /// @deprecated use setDescription
    void set_description(const string& description, const string& type = "text/plain", PropertyAccessControl* accesscontrol = NULL) {
        setDescription(description, type, accesscontrol);
    }

    /** Get title */
    string getTitle();

    /// @deprecated use getTitle
    string get_title() { return getTitle(); }

    /** Set title 
     * @param title The new title 
     * @param type  The title's type. Default is text/plain. 
     * @param ac    Property access control. Default is policty set with
     * initialize().
     */

    void setTitle(const string& title, const string& type = "text/plain", PropertyAccessControl* ac = NULL); 

    /// @deprecated use setTitle.
    void set_title(const string& title, const string& type = "text/plain", PropertyAccessControl* ac = NULL) {
        setTitle(title, type, ac);
    }

    //@}
    
    

    /** initialize. set's property access control to NOPropertyAccessControl. */
    virtual void initialize();

    /** initialize, with given access control as the default for new
     * subproperties. */
    virtual void initialize(PropertyAccessControl* ac);

private:

    PropertyAccessControl* defaultPropertyAC;


};



/** Local version of Hypercard. */

class MISC_API LocalHypercard : public virtual Hypercard
{
public:

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

    /** Initialize subproperties and access control. */
    virtual void initialize();

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

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


    /** initialize subproperties and access control, with given access control as the default for new
     * subproperties. */
    virtual void initialize(PropertyAccessControl* ac);

};


/** Remote version of Hypercard. */

class MISC_API RemoteHypercard : public virtual Hypercard
{

public:

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

    /** Static generator, for factory. */
    static MetaObject* new_RemoteHypercard(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 _HYPERCARD_HH_

---