[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/metaobjects/misc/hypercard.hh

Go to the documentation of this file.

/* $Id: hypercard.hh,v 1.11 2005/12/18 09:59:40 tetron Exp $ */

#ifndef _HYPERCARD_HH_
#define _HYPERCARD_HH_

#include <vos/vos/vos.hh>

#include "miscdefs.hh"

namespace VOS {

/** @class Hypercard hypercard.hh vos/metaobjects/misc/hypercard.hh

        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.

 * @ingroup libmetaobject_misc
*/
class MISC_API Hypercard : public MetaObject
{

public:

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

    static MetaObject* new_Hypercard(VobjectBase* s, const std::string& type);

    /** Return type string ("hypercard") */
    virtual const std::string getVOSType();

    /** @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.
        ). */
    VUtil::vRef<Vobject> getLink();

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

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

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

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

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

    void setTitle(const std::string& title, const std::string& type = "string", const std::string& ac = "");


    //@}
};

} // namespace VOS

#ifndef MISC_EXPORTS
IMPORT_METAOBJECT_FACTORIES(Hypercard)
#endif

#endif // #ifdef _HYPERCARD_HH_