UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA > Class Template Reference

#include <UN_StickyNote.h>

Inheritance diagram for UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >:

Public Member Functions
UN_StickyNoteID	stickyNoteID () const
	Returns the unique ID of the sticky note this handle refers to. More...
const UT_StringHolder &	name () const
	Returns the sticky note name that differentiates it among its siblings. More...
const UT_StringHolder &	text () const
	Returns the sticky note's contents. More...
const UT_Vector2D &	position () const
	Returns the sticky note's position in the graph editor. More...
const UT_Vector2D &	dimensions () const
	Returns the sticky note's dimensions (width & height). More...
const UT_Color &	color () const
	Returns the sticky note's (background) color. More...
const UT_Color &	textColor () const
	Returns the sticky note's text (foreground) color. More...
float	textSize () const
	Returns the sticky note's text size. More...
bool	isCollapsed () const
	Returns true if the sticky note is collapsed (minimized). More...
bool	isBackgroundHidden () const
GRAPH_DATA *	graphData () const
	Returns the owner of the underlying graph data structures. More...
const UN_GraphData *	constGraphData () const
	Returns the owner of the underlying graph data structures. More...
bool	isValid () const
	Returns true if this note is valid within the graph; false otherwise. More...
	operator bool () const
	Returns true if this note is valid within the graph; false otherwise. More...

Protected Member Functions
	UN_StickyNoteBase ()=default
	Constructs a handle for an invalid sticky note. More...
	UN_StickyNoteBase (GRAPH_DATA *graph_data, UN_StickyNoteID note_id)
	Constructs a handle that references the given sticky note in the given graph. More...

Detailed Description

template<typename BASE_CLASS, typename GRAPH_DATA>
class UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >

Base class template for the UN sticky note handle. Its main purpose is to factor common code for const and non-const handles.

Definition at line 29 of file UN_StickyNote.h.

Constructor & Destructor Documentation

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::UN_StickyNoteBase ( )

protecteddefault

Constructs a handle for an invalid sticky note.

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::UN_StickyNoteBase ( GRAPH_DATA *  graph_data, UN_StickyNoteID  note_id  )

inlineprotected

Constructs a handle that references the given sticky note in the given graph.

Definition at line 36 of file UN_StickyNote.h.

Member Function Documentation

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_Color& UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::color ( ) const

inline

Returns the sticky note's (background) color.

Definition at line 87 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UN_GraphData* UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::constGraphData ( ) const

inline

Returns the owner of the underlying graph data structures.

Definition at line 44 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_Vector2D& UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::dimensions ( ) const

inline

Returns the sticky note's dimensions (width & height).

Definition at line 81 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

GRAPH_DATA* UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::graphData ( ) const

inline

Returns the owner of the underlying graph data structures.

Definition at line 42 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

bool UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::isBackgroundHidden ( ) const

inline

Returns true if the background of the sticky note is not drawn, effectively making it transparent.

Definition at line 112 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

bool UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::isCollapsed ( ) const

inline

Returns true if the sticky note is collapsed (minimized).

Definition at line 105 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

bool UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::isValid ( ) const

inline

Returns true if this note is valid within the graph; false otherwise.

Definition at line 53 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_StringHolder& UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::name ( void  ) const

inline

Returns the sticky note name that differentiates it among its siblings.

Definition at line 63 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::operator bool ( ) const

inlineexplicit

Returns true if this note is valid within the graph; false otherwise.

Definition at line 58 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_Vector2D& UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::position ( ) const

inline

Returns the sticky note's position in the graph editor.

Definition at line 75 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

UN_StickyNoteID UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::stickyNoteID ( ) const

inline

Returns the unique ID of the sticky note this handle refers to.

Definition at line 49 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_StringHolder& UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::text ( ) const

inline

Returns the sticky note's contents.

Definition at line 69 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

const UT_Color& UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::textColor ( ) const

inline

Returns the sticky note's text (foreground) color.

Definition at line 93 of file UN_StickyNote.h.

template<typename BASE_CLASS, typename GRAPH_DATA>

float UN_StickyNoteBase< BASE_CLASS, GRAPH_DATA >::textSize ( ) const

inline

Returns the sticky note's text size.

Definition at line 99 of file UN_StickyNote.h.

---

The documentation for this class was generated from the following file:

• UN/UN_StickyNote.h