UN_StickyNoteUtils.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:        UN_StickyNoteUtils.h ( UN Library, C++)
 *
 * COMMENTS:
 *      
 */

#ifndef __UN_StickyNoteUtils_h__
#define __UN_StickyNoteUtils_h__


#include "UN_API.h"
#include "UN_GraphData.h"


namespace UN_StickyNoteUtils
{
    /// Returns true if the sticky_note by the given ID is valid 
    /// in the given graph.
    static inline bool
    isValid( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    {
        return graph_data && graph_data->isValid( sticky_note_id );
    }

    /// Sets the sticky note's name that differentiates it among its siblings. 
    static inline void
    setName( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
             const UT_StringRef &name ) 
    { 
        if( graph_data )
            graph_data->setStickyNoteName( sticky_note_id, name );
    }

    /// Returns the sticky note name that differentiates it among its siblings. 
    static inline const UT_StringHolder &
    name( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    {
        return graph_data 
            ? graph_data->stickyNoteData().name( sticky_note_id )
            : UT_StringHolder::theEmptyString;
    }

    /// Sets the sticky note's contents.
    static inline void
    setText( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
            const UT_StringRef &text ) 
    {
        if( graph_data )
            graph_data->stickyNoteData().setText( sticky_note_id, text );
    }

    /// Returns the name of the sticky note's conents.
    static inline const UT_StringHolder &
    text( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    { 
        return graph_data 
            ? graph_data->stickyNoteData().text( sticky_note_id )
            : UN_StickyNoteData::theDefText;
    }

    /// Sets the sticky note's location in the graph editor.
    static inline void
    setPosition( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
            const UT_Vector2R &position )
    {
        if( graph_data )
            graph_data->stickyNoteData().setPosition( sticky_note_id, position);
    }

    /// Returns the sticky note's position in the graph editor.
    static inline const UT_Vector2D &
    position( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    { 
        return graph_data 
            ? graph_data->stickyNoteData().position( sticky_note_id )
            : UN_StickyNoteData::theDefPos;
    }

    /// Sets the sticky note's width and height.
    static inline void
    setDimensions( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
            const UT_Vector2R &dimensions ) 
    {
        if( graph_data )
            graph_data->stickyNoteData().setDimensions( 
                    sticky_note_id, dimensions );
    }

    /// Returns the sticky note's dimensions (width & height).
    static inline const UT_Vector2D &
    dimensions( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    { 
        return graph_data 
            ? graph_data->stickyNoteData().dimensions( sticky_note_id )
            : UN_StickyNoteData::theDefDim;
    }

    /// Sets the sticky note's (background) color.
    static inline void
    setColor( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
            const UT_Color &color ) 
    {
        if( graph_data )
            graph_data->stickyNoteData().setColor( sticky_note_id, color );
    }

    /// Returns the sticky note's (background) color.
    static inline const UT_Color &
    color( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    { 
        return graph_data 
            ? graph_data->stickyNoteData().color( sticky_note_id )
            : UN_StickyNoteData::theDefColor;
    }

    /// Sets the sticky note's text (foreground) color.
    static inline void
    setTextColor( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
            const UT_Color &color ) 
    {
        if( graph_data )
            graph_data->stickyNoteData().setTextColor( sticky_note_id, color );
    }

    /// Returns the sticky note's text (foreground) color.
    static inline const UT_Color &
    textColor( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    { 
        return graph_data 
            ? graph_data->stickyNoteData().textColor( sticky_note_id )
            : UN_StickyNoteData::theDefTextColor;
    }

    /// Sets the sticky note's text size.
    static inline void
    setTextSize( UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id,
            float text_size ) 
    {
        if( graph_data )
            graph_data->stickyNoteData().setTextSize( sticky_note_id, 
                    text_size );
    }

    /// Returns the sticky note's text size.
    static inline float
    textSize( const UN_GraphData *graph_data, UN_StickyNoteID sticky_note_id )
    { 
        return graph_data 
            ? graph_data->stickyNoteData().textSize( sticky_note_id )
            : UN_StickyNoteData::theDefTextSize;
    }

    /// Sets the sticky note's collapsed (minimized) state.
    static inline void
    setCollapsed( UN_GraphData *graph_data, 
            UN_StickyNoteID sticky_note_id, bool is_collapsed )
    {
        if( graph_data )
            graph_data->stickyNoteData().setCollapsed( 
                    sticky_note_id, is_collapsed );
    }

    /// Returns true if the sticky note is collapsed (minimized).
    static inline bool
    isCollapsed( const UN_GraphData *graph_data, 
            UN_StickyNoteID sticky_note_id ) 
    {
        return graph_data 
            ? graph_data->stickyNoteData().isCollapsed( sticky_note_id )
            : UN_StickyNoteData::theDefCollapsed;
    }

    /// Sets the flag on the sticky note to avoid drawing its background,
    /// effectively making it transparent.
    static inline void
    setBackgroundHidden( UN_GraphData *graph_data,
            UN_StickyNoteID sticky_note_id, bool is_hidden )
    {
        if( graph_data )
            graph_data->stickyNoteData().setBackgroundHidden( 
                    sticky_note_id, is_hidden );
    }

    /// Returns true if the background of the sticky note is not drawn,
    /// effectively making it transparent.
    static inline bool
    isBackgroundHidden( const UN_GraphData *graph_data,
            UN_StickyNoteID sticky_note_id )
    {
        return graph_data 
            ? graph_data->stickyNoteData().isBackgroundHidden( sticky_note_id )
            : UN_StickyNoteData::theDefBackgroundHidden;
    }
}

#endif