#include <UN_StickyNote.h>

Inheritance diagram for UN_ConstStickyNote:

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

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

	UN_ConstStickyNote (const UN_StickyNote &note)
	Constructs a const handle from a mutable sticky note handle. More...

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


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

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

Public Member Functions inherited from UN_StickyNoteBase< UN_ConstHandle, const 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

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_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_ConstHandle, const UN_GraphData >
	UN_StickyNoteBase ()=default
	Constructs a handle for an invalid sticky note. More...

	UN_StickyNoteBase (const 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 const sticky note in a graph. It abstracts the APIs that operate on this sticky note's data stored inside graph's data containers. It is a constant handle, so allows only queries of the sticky note's data, and does not allow setting any new values for.

Definition at line 216 of file UN_StickyNote.h.

Constructor & Destructor Documentation

UN_ConstStickyNote::UN_ConstStickyNote ( )

default

Constructs a handle for an invalid sticky note.

UN_ConstStickyNote::UN_ConstStickyNote	(	const UN_GraphData *	graph_data,
		UN_StickyNoteID	note_id
	)

inline

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

Definition at line 224 of file UN_StickyNote.h.

UN_ConstStickyNote::UN_ConstStickyNote ( const UN_StickyNote & note )

inline

Constructs a const handle from a mutable sticky note handle.

Definition at line 229 of file UN_StickyNote.h.

Member Function Documentation

UN_ConstGraph UN_ConstStickyNote::graph ( ) const

Returns the graph whithin which this sticky note exists.

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

inline

Comparison operators.

Definition at line 238 of file UN_StickyNote.h.

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

inline

Comparison operators.

Definition at line 236 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