UNI_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.
 *
 * NAME:        UNI_StickyNote.h ( UNI Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UNI_StickyNote_h__
#define __UNI_StickyNote_h__

#include "UNI_API.h"
#include "UNI_Item.h"

// ============================================================================
class UNI_ConstStickyNote : public UNI_ConstItem<UNI_StickyNoteID>
{
public:
    /// Expose base class constructors.
    using UNI_ConstItem::UNI_ConstItem;

    UT_StringHolder name() const
    { return graph() ? graph()->name( id() ) : UT_StringHolder(); }
    UT_StringHolder path() const
    { return graph() ? graph()->path( id() ) : UT_StringHolder(); }
    UT_StringHolder text() const
    { return graph() ? graph()->text( id() ) : UT_StringHolder(); }
    UT_Color        textColor() const
    { return graph() ? graph()->textColor( id() ) : UT_Color(); }
    float           textSize() const
    { return graph() ? graph()->textSize( id() ) : 0.0; }
    UT_Color        color() const
    { return graph() ? graph()->color( id() ) : UT_Color(); }
    UT_Vector2D     position() const
    { return graph() ? graph()->position( id() ) : UT_Vector2D(0., 0.); }
    UT_Vector2D     size() const
    { return graph() ? graph()->size( id() ) : UT_Vector2D(0., 0.); }
    bool            isCollapsed() const
    { return graph() ? graph()->isCollapsed( id() ) : false; }
    bool            isBackgroundHidden() const
    { return graph() ? graph()->isBackgroundHidden( id() ) : false; }
    UNI_NodeID      node() const
    { return graph() ? graph()->ownerNode(id()) : UNI_NodeID(); }
};


// ============================================================================
class UNI_API UNI_StickyNote : public UNI_Item<UNI_StickyNoteID,
                                               UNI_SessionStickyNoteID,
                                               UNI_ConstStickyNote>
{
public:
    /// Expose base class constructors.
    using UNI_Item::UNI_Item;

    void            setName( const UT_StringHolder &name );
    void            setPosition( const UT_Vector2D &pos );
    void            setSize( const UT_Vector2D &size );
    void            setColor( const UT_Color &clr );
    void            setText( const UT_StringHolder &text );
    void            setTextColor( const UT_Color &clr );
    void            setTextSize( const float size );
    void            setCollapsed( bool collapsed );
    void            setBackgroundHidden( bool hidden );
    void            destroy();
};

#endif