a2dCanvasObjectPtrProperty Class Reference
[a2dPropObject holds property objects]

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

#include <canprop.h>

Inheritance diagram for a2dCanvasObjectPtrProperty:

Inheritance graph
[legend]
Collaboration diagram for a2dCanvasObjectPtrProperty:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 a2dCanvasObjectPtrProperty (const a2dPropertyIdCanvasObject *id, a2dCanvasObject *object, bool visible=false, bool render=false)
 a2dCanvasObjectPtrProperty (const a2dCanvasObjectPtrProperty &other, a2dObject::CloneOptions options)
a2dNamedPropertyClone (a2dObject::CloneOptions options) const
 Virtual copy constructor.
virtual void Assign (const a2dNamedProperty &other)
 Virtual assignment operator.
void SetObject (wxObject *object)
 to set the a2dCanvasObject*
a2dCanvasObjectGetCanvasObject () const
virtual a2dObjectGetRefObject () const
 to get the a2dCanvasObject*
virtual a2dObjectGetRefObjectNA () const
 when a2dProperty, return its value else return NULL
virtual void SetVisible (bool visible)
 the object is visible or not.
virtual bool GetVisible () const
 return true if the object is visible.
void SetCanRender (bool render)
 if object can be rendered or not.
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
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
bool GetSelectedOnly () const
 returns the current only selected setting.
a2dCanvasObjectGetValue () const
 Get property value.
void SetValue (a2dCanvasObject *newvalue)
 Set property value.
a2dCanvasObjectPtrGetValuePtr ()
a2dCanvasObjectPtrGetValueRef ()
const a2dCanvasObjectPtrGetValuePtr () const
const a2dCanvasObjectPtrGetValueRef () const

Static Public Member Functions

static a2dCanvasObjectPtrPropertyCreatePropertyFromString (const a2dPropertyIdCanvasObject *id, const wxString &value)

Protected Member Functions

void DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)
virtual void DoSave (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList *towrite)
 Save settings.
virtual void DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)
 Load settings.

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.


Detailed Description

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

Definition at line 192 of file canprop.h.


Member Function Documentation

virtual void a2dCanvasObjectPtrProperty::SetVisible ( bool  visible  )  [inline, virtual]

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 224 of file canprop.h.

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 232 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 240 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 249 of file canprop.h.

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 636 of file canprop.cpp.


Member Data Documentation

See also:
SetPreRender()

Definition at line 282 of file canprop.h.

See also:
SetSelectedOnly()

Definition at line 284 of file canprop.h.


The documentation for this class was generated from the following files:
a2dCanvasObjectPtrProperty Class Reference -- Tue Aug 31 18:14:06 2010 -- 31 Aug 2010 -- 1.5.5 -- wxArt2D -- . -- Main Page Reference Documentation