#include <UN_StickyNote.h>

Inheritance diagram for UN_StickyNote:

Public Member Functions
	UN_StickyNote ()=default
	Constructs a handle for an invalid sitkcy note. More...

	UN_StickyNote (UN_GraphData *graph_data, UN_StickyNoteID note_id)
	Constructs a handle referencing the given note in the given graph. More...

UN_Graph	graph () const
	Returns the graph whithin which this sticky note exists. More...

void	setName (const UT_StringRef &name) const
	Sets the sticky note name that differentiates it among its siblings. More...

void	setText (const UT_StringRef &type_name) const
	Sets the sticky note's type that determines its functional behavour. More...

void	setPosition (const UT_Vector2R &position) const
	Sets the sticky note's location in the graph editor. More...

void	setDimensions (const UT_Vector2R &dimensions) const
	Sets the sticky note's width and height. More...

void	setColor (const UT_Color &color) const
	Sets the sticky note's (background) color. More...

void	setTextColor (const UT_Color &color) const
	Sets the sticky note's text (foreground) color. More...

void	setTextSize (float text_size) const
	Sets the sticky note's text size. More...

void	setCollapsed (bool is_collapsed) const
	Sets the sticky note's collapsed (minimized) state. More...

void	setBackgroundHidden (bool is_hidden) const


bool	operator== (const UN_StickyNote &other) const
	Comparison operators. More...

bool	operator!= (const UN_StickyNote &other) const
	Comparison operators. More...

Public Member Functions inherited from UN_StickyNoteBase< UN_Handle, UN_GraphData >
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

UN_GraphData *	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...

Public Member Functions inherited from UN_Handle
	UN_Handle ()
	Constructs a reference handle for an invalid entity in the graph. More...

	UN_Handle (UN_GraphData *graph_data, UN_DataID data_id)
	Constructs reference handle to the data for a given entity in the graph. More...

UN_GraphData *	graphData () const
	Returns the graph that owns, manages, and operates on the data object. More...

const UN_GraphData *	constGraphData () const
	Returns the graph that owns, manages, and operates on the data object. More...

Public Member Functions inherited from UN_ConstHandle
	UN_ConstHandle ()
	Constructs a reference handle for an invalid entity in the graph. More...

	UN_ConstHandle (const UN_GraphData *graph_data, UN_DataID data_id)
	Constructs reference handle to the data for a given entity in the graph. More...

UN_DataID	dataID () const

const UN_GraphData *	graphData () const
	Returns the underlying graph data object. More...

const UN_GraphData *	constGraphData () const
	Returns the underlying graph data object. More...

Additional Inherited Members
Protected Member Functions inherited from UN_StickyNoteBase< UN_Handle, UN_GraphData >
	UN_StickyNoteBase ()=default
	Constructs a handle for an invalid sticky note. More...

	UN_StickyNoteBase (UN_GraphData *graph_data, UN_StickyNoteID note_id)
	Constructs a handle that references the given sticky note in the given graph. More...

Protected Member Functions inherited from UN_ConstHandle
bool	isNumericallyValid () const

bool	operator== (const UN_ConstHandle &other) const

bool	operator!= (const UN_ConstHandle &other) const

Detailed Description

A handle that references a mutable sitkcy note in a graph. It abstracts the APIs that operate on this sitkcy note's data stored inside graph's data containers. It is a non-const (read-write) handle, so allows both queries and mutations of the sitkcy note's data.

Definition at line 125 of file UN_StickyNote.h.

Constructor & Destructor Documentation

UN_StickyNote::UN_StickyNote ( )

default

Constructs a handle for an invalid sitkcy note.

UN_StickyNote::UN_StickyNote	(	UN_GraphData *	graph_data,
		UN_StickyNoteID	note_id
	)

inline

Constructs a handle referencing the given note in the given graph.

Definition at line 132 of file UN_StickyNote.h.

Member Function Documentation

UN_Graph UN_StickyNote::graph ( ) const

Returns the graph whithin which this sticky note exists.

bool UN_StickyNote::operator!= ( const UN_StickyNote & other ) const

inline

Comparison operators.

Definition at line 141 of file UN_StickyNote.h.

bool UN_StickyNote::operator== ( const UN_StickyNote & other ) const

inline

Comparison operators.

Definition at line 139 of file UN_StickyNote.h.

void UN_StickyNote::setBackgroundHidden ( bool is_hidden ) const

inline

Sets the flag on the sticky note to avoid drawing its background, effectively making it transparent.

Definition at line 202 of file UN_StickyNote.h.

void UN_StickyNote::setCollapsed ( bool is_collapsed ) const

inline

Sets the sticky note's collapsed (minimized) state.

Definition at line 194 of file UN_StickyNote.h.

void UN_StickyNote::setColor ( const UT_Color & color ) const

inline

Sets the sticky note's (background) color.

Definition at line 175 of file UN_StickyNote.h.

void UN_StickyNote::setDimensions ( const UT_Vector2R & dimensions ) const

inline

Sets the sticky note's width and height.

Definition at line 168 of file UN_StickyNote.h.

void UN_StickyNote::setName ( const UT_StringRef & name ) const

inline

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

Definition at line 149 of file UN_StickyNote.h.

void UN_StickyNote::setPosition ( const UT_Vector2R & position ) const

inline

Sets the sticky note's location in the graph editor.

Definition at line 161 of file UN_StickyNote.h.

void UN_StickyNote::setText ( const UT_StringRef & type_name ) const

inline

Sets the sticky note's type that determines its functional behavour.

Definition at line 155 of file UN_StickyNote.h.

void UN_StickyNote::setTextColor ( const UT_Color & color ) const

inline

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

Definition at line 181 of file UN_StickyNote.h.

void UN_StickyNote::setTextSize ( float text_size ) const

inline

Sets the sticky note's text size.

Definition at line 187 of file UN_StickyNote.h.

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

UN/UN_StickyNote.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation