used to change a property on objects More...

#include <comevt.h>

Inheritance diagram for a2dCommand_SetProperty:

Collaboration diagram for a2dCommand_SetProperty:

Public Member Functions
	a2dCommand_SetProperty ()
	for dynamic creation

	a2dCommand_SetProperty (a2dObject object, a2dNamedProperty property)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdRefObject id, a2dObject *value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdObject id, const wxObject &value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdString id, const wxString &value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdBool id, bool value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdBool id, const wxString &value)

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdInt16 id, wxInt16 value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdUint16 id, wxUint16 value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdInt32 id, wxInt32 value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdUint32 id, wxUint32 value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdDouble id, double value)
	Set property on object. More...

	a2dCommand_SetProperty (a2dObject object, const a2dPropertyIdColour id, const wxColour &colour)
	Set property on object. More...

	a2dCommand_SetProperty (const a2dCommand_SetProperty &other)
	copy constructor

a2dNamedProperty *	GetProperty ()
	property that is set packed as a2dNamedProperty.

const a2dPropertyId *	GetPropertyId ()
	property that is set packed as a2dNamedProperty.

a2dObject *	GetObject ()

bool	Do ()
	Override this to perform a command.

bool	Undo ()
	Override this to undo a command.

Public Member Functions inherited from a2dCommand
	a2dCommand (bool canUndo=false, const a2dCommandId &commandId=sm_noCommandId, const a2dCommandId &commandTypeId=sm_noCommandTypeId, const wxString &menuString=wxEmptyString)
	constructor More...

	~a2dCommand (void)
	destructor

a2dCommand *	TClone (CloneOptions options=clone_deep, a2dRefMap *refs=NULL)

virtual wxString	GetName () const

const a2dCommandId *	GetCommandId ()
	a specific id for this command. More...

const a2dCommandId *	GetCommandTypeId ()
	used to identify groups of simular commands

virtual a2dCommand *	CloneAndBind (a2dObject *object)
	Copy and instantiate the command. More...

virtual bool	PreDo ()
	Override this to perform a dependency action before command is done.

virtual bool	PostDo ()
	Override this to perform a dependency action after command is done.

virtual bool	CanUndo () const

virtual bool	Redo ()

bool	Modifies ()

void	SetCommandProcessor (a2dCommandProcessor *cmp)
	set when submitting this command via a2dCommandProcessor

a2dCommandProcessor *	GetCommandProcessor ()

virtual bool	ClearAfterCurrentCommand (a2dCommand *current)
	Hierarchically clear all commands after current command. More...

virtual class a2dCommandGroup *	IsCommandGroup ()
	This is like a wxDynamicCast, but much faster.

virtual a2dCommand *	FindPrevious (a2dCommand *current) const
	Find the previous command of the given command.

virtual a2dCommand *	FindNext (a2dCommand *current) const
	Find the next command of the given command.

virtual bool	Remove (a2dCommand *command)
	Remove the given command.

virtual bool	ContainsCommand (a2dCommand *command)
	return true if this command/group are nested group contains the given command

virtual void	DistributeEvent (wxEventType eventType)

Public Member Functions inherited from a2dObject
virtual bool	ProcessEvent (wxEvent &event)

bool	SearchDynamicEventTable (wxEvent &event)

void	Connect (int winid, int lastId, int eventType, wxObjectEventFunction func, wxObject userData=(wxObject ) NULL, wxEvtHandler eventSink=(wxEvtHandler ) NULL)

bool	Disconnect (int winid, int lastId, wxEventType eventType, wxObjectEventFunction func=NULL, wxObject userData=(wxObject ) NULL, wxEvtHandler eventSink=(wxEvtHandler ) NULL)

void	ProcessConnectedEvent (wxEvent &event)
	wxCHECK_VERSION(2,9,0) More...

void	ConnectEvent (wxEventType type, wxEvtHandler *eventSink)

bool	DisconnectEvent (wxEventType type, wxEvtHandler *eventSink)

bool	DisconnectEventAll (wxEvtHandler *eventSink)
	Remove all dynamic events in classA, going to classB (eventSink) More...

	a2dObject ()
	constructor

virtual	~a2dObject ()
	destructor

void	operator= (const a2dObject &other)
	assignment operator

int	GetOwnedBy ()
	like it to be protected, but this does not work with wxList macros More...

virtual a2dObject *	SetNonDynamic ()
	Call to mark this object as non-dynamic (static/local/auto) More...

void	CheckReferences ()
	Check zero reference count and delete if count is 0. More...

a2dObject *	Clone (CloneOptions options, a2dRefMap *refs=NULL) const
	create an exact copy of this property

	a2dObject (const a2dObject &other, CloneOptions options, a2dRefMap *refs)

virtual void	SetName (const wxString &name)
	Creates the a2dStringProperty PROPID_Name. More...

virtual bool	IsTemporary_DontSave () const
	Check if this is a temporary object, which should not be saved.

void	SaveAsDocument (a2dIOHandlerXmlSerOut &out)
	Save this object and all below as an XML document. More...

virtual void	Save (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dObjectList towrite)
	write all needed to an XML type of file called the CVG format More...

void	LoadFromDocument (a2dIOHandlerXmlSerIn &parser)
	Load this object and all below from an XML document. More...

virtual void	Load (wxObject *parent, a2dIOHandlerXmlSerIn &parser)
	load object from CVG file More...

wxInt64	GetUniqueSerializationId () const
	return a unique id for this object More...

virtual bool	AlwaysWriteSerializationId () const
	If true, always write an id. More...

virtual bool	LinkReference (a2dObject *other)
	link a reference in the object to the given value More...

virtual void	ResolveInform ()
	inform an object that reference resolution was done More...

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

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

bool	GetCheck () const
	general flag use at will.

void	SetRelease (bool value)
	set release flag More...

bool	GetRelease () const
	get release flag More...

a2dAutoZeroPtr< a2dObject > **	GetAutoZeroPtrList ()
	return the list head pointer for autozero pointers to this object More...

	DECLARE_PROPERTIES ()

a2dNamedProperty *	GetProperty (const a2dPropertyId *propertyId, a2dPropertyId::Flags flags=a2dPropertyId::flag_none) const
	get property on this object More...

void	SetProperty (a2dNamedProperty *propertyHolder, a2dPropertyId::SetFlags flags=a2dPropertyId::set_none)
	Set the property to the this object. More...

void	SetProperty (const a2dNamedProperty &propertyHolder, a2dPropertyId::SetFlags flags=a2dPropertyId::set_none)
	Set the property to the this object and if enabled, to all childs and object members. More...

virtual a2dNamedProperty *	FindProperty (const a2dPropertyId *id, a2dPropertyId::Flags flags=a2dPropertyId::flag_none)
	Find a dynamic property with given id in the property list. More...

virtual const a2dNamedProperty *	FindProperty (const a2dPropertyId *id, a2dPropertyId::Flags flags=a2dPropertyId::flag_none) const
	Find a dynamic property with given id in the property list. More...

virtual bool	HasProperty (const a2dPropertyId *id, const wxString &stringvalue=wxEmptyString) const
	Check if the object has a property with given id and string representation. More...

virtual void	OnPropertyChanged (const a2dPropertyId *id)
	This function is called after a property changed. More...

virtual bool	EditProperties (const a2dPropertyId *id, bool withUndo=true)
	edit properties of the object More...

void	TakeOverProperties (a2dObject from, a2dPropertyIdList listOfIds)
	Properties in the id list are taken from the given object, en set to this. More...

wxURI	GetURI () const
	quick way to get to PROPID_URI property More...

void	SetURI (const wxURI &url)
	quickly set a property PROPID_URI More...

const a2dNamedPropertyList &	GetPropertyList () const
	Get the Property List. More...

bool	HasDynamicProperties () const
	test if there are dynamic properties in the m_propertylist

virtual bool	RemoveProperty (const a2dPropertyId *id, bool all=true)
	This function is called by a2dPropertyId to remove a property from the list. More...

void	RemoveTemporaryProperties ()
	remove all temporary properties

virtual bool	AddProperty (a2dNamedProperty *property)
	This function is called by a2dPropertyId to add a property to the list. More...

Static Public Attributes
static const a2dCommandId	Id = a2dCommandId( wxT( "SetProperty" ) )

Static Public Attributes inherited from a2dCommand
static const a2dCommandId	sm_noCommandId = a2dCommandId( wxT( "NoCommandId" ) )
	property for command id

static const a2dCommandId	sm_noCommandTypeId = a2dCommandId( wxT( "NoCommandTypeId" ) )
	property for type of command id

static const a2dCommandId	sm_groupCommandId = a2dCommandId( wxT( "GroupCommandId" ) )
	property for group command id

Static Public Attributes inherited from a2dObject
static a2dPropertyIdBool *	PROPID_Check = NULL
	used for linking multiple referenced objects when serializing

static a2dPropertyIdUri *	PROPID_URI = NULL
	attach an URL to the object

static a2dPropertyIdString *	PROPID_Name = NULL
	Name property, to return name of this object.

static a2dPropertyIdVoidPtr *	PROPID_autozeroptrlist = NULL

static const a2dSignal	sm_Edit_properties = wxNewId()
	edit properties event, see EditProperties()

Protected Member Functions
	a2dCommand_SetProperty (a2dObject object, const a2dPropertyId id)
	this is for derived classes and derived properties

Protected Member Functions inherited from a2dCommand
virtual a2dObject *	DoClone (CloneOptions options, a2dRefMap *refs) const
	Clone this object and return a pointer to the new object.

void	DoSave (wxObject parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList towrite)
	Save settings.

void	DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)
	Load settings.

	a2dCommand (const a2dCommand &other)
	this is a not implemented copy constructor that avoids automatic creation of one

Protected Member Functions inherited from a2dObject
virtual bool	DoIgnoreIfNotMember (const a2dPropertyId *id) const
	used to decide if a property shall be ignored, if it is not a member More...

virtual void	DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)
	iterate over this object and its children More...

Protected Attributes
a2dAutoZeroPtr< a2dObject >	m_propRefObject
	all property references will be set NULL when this object, having the property, will be deleted.

a2dNamedPropertyPtr	m_property
	property set to the object.

const a2dPropertyId *	m_id
	id of the property that is set.

Protected Attributes inherited from a2dCommand
bool	m_canUndo
	can this command be undone

bool	m_modifies

const a2dCommandId *	m_commandId
	can be used to identify the command

const a2dCommandId *	m_commandTypeId
	if set can be used to identify groups of commands

a2dCommandProcessor *	m_cmp
	allows commands to get to the command processor that submitted the command.

wxString	m_menuString
	if set this will be used for menu Undo/Redo labels, else the m_commandId its name is used.

Protected Attributes inherited from a2dObject
a2dNamedPropertyList	m_propertylist
	properties

int	m_refcount
	how many references to this object do exist

bool	m_check: 1
	used for linking multiple referenced objects when serializing

bool	m_release: 1
	when set object is treated as being deleted, and wil be deleted in idle time.

bool	m_recursion_active: 1
	this is used as a recursion stopper

bool	m_pendingDisconnects: 1

unsigned int	m_iteratorCount

a2dAutoZeroPtr< a2dObject > *	m_autozeroptrlist
	this is a list of all a2dAutoZeroPtr object pointing to this object

Additional Inherited Members
Public Types inherited from a2dObject
enum	CloneOptions { clone_members = 0x00000001, clone_properties = 0x00000002, clone_childs = 0x00000004, clone_unused = 0x00000008, clone_setoriginal = 0x00000010, clone_seteditcopy = 0x00000020, clone_noReference = 0x00000040, clone_noCameleonRef = 0x00000080, clone_toDrag = 0x00000100, clone_flat = 0x00000000, clone_deep = clone_members \| clone_properties \| clone_childs }
	options for cloning More...

typedef a2dAutoZeroPtr< a2dObject >	TAutoZeroPtrListClass
	this is needed inside the smart pointer template code

Protected Types inherited from a2dObject
enum	{ refcount_nondynamic = 0x76543210 }
	special refcount value for non-dynamic objects

Detailed Description

used to change a property on objects

A a2dObject property is set on the a2dObject, and the first property on the a2dObject with the same name is used for undo. Properties with the starting with __M_ are wrapped properties, and or often used to set member variables of classes. Special name properties starting with just __ are used to set predefined properties. Both these type of properties can be set by this command. If the property was not yet set for the object, in Undo the new property is just removed, else the old value is restored.

Definition at line 460 of file comevt.h.