HOM/HOM_StickyNote.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 */

#ifndef __HOM_StickyNote_h__
#define __HOM_StickyNote_h__

#include "HOM_API.h"
#include "HOM_Defines.h"
#include "HOM_EnumModules.h"
#include "HOM_Errors.h"
#include "HOM_Module.h"
#include <string>

class HOM_Color;
class HOM_Vector2;

SWIGOUT(%rename(StickyNote) HOM_StickyNote;)

class HOM_API HOM_StickyNote
{
public:
    HOM_StickyNote()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_StickyNote(const HOM_StickyNote &net_box)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_StickyNote()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__() 
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual std::string name() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setName(const char* name)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_OperationFailed,
              HOM_Error) = 0;

    virtual std::string text() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setText(const char* new_text)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%newobject parent;)
    virtual HOM_Node *parent()
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%newobject color;)
        virtual HOM_Color *color()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setColor(HOM_Color &color) 
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;

    SWIGOUT(%newobject position;)
    virtual HOM_Vector2 *position()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setPosition(const std::vector<float> &position)
        throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
              HOM_Error) = 0;
    virtual void move(const std::vector<float> &amount)
        throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
              HOM_Error) = 0;

    SWIGOUT(%newobject size;)
    virtual HOM_Vector2 *size()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setSize(const std::vector<float> &size)
        throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
              HOM_Error) = 0;
    virtual void resize(const std::vector<float> &amount)
        throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
              HOM_Error) = 0;

    virtual bool isMinimized()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setMinimized(bool on)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual bool isPicked()
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
    virtual void setPicked(bool on)
        throw(HOM_ObjectWasDeleted, HOM_Error) = 0;


    virtual void destroy(void)
        throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;

    SWIGOUT(%kwargs asCode;)
    virtual std::string asCode(bool brief=false,
                               bool recurse=false,
                               bool save_box_contents=false,
                               bool save_channels_only=false,
                               bool save_creation_commands=true,
                               bool save_keys_in_frames=false,
                               bool save_parm_values_only=false,
                               bool save_spare_parms=false,
                               const char *function_name=NULL)
        throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;

};

#endif

---