wxSFCanvasSettings Class Reference
Auxiliary serializable class encapsulating the canvas properties. More...
#include <ShapeCanvas.h>
Inheritance diagram for wxSFCanvasSettings:
Collaboration diagram for wxSFCanvasSettings:
Public Member Functions | |
| DECLARE_DYNAMIC_CLASS (wxSFCanvasSettings) | |
| wxSFCanvasSettings () | |
 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... | |
Public Attributes | |
| wxColour | m_nBackgroundColor |
| wxColour | m_nCommonHoverColor |
| wxColour | m_nGradientFrom |
| wxColour | m_nGradientTo |
| wxSize | m_nGridSize |
| int | m_nGridLineMult |
| wxColour | m_nGridColor |
| int | m_nGridStyle |
| wxRealPoint | m_nShadowOffset |
| wxBrush | m_ShadowFill |
| wxArrayString | m_arrAcceptedShapes |
| double | m_nScale |
| double | m_nMinScale |
| double | m_nMaxScale |
| long | m_nStyle |
| int | m_nPrintHAlign |
| int | m_nPrintVAlign |
| int | m_nPrintMode |
Additional Inherited Members | |
| Public Types inherited from xsSerializable | |
| enum | SEARCHMODE { searchDFS , searchBFS } |
| 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... | |
| 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... | |
Detailed Description
Auxiliary serializable class encapsulating the canvas properties.
Constructor & Destructor Documentation
◆ wxSFCanvasSettings()
| wxSFCanvasSettings::wxSFCanvasSettings | ( | ) |
Member Function Documentation
◆ DECLARE_DYNAMIC_CLASS()
| wxSFCanvasSettings::DECLARE_DYNAMIC_CLASS | ( | wxSFCanvasSettings | ) |
Member Data Documentation
◆ m_arrAcceptedShapes
| wxArrayString wxSFCanvasSettings::m_arrAcceptedShapes |
◆ m_nBackgroundColor
| wxColour wxSFCanvasSettings::m_nBackgroundColor |
◆ m_nCommonHoverColor
| wxColour wxSFCanvasSettings::m_nCommonHoverColor |
◆ m_nGradientFrom
| wxColour wxSFCanvasSettings::m_nGradientFrom |
◆ m_nGradientTo
| wxColour wxSFCanvasSettings::m_nGradientTo |
◆ m_nGridColor
| wxColour wxSFCanvasSettings::m_nGridColor |
◆ m_nGridLineMult
| int wxSFCanvasSettings::m_nGridLineMult |
◆ m_nGridSize
| wxSize wxSFCanvasSettings::m_nGridSize |
◆ m_nGridStyle
| int wxSFCanvasSettings::m_nGridStyle |
◆ m_nMaxScale
| double wxSFCanvasSettings::m_nMaxScale |
◆ m_nMinScale
| double wxSFCanvasSettings::m_nMinScale |
◆ m_nPrintHAlign
| int wxSFCanvasSettings::m_nPrintHAlign |
◆ m_nPrintMode
| int wxSFCanvasSettings::m_nPrintMode |
◆ m_nPrintVAlign
| int wxSFCanvasSettings::m_nPrintVAlign |
◆ m_nScale
| double wxSFCanvasSettings::m_nScale |
◆ m_nShadowOffset
| wxRealPoint wxSFCanvasSettings::m_nShadowOffset |
◆ m_nStyle
| long wxSFCanvasSettings::m_nStyle |
◆ m_ShadowFill
| wxBrush wxSFCanvasSettings::m_ShadowFill |
The documentation for this class was generated from the following file:
