property to hold a a2dCanvasObject pointer type variable to be associated with a canvasobject More...

#include <canprop.h>

Inheritance diagram for a2dCanvasObjectPtrProperty:

Collaboration diagram for a2dCanvasObjectPtrProperty:

Public Member Functions
	a2dCanvasObjectPtrProperty (const a2dPropertyIdCanvasObject id, a2dCanvasObject object, bool visible=false, bool render=false)

	a2dCanvasObjectPtrProperty (const a2dCanvasObjectPtrProperty &other, a2dObject::CloneOptions options)

virtual void	Assign (const a2dNamedProperty &other)
	Virtual assignment operator.

void	SetObject (wxObject *object)
	to set the a2dCanvasObject*

a2dCanvasObject *	GetCanvasObject () const

virtual a2dObject *	GetRefObject () const
	to get the a2dCanvasObject*

virtual a2dObject *	GetRefObjectNA () const
	when a2dProperty, return its value else return NULL

virtual void	SetVisible (bool visible)
	the object is visible or not. More...

virtual bool	GetVisible () const
	return true if the object is visible.

void	SetCanRender (bool render)
	if object can be rendered or not. More...

bool	GetCanRender () const
	return true if the object can be rendered.

void	SetPreRender (bool prerender)
	is set true, the object within this property will be rendered before its parent a2dCanvasObject More...

bool	GetPreRender () const
	returns the current prerender setting.

void	SetSelectedOnly (bool selectedonly)
	is set true, the object will only be rendered, if the owning object is selected More...

bool	GetSelectedOnly () const
	returns the current only selected setting.

a2dCanvasObject *	GetValue () const
	Get property value.

void	SetValue (a2dCanvasObject *newvalue)
	Set property value.

a2dCanvasObjectPtr *	GetValuePtr ()

a2dCanvasObjectPtr &	GetValueRef ()

const a2dCanvasObjectPtr *	GetValuePtr () const

const a2dCanvasObjectPtr &	GetValueRef () const

Public Member Functions inherited from a2dNamedProperty
	a2dNamedProperty ()
	Default constructor.

	a2dNamedProperty (const a2dPropertyId *id)
	Constructor giving an id.

	a2dNamedProperty (const a2dNamedProperty &other)
	Copy constructor.

a2dNamedProperty *	Clone (a2dObject::CloneOptions options, a2dRefMap *refs=NULL) const
	Virtual copy constructor.

virtual	~a2dNamedProperty ()
	Destructor.

void	SetCheck (bool check)
	general flag use at will. More...

bool	GetCheck () const
	general flag use at will.

void	SetToObject (a2dObject *obj, a2dPropertyId::SetFlags setflags=a2dPropertyId::set_none)
	Set this property to an object. More...

void	SetToObjectClone (a2dObject *obj, a2dPropertyId::SetFlags setflags=a2dPropertyId::set_none) const
	Set this property to an object and clone it if neccessary. More...

const a2dPropertyId *	GetId () const
	Get the a2dPropertyId object identifying this property.

virtual const a2dPropertyId *	CreateId (a2dObject *parent, const wxString &name)
	creates an a2dPropertyId for this property, if it is not available.

wxString	GetName () const
	Get the name of the a2dPropertyId object.

virtual wxString	GetString () const
	when a2dStringProperty, return its value else assert

virtual double	GetDouble () const
	when a2dDoubleProperty, return its value else assert

virtual float	GetFloat () const
	when a2dFloatProperty, return its value else assert

virtual bool	GetBool () const
	when a2dBoolProperty, return its value else assert

virtual wxInt16	GetInt16 () const
	when a2dInt16Property, return its value else assert

virtual wxUint16	GetUint16 () const
	when a2dUint16Property, return its value else assert

virtual wxInt32	GetInt32 () const
	when a2dInt32Property, return its value else assert

virtual wxUint32	GetUint32 () const
	when a2dUint32Property, return its value else assert

virtual void *	GetVoidPtr () const
	when a2dVoidPtrProperty, return its value else assert

virtual wxString	StringRepresentation () const

virtual wxString	StringValueRepresentation () const

double	ParseDouble (unsigned int &position)
	parse a double from the value string

void	SkipCommaSpaces (unsigned int &position)
	parse comma, whitespace and skip it form teh value string

void	SkipSpaces (unsigned int &position)
	parse whitespace and skip it form teh value string

void	Walker (wxObject *parent, a2dWalkerIOHandler &handler)
	This is used to recursively walk through an object tree.

virtual void	Save (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dObjectList towrite)

virtual void	Load (wxObject *parent, a2dIOHandlerXmlSerIn &parser)

Static Public Member Functions
static a2dCanvasObjectPtrProperty *	CreatePropertyFromString (const a2dPropertyIdCanvasObject *id, const wxString &value)

Protected Member Functions
virtual a2dNamedProperty *	DoClone (a2dObject::CloneOptions options, a2dRefMap *refs) const

void	DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)

virtual void	DoSave (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList towrite)

virtual void	DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)

Protected Attributes
bool	m_prerender

bool	m_selectedonly

bool	m_visible
	see SetVisible()

bool	m_render
	in case of a grahics application, should this property be rendered.

wxUint32	m_resolveid
	when loading a document, this is used to resolve references to objects

a2dCanvasObjectPtr	m_object
	object held by this property.

Protected Attributes inherited from a2dNamedProperty
const a2dPropertyId *	m_id
	The property id object identifying this property.

Detailed Description

property to hold a a2dCanvasObject pointer type variable to be associated with a canvasobject

Definition at line 202 of file canprop.h.

Member Function Documentation

a2dCanvasObjectPtrProperty * a2dCanvasObjectPtrProperty::CreatePropertyFromString	(	const a2dPropertyIdCanvasObject *	id,
		const wxString &	value
	)

static

Construct a new property object from a string If this is not appropriate, this may return NULL

Definition at line 650 of file canprop.cpp.

void a2dCanvasObjectPtrProperty::SetCanRender ( bool render )

inline

if object can be rendered or not.

some properties have a reference to a a2dCanvasObject, but only to store it, not to render it as part of the object.

Definition at line 240 of file canprop.h.

void a2dCanvasObjectPtrProperty::SetPreRender ( bool prerender )

inline

is set true, the object within this property will be rendered before its parent a2dCanvasObject

Parameters

prerender if true render m_object before its parent a2dCanvasObject, default false.

Definition at line 248 of file canprop.h.

void a2dCanvasObjectPtrProperty::SetSelectedOnly ( bool selectedonly )

inline

is set true, the object will only be rendered, if the owning object is selected

Parameters

selectedonly if true, the object will only be rendered, if the owning object is selected

Definition at line 257 of file canprop.h.

virtual void a2dCanvasObjectPtrProperty::SetVisible ( bool visible )

inlinevirtual

the object is visible or not.

If a object is visible and it has a a2dObject internal, that object will rendered. A wxDocviewVisibleProperty uses this flag to make a object visible or not.

Definition at line 232 of file canprop.h.

Member Data Documentation

bool a2dCanvasObjectPtrProperty::m_prerender

protected

See Also: SetPreRender()

Definition at line 291 of file canprop.h.

bool a2dCanvasObjectPtrProperty::m_selectedonly

protected

See Also: SetSelectedOnly()

Definition at line 293 of file canprop.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation