wxArt2D
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
a2dTipWindowProperty Class Reference

property to hold a tip window type variable to be associated with a a2dObject More...

#include <gen.h>

Inheritance diagram for a2dTipWindowProperty:
Inheritance graph
[legend]
Collaboration diagram for a2dTipWindowProperty:
Collaboration graph
[legend]

Public Member Functions

 a2dTipWindowProperty (const a2dPropertyIdWindow *id, wxTipWindow *window, const wxString &tipstring, bool useObjRect=true)
 constructor More...
 
 a2dTipWindowProperty (const a2dPropertyIdWindow *id, wxTipWindow *window, const wxString &tipstring, const wxRect &rect)
 constructor More...
 
 a2dTipWindowProperty (const a2dTipWindowProperty *ori)
 
 a2dTipWindowProperty (const a2dTipWindowProperty &other)
 
virtual void Assign (const a2dNamedProperty &other)
 Virtual assignment operator.
 
void SetString (const wxString &tipstring)
 
const wxString & GetString (void)
 when a2dStringProperty, return its value else assert
 
const wxRect & GetRect () const
 get rect which keep tip visible
 
bool GetUseObjRect () const
 is the tip based on a2dCanvasObject boundingbox
 
virtual void DoSave (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dXmlSer_flag xmlparts, a2dObjectList *towrite)
 
virtual void DoLoad (wxObject *parent, a2dIOHandlerXmlSerIn &parser, a2dXmlSer_flag xmlparts)
 
- Public Member Functions inherited from a2dWindowProperty
 a2dWindowProperty (const a2dPropertyIdWindow *id, wxWindow *window)
 
 a2dWindowProperty (const a2dWindowProperty &other)
 
void SetValue (wxWindow *window)
 
wxWindow * GetValue () const
 
wxWindow ** GetValuePtr ()
 
- Public Member Functions inherited from a2dNamedProperty
 a2dNamedProperty ()
 Default constructor.
 
 a2dNamedProperty (const a2dPropertyId *id)
 Constructor giving an id.
 
 a2dNamedProperty (const a2dNamedProperty &other)
 Copy constructor.
 
a2dNamedPropertyClone (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 a2dPropertyIdGetId () const
 Get the a2dPropertyId object identifying this property.
 
virtual const a2dPropertyIdCreateId (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 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 a2dObjectGetRefObject () const
 when a2dProperty, return its value else assert
 
virtual a2dObjectGetRefObjectNA () const
 when a2dProperty, return its value else return NULL
 
virtual wxString StringRepresentation () const
 
virtual wxString StringValueRepresentation () const
 
virtual bool GetVisible () const
 some derived properties can be visible or not and override this
 
virtual bool GetCanRender () const
 some derived properties can be renderable or not and override this More...
 
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 DoWalker (wxObject *parent, a2dWalkerIOHandler &handler)
 
virtual void Save (wxObject *parent, a2dIOHandlerXmlSerOut &out, a2dObjectList *towrite)
 
virtual void Load (wxObject *parent, a2dIOHandlerXmlSerIn &parser)
 

Static Public Member Functions

static a2dTipWindowPropertyCreatePropertyFromString (const a2dPropertyIdWindow *id, const wxString &value)
 
- Static Public Member Functions inherited from a2dWindowProperty
static a2dWindowPropertyCreatePropertyFromString (const a2dPropertyIdWindow *id, const wxString &value)
 

Protected Member Functions

virtual a2dNamedPropertyDoClone (a2dObject::CloneOptions options, a2dRefMap *refs) const
 

Protected Attributes

wxString m_tipstring
 
bool m_useObjRect
 
wxRect m_rectStay
 
- Protected Attributes inherited from a2dWindowProperty
wxWindow * m_window
 
- Protected Attributes inherited from a2dNamedProperty
const a2dPropertyIdm_id
 The property id object identifying this property.
 

Detailed Description

property to hold a tip window type variable to be associated with a a2dObject

Value is stired as wxWindow*. GetValue() must be casted to wxTipWindow to get the tip window.

Definition at line 2850 of file gen.h.

Constructor & Destructor Documentation

a2dTipWindowProperty::a2dTipWindowProperty ( const a2dPropertyIdWindow id,
wxTipWindow *  window,
const wxString &  tipstring,
bool  useObjRect = true 
)

constructor

Parameters
idid of property e.g. a2dCanvasObject::PROPID_TipWindow
windowtip window to show
topstringstring to show in tip window
useObjRectif true, use the a2dCanvasObject its boundingbox to keep tip visible

Definition at line 3670 of file gen.cpp.

a2dTipWindowProperty::a2dTipWindowProperty ( const a2dPropertyIdWindow id,
wxTipWindow *  window,
const wxString &  tipstring,
const wxRect &  rect 
)

constructor

Parameters
idid of property e.g. a2dCanvasObject::PROPID_TipWindow
windowtip window to show
topstringstring to show in tip window
rectuse rect to keep tip visible

Definition at line 3677 of file gen.cpp.

Member Function Documentation

a2dTipWindowProperty * a2dTipWindowProperty::CreatePropertyFromString ( const a2dPropertyIdWindow 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 3744 of file gen.cpp.

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

todo read complete window object

Reimplemented from a2dWindowProperty.

Definition at line 3725 of file gen.cpp.


The documentation for this class was generated from the following files:
a2dTipWindowProperty Class Reference -- Sun Oct 12 2014 17:04:51 -- Sun Oct 12 2014 -- 1.8.5 -- wxArt2D -- . -- Main Page Reference Documentation