FD::UINote Class Reference

#include <UINote.h>

Inheritance diagram for FD::UINote:

[legend]List of all members.

Public Member Functions
	UINote (const std::string &text, double x, double y, bool visible=true)
virtual	~UINote ()
	UINote destructor.
void	saveXML (xmlNode *root)
std::string	getText ()
void	setText (const std::string &text)
bool	isVisible ()
void	setVisible (bool visible)
Protected Attributes
std::string	m_text
	Text of the note.
double	m_x
	X position on the canvas.
double	m_y
	Y position on the canvas.
bool	m_visible
	Is the Note visible ?

---

Detailed Description

UINote is a "Post-It" like note incorporated into a network for documentation purposes. It is not useful for calculation and is not connected anywhere.

---

Constructor & Destructor Documentation

FD::UINote::UINote (  const std::string &  text, double  x, double  y, bool  visible = true )

UINote Constructor Parameters: test  The text of the note x  the x position of the note on the canvas y  the y position of the note on the canvas

---

Member Function Documentation

std::string FD::UINote::getText (   )  [inline]

Get the text content of the note Returns: std::string the text contained in the UINote

bool FD::UINote::isVisible (   )  [inline]

Returns: bool True if the note is visible, else false

void FD::UINote::saveXML (  xmlNode *  root  )

Save UINote in the XML format Parameters: root  The XML root where to save

void FD::UINote::setText (  const std::string &  text  )  [inline]

Set the text of the note Parameters: text  the text to be contained in the UINote

void FD::UINote::setVisible (  bool  visible  )  [inline]

Set the visibility of the note Parameters: visible  True if the note should be visible, else false

---

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

• UINote.h

---