Class extends the wxSFSolidBase class and encapsulates arrow shape consisting of a filled circle located at the end of the parent line shape. More...

#include <CircleArrow.h>

Inheritance diagram for wxSFCircleArrow:

[legend]

Collaboration diagram for wxSFCircleArrow:

[legend]

Public Member Functions
	XS_DECLARE_CLONABLE_CLASS (wxSFCircleArrow)

	wxSFCircleArrow (void)
	Default constructor. More...

	wxSFCircleArrow (wxSFShapeBase *parent)
	User constructor. More...

	wxSFCircleArrow (const wxSFCircleArrow &obj)
	Copy constructor. More...

virtual	~wxSFCircleArrow (void)
	Destructor. More...

void	SetRadius (int radius)
	Set radius of circle arrow. More...

int	GetRadius () const
	Get radius of circle arrow. More...

virtual void	Draw (const wxRealPoint &from, const wxRealPoint &to, wxDC &dc)
	Draw arrow shape at the end of a virtual line. More...

Public Member Functions inherited from wxSFSolidArrow
	XS_DECLARE_CLONABLE_CLASS (wxSFSolidArrow)

	wxSFSolidArrow (void)
	Default constructor. More...

	wxSFSolidArrow (wxSFShapeBase *parent)
	User constructor. More...

	wxSFSolidArrow (const wxSFSolidArrow &obj)
	Copy constructor. More...

virtual	~wxSFSolidArrow (void)
	Destructor. More...

void	SetArrowFill (const wxBrush &br)
	Set a brush filling the arrow's body. More...

void	SetArrowPen (const wxPen &pen)
	Set a pen used for drawing of the arrow's border. More...

const wxBrush &	GetArrowFill () const
	Get current brush used for filling of the arrow's body. More...

const wxPen &	GetArrowPen () const
	Get current pen used for drawing of the arrow's border. More...

Public Member Functions inherited from wxSFArrowBase
	XS_DECLARE_CLONABLE_CLASS (wxSFArrowBase)

	wxSFArrowBase (void)
	Default constructor. More...

	wxSFArrowBase (wxSFShapeBase *parent)
	Constructor. More...

	wxSFArrowBase (const wxSFArrowBase &obj)
	Copy constructor. More...

	~wxSFArrowBase (void)
	Destructor. More...

void	SetParentShape (wxSFShapeBase *parent)
	Set a parent of the arrow shape. More...

wxSFShapeBase *	GetParentShape ()
	Get pointer to a parent shape. More...

Public Member Functions inherited from xsSerializable
	XS_DECLARE_CLONABLE_CLASS (xsSerializable)

	xsSerializable ()
	Constructor. More...

	xsSerializable (const xsSerializable &obj)
	Copy constructor. More...

	~xsSerializable ()
	Destructor. More...

xsSerializable *	GetParent ()
	Get serializable parent object. More...

wxXmlSerializer *	GetParentManager ()
	Get parent data manager (instance of wxXmlSerializer). More...

xsSerializable *	GetFirstChild ()
	Get first serializable child object. More...

xsSerializable *	GetFirstChild (wxClassInfo *type)
	Get first serializable child object of given type. More...

xsSerializable *	GetLastChild ()
	Get last serializable child object. More...

xsSerializable *	GetLastChild (wxClassInfo *type)
	Get last serializable child object of given type. More...

xsSerializable *	GetSibbling ()
	Get next serializable sibbling object. More...

xsSerializable *	GetSibbling (wxClassInfo *type)
	Get next serializable sibbling object of given type. More...

xsSerializable *	GetChild (long id, bool recursive=xsNORECURSIVE)
	Get child item with given ID if exists. More...

bool	HasChildren () const
	Function finds out whether this serializable item has some children. More...

SerializableList &	GetChildrenList ()
	Get list of children (serializable objects) of this object. More...

void	GetChildren (wxClassInfo *type, SerializableList &list)
	Get children of given type. More...

void	GetChildrenRecursively (wxClassInfo *type, SerializableList &list, SEARCHMODE mode=searchBFS)
	Get all children of given type recursively (i.e. children of children of .... ). More...

SerializableList::compatibility_iterator	GetFirstChildNode () const
	Get pointer to list node containing first serializable child object. More...

SerializableList::compatibility_iterator	GetLastChildNode () const
	Get pointer to list node containing last serializable child object. More...

void	SetParent (xsSerializable *parent)
	Set serializable parent object. More...

void	SetParentManager (wxXmlSerializer *parent)
	Set parent data manager. More...

xsSerializable *	AddChild (xsSerializable *child)
	Add serializable child object to this object. More...

xsSerializable *	InsertChild (size_t pos, xsSerializable *child)
	Insert serializable child object to this object at given position. More...

void	RemoveChild (xsSerializable *child)
	Remove serializable child item from this object (the child item will be destroyed). More...

void	RemoveChildren ()
	Remove all child items (all items will be destroyed). More...

void	Reparent (xsSerializable *parent)
	Assign this object as a child to given parent object. More...

void	SetId (long id)
	Set ID of this object. Can be used for further objects' handling by wxXmlSerializer class (default ID value is -1). This functions should NOT be used directly; it is called by wxXmlSerializer object in the case that this serializable object is attached to another one (or directly to root node of wxXmlSerializer) by wxXmlSerializer::AddItem() member function. More...

long	GetId () const
	Get object ID. More...

wxXmlNode *	SerializeObject (wxXmlNode *node)
	Create new 'object' XML node and serialize all marked class data members (properties) into it. More...

void	DeserializeObject (wxXmlNode *node)
	Deserialize marked class data members (properties) from appropriate fields of given parent 'object' XML node. More...

void	AddProperty (xsProperty *property)
	Add new property to the property list. More...

void	RemoveProperty (xsProperty *property)
	Remove given property from the property list. More...

xsProperty *	GetProperty (const wxString &field)
	Get serialized property of given name. More...

PropertyList &	GetProperties ()
	Get reference to properties list. More...

void	EnablePropertySerialization (const wxString &field, bool enab)
	Enable/disable serialization of given property. More...

bool	IsPropertySerialized (const wxString &field)
	Returns information whether the given property is serialized or not. More...

void	EnableSerialization (bool enab)
	Enable/disable object serialization. More...

bool	IsSerialized () const
	Returns information whether the object can be serialized or not. More...

void	EnableCloning (bool enab)
	Enable/disable object cloning. More...

bool	IsCloningEnabled () const
	Returns information whether the object can be cloned or not. More...

xsSerializable *	operator<< (xsSerializable *child)
	Add serializable child object to this object. More...

Protected Attributes
int	m_nRadius
	Circle radius. More...

Protected Attributes inherited from wxSFSolidArrow
wxBrush	m_Fill
	Arrows brush. More...

wxPen	m_Pen
	Arrow pen. More...

Protected Attributes inherited from wxSFArrowBase
wxSFShapeBase *	m_pParentShape
	Pointer to a parent shape. More...

Protected Attributes inherited from xsSerializable
PropertyList	m_lstProperties
	List of serialized properties. More...

SerializableList	m_lstChildItems
	List of child objects. More...

xsSerializable *	m_pParentItem
	Pointer to parent serializable object. More...

wxXmlSerializer *	m_pParentManager
	Pointer to parent data manager. More...

bool	m_fSerialize
	Object serialization flag. More...

bool	m_fClone
	Object cloning flag. More...

Additional Inherited Members
Public Types inherited from xsSerializable
enum	SEARCHMODE { searchDFS , searchBFS }

Protected Member Functions inherited from wxSFSolidArrow
void	MarkSerializableDataMembers ()

Protected Member Functions inherited from wxSFArrowBase
void	TranslateArrow (wxPoint trg, const wxRealPoint src, int n, const wxRealPoint &from, const wxRealPoint &to)
	Rotate and move arrow's vertices in accordance of virtual line at which end the arrow will be placed. More...

Protected Member Functions inherited from xsSerializable
void	InitChild (xsSerializable *child)
	Initialize new child object. More...

virtual wxXmlNode *	Serialize (wxXmlNode *node)
	Serialize stored properties to the given XML node. The serialization routine is automatically called by the framework and cares about serialization of all defined properties. More...

virtual void	Deserialize (wxXmlNode *node)
	Deserialize object properties from the given XML node. The routine is automatically called by the framework and cares about deserialization of all defined properties. More...

Detailed Description

Class extends the wxSFSolidBase class and encapsulates arrow shape consisting of a filled circle located at the end of the parent line shape.

Constructor & Destructor Documentation

◆ wxSFCircleArrow() [1/3]

wxSFCircleArrow::wxSFCircleArrow ( void )

Default constructor.

◆ wxSFCircleArrow() [2/3]

wxSFCircleArrow::wxSFCircleArrow ( wxSFShapeBase * parent )

User constructor.

Parameters

parent Pointer to the parent shape

◆ wxSFCircleArrow() [3/3]

wxSFCircleArrow::wxSFCircleArrow ( const wxSFCircleArrow & obj )

Copy constructor.

Parameters

obj	Reference to the source object

◆ ~wxSFCircleArrow()

virtual wxSFCircleArrow::~wxSFCircleArrow ( void )

virtual

Destructor.

Member Function Documentation

◆ Draw()

virtual void wxSFCircleArrow::Draw	(	const wxRealPoint &	from,
		const wxRealPoint &	to,
		wxDC &	dc
	)

virtual

Draw arrow shape at the end of a virtual line.

Parameters

from	Start of the virtual line
to	End of the virtual line
dc	Device context for drawing

Reimplemented from wxSFSolidArrow.

◆ GetRadius()

int wxSFCircleArrow::GetRadius ( ) const

inline

Get radius of circle arrow.

Returns: Radius if circle arrow

◆ SetRadius()

void wxSFCircleArrow::SetRadius ( int radius )

inline

Set radius of circle arrow.

Parameters

radius Radius of circle arrow

◆ XS_DECLARE_CLONABLE_CLASS()

wxSFCircleArrow::XS_DECLARE_CLONABLE_CLASS ( wxSFCircleArrow )

Member Data Documentation

◆ m_nRadius

int wxSFCircleArrow::m_nRadius

protected

Circle radius.

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

CircleArrow.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ wxSFCircleArrow() [1/3]

◆ wxSFCircleArrow() [2/3]

◆ wxSFCircleArrow() [3/3]

◆ ~wxSFCircleArrow()

Member Function Documentation

◆ Draw()

◆ GetRadius()

◆ SetRadius()

◆ XS_DECLARE_CLONABLE_CLASS()

Member Data Documentation

◆ m_nRadius