Sequence Chart Studio  svn HEAD revision
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Attributes | List of all members
Comment Class Reference

Represents a text block or a text comment in MSC. More...

#include <Comment.h>

Inheritance diagram for Comment:
Inheritance graph
Collaboration diagram for Comment:
Collaboration graph

Public Member Functions

 Comment (const std::wstring &text=L"")
 
void set_text (const std::wstring &text)
 
const std::wstring & get_text () const
 
void set_position (const MscPoint &position)
 
const MscPointget_position () const
 
void set_width (Coordinate width)
 
Coordinate get_width () const
 
- Public Member Functions inherited from MscElementTmpl< Comment >
int get_visual_style () const
 
void set_visual_style (int visual_style)
 
MscElementget_general_original () const
 See MscElementTmpl for details about attribute original. More...
 
void set_general_original (MscElement *original)
 See MscElementTmpl for details about attribute original. More...
 
Commentget_original () const
 
void set_original (Comment *e)
 
void set_original (boost::intrusive_ptr< Comment > &e)
 
virtual ~MscElementTmpl ()
 
- Public Member Functions inherited from MscElement
bool is_attribute_set (const std::string &name) const
 Finds out whether attribute with specified name is set or not. More...
 
template<class T >
T & get_attribute (const std::string &name, const T &def)
 Returns dynamic attribute of MscElement. More...
 
template<class T >
T & get_attribute (const std::string &name, const T &def, bool &status)
 Returns dynamic attribute of MscElement. More...
 
template<class T >
void set_attribute (const std::string &name, const T &val)
 Sets dynamic attribute of MscElement. More...
 
template<class T >
void remove_attribute (const std::string &name)
 Removes attribute of MscElement. More...
 
std::set< std::stringget_attribute_names () const
 List all attributes of MscElement. More...
 
enum MarkType get_marked () const
 
void set_marked (enum MarkType marked=MARKED)
 
MscColor get_color () const
 
void set_color (MscColor color)
 
void clear_color ()
 
virtual ~MscElement ()
 

Protected Attributes

std::wstring m_text
 
MscPoint m_position
 
Coordinate m_width
 
- Protected Attributes inherited from MscElementTmpl< Comment >
int m_visual_style
 Visual style of the shape. More...
 
boost::intrusive_ptr< Commentm_original
 Pointer to original version of MscElement. More...
 

Additional Inherited Members

- Protected Member Functions inherited from MscElementTmpl< Comment >
 MscElementTmpl ()
 
 MscElementTmpl (Comment *original)
 Creates MscElement referencing the original one. More...
 
- Protected Member Functions inherited from MscElement
 MscElement ()
 

Detailed Description

Represents a text block or a text comment in MSC.

Definition at line 25 of file Comment.h.

Constructor & Destructor Documentation

Comment::Comment ( const std::wstring &  text = L"")
inline

Definition at line 34 of file Comment.h.

Member Function Documentation

const MscPoint& Comment::get_position ( ) const
inline

Definition at line 54 of file Comment.h.

const std::wstring& Comment::get_text ( ) const
inline

Definition at line 44 of file Comment.h.

Coordinate Comment::get_width ( ) const
inline

Definition at line 64 of file Comment.h.

void Comment::set_position ( const MscPoint position)
inline
void Comment::set_text ( const std::wstring &  text)
inline

Definition at line 39 of file Comment.h.

void Comment::set_width ( Coordinate  width)
inline

Definition at line 59 of file Comment.h.

Referenced by CDrawingExtractor::extract_bmsc(), and CDrawingExtractor::extract_hmsc().

Member Data Documentation

MscPoint Comment::m_position
protected

Definition at line 30 of file Comment.h.

std::wstring Comment::m_text
protected

Definition at line 28 of file Comment.h.

Coordinate Comment::m_width
protected

Definition at line 31 of file Comment.h.


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

SourceForge.net Logo
Generated on Fri Jan 15 2016 16:26:57 for Sequence Chart Studio by  doxygen