Class encapsulates a special shape able to manage assigned GUI controls (widgets). The GUI control's position and size can by modified via parent control shape. User can also specify how events incoming from the managed GUI control are processed.
More...
|
| wxSFControlShape () |
| Default constructor. More...
|
|
| wxSFControlShape (wxWindow *ctrl, const wxRealPoint &pos, const wxRealPoint &size, wxSFDiagramManager *manager) |
| User constructor. More...
|
|
| wxSFControlShape (const wxSFControlShape &obj) |
| Copy constructor. More...
|
|
virtual | ~wxSFControlShape () |
| Default destructor. More...
|
|
void | SetControl (wxWindow *ctrl, bool fit=sfFIT_SHAPE_TO_CONTROL) |
| Set managed GUI control. More...
|
|
wxWindow * | GetControl () |
| Get pointer to managed GUI control. More...
|
|
void | SetEventProcessing (int mask) |
| Set a way how GUI control's events are processed. More...
|
|
int | GetEventProcessing () |
| Get a way how GUI control's events are processed. More...
|
|
void | SetModFill (const wxBrush &brush) |
| Set control shape's background style used during its modification. More...
|
|
wxBrush | GetModFill () |
| Get control shape's background style used during its modification. More...
|
|
void | SetModBorder (const wxPen &pen) |
| Set control shape's border styl used during its modification. More...
|
|
wxPen | GetModBorder () |
| Get control shape's border styl used during its modification. More...
|
|
void | SetControlOffset (int offset) |
| Set control shape's offset (a gap between the shape's border and managed GUI control). More...
|
|
int | GetControlOffset () |
| Get control shape's offset (a gap between the shape's border and managed GUI control). More...
|
|
void | UpdateControl () |
| Update size and position of the managed control according to the parent shape. More...
|
|
void | UpdateShape () |
| Update size of the shape position according to the managed control. More...
|
|
virtual void | Scale (double x, double y, bool children=sfWITHCHILDREN) |
|
virtual void | MoveTo (double x, double y) |
| Move the shape to the given absolute position. The function can be overrided if necessary. More...
|
|
virtual void | MoveBy (double x, double y) |
| Move the shape by the given offset. The function can be overrided if neccessary. More...
|
|
virtual void | Update () |
| Upate shape (align all child shapes an resize it to fit them) More...
|
|
virtual void | FitToChildren () |
| Resize the shape to bound all child shapes. The function can be overrided if neccessary. More...
|
|
virtual void | OnBeginDrag (const wxPoint &pos) |
| Event handler called at the begining of the shape dragging process. The function can be overrided if necessary. More...
|
|
virtual void | OnEndDrag (const wxPoint &pos) |
| Event handler called at the end of the shape dragging process. The function can be overrided if necessary. More...
|
|
virtual void | OnBeginHandle (wxSFShapeHandle &handle) |
| Event handler called when the user started to drag the shape handle. The function can be overrided if necessary. More...
|
|
virtual void | OnHandle (wxSFShapeHandle &handle) |
| Event handler called during dragging of the shape handle. The function can be overrided if necessary. More...
|
|
virtual void | OnEndHandle (wxSFShapeHandle &handle) |
| Event handler called when the user finished dragging of the shape handle. The function can be overrided if necessary. More...
|
|
| XS_DECLARE_CLONABLE_CLASS (wxSFRectShape) |
|
| wxSFRectShape (void) |
| Default constructor. More...
|
|
| wxSFRectShape (const wxRealPoint &pos, const wxRealPoint &size, wxSFDiagramManager *manager) |
| User constructor. More...
|
|
| wxSFRectShape (const wxSFRectShape &obj) |
| Copy constructor. More...
|
|
virtual | ~wxSFRectShape (void) |
| Destructor. More...
|
|
virtual wxRect | GetBoundingBox () |
|
virtual wxRealPoint | GetBorderPoint (const wxRealPoint &start, const wxRealPoint &end) |
|
virtual void | CreateHandles () |
|
void | SetFill (const wxBrush &brush) |
| Set rectangle's fill style. More...
|
|
wxBrush | GetFill () const |
| Get current fill style. More...
|
|
void | SetBorder (const wxPen &pen) |
| Set rectangle's border style. More...
|
|
wxPen | GetBorder () const |
| Get current border style. More...
|
|
void | SetRectSize (const wxRealPoint &size) |
| Set the rectangle size. More...
|
|
void | SetRectSize (double x, double y) |
| Set the rectangle size. More...
|
|
wxRealPoint | GetRectSize () const |
| Get the rectangle size. More...
|
|
| XS_DECLARE_CLONABLE_CLASS (wxSFShapeBase) |
|
| wxSFShapeBase (void) |
| Basic constructor. More...
|
|
| wxSFShapeBase (const wxRealPoint &pos, wxSFDiagramManager *manager) |
| Enhanced constructor. More...
|
|
| wxSFShapeBase (const wxSFShapeBase &obj) |
| Copy constructor. More...
|
|
virtual | ~wxSFShapeBase (void) |
| Destructor. More...
|
|
void | Refresh (bool delayed=false) |
| Refresh (redraw) the shape. More...
|
|
virtual void | Draw (wxDC &dc, bool children=sfWITHCHILDREN) |
| Draw shape. Default implementation tests basic shape visual states (normal/ready, mouse is over the shape, dragged shape can be accepted) and call appropriate virtual functions (DrawNormal, DrawHover, DrawHighlighted) for its visualisation. The function can be overrided if neccessary. More...
|
|
virtual bool | Contains (const wxPoint &pos) |
|
virtual bool | IsInside (const wxRect &rct) |
|
virtual bool | Intersects (const wxRect &rct) |
| Test whether the given rectangle intersects the shape. More...
|
|
virtual wxRealPoint | GetAbsolutePosition () |
| Get the shape's absolute position in the canvas (calculated as a sumation of all relative positions in the shapes' hierarchy. The function can be overrided if neccessary. More...
|
|
virtual wxRealPoint | GetCenter () |
| Get shape's center. Default implementation does nothing. The function can be overrided if neccessary. More...
|
|
void | ShowHandles (bool show) |
| Show/hide shape handles. Hidden handles are inactive. More...
|
|
void | SetStyle (long style) |
| Set shape's style. More...
|
|
long | GetStyle () const |
| Get current shape style. More...
|
|
void | AddStyle (STYLE style) |
|
void | RemoveStyle (STYLE style) |
|
bool | ContainsStyle (STYLE style) const |
|
void | GetChildShapes (wxClassInfo *type, ShapeList &children, bool recursive=false, xsSerializable::SEARCHMODE mode=xsSerializable::searchBFS) |
|
void | GetNeighbours (ShapeList &neighbours, wxClassInfo *shapeInfo, CONNECTMODE condir, bool direct=true) |
| Get neighbour shapes connected to this shape. More...
|
|
void | GetAssignedConnections (wxClassInfo *shapeInfo, wxSFShapeBase::CONNECTMODE mode, ShapeList &lines) |
| Get list of connections assigned to this shape. More...
|
|
void | GetCompleteBoundingBox (wxRect &rct, int mask=bbALL) |
| Get shape's bounding box which includes also associated child shapes and connections. More...
|
|
void | Scale (const wxRealPoint &scale, bool children=sfWITHCHILDREN) |
|
void | ScaleChildren (double x, double y) |
| Scale shape's children. More...
|
|
void | MoveTo (const wxRealPoint &pos) |
| Move the shape to the given absolute position. More...
|
|
void | MoveBy (const wxRealPoint &delta) |
| Move the shape by the given offset. More...
|
|
void | DoAlignment () |
| Update the shape's position in order to its alignment. More...
|
|
bool | IsSelected () const |
| Function returns TRUE if the shape is selected, otherwise returns FALSE. More...
|
|
void | Select (bool state) |
| Set the shape as a selected/deselected one. More...
|
|
void | SetRelativePosition (const wxRealPoint &pos) |
|
void | SetRelativePosition (double x, double y) |
|
wxRealPoint | GetRelativePosition () const |
|
void | SetVAlign (VALIGN val) |
| Set vertical alignment of this shape inside its parent. More...
|
|
VALIGN | GetVAlign () const |
| Get vertical alignment of this shape inside its parent. More...
|
|
void | SetHAlign (HALIGN val) |
| Set horizontal alignment of this shape inside its parent. More...
|
|
HALIGN | GetHAlign () const |
| Get horizontal alignment of this shape inside its parent. More...
|
|
void | SetVBorder (double border) |
| Set vertical border between this shape and its parent (is vertical alignment is set). More...
|
|
double | GetVBorder () const |
| Get vertical border between this shape and its parent (is vertical alignment is set). More...
|
|
void | SetHBorder (double border) |
| Set horizontal border between this shape and its parent (is horizontal alignment is set). More...
|
|
double | GetHBorder () const |
| Get horizontal border between this shape and its parent (is horizontal alignment is set). More...
|
|
void | SetCustomDockPoint (int dp) |
| Set custom dock point used if the shape is child shape of a line shape. More...
|
|
int | GetCustomDockPoint () |
| Get custom dock point used if the shape is child shape of a line shape. More...
|
|
wxSFShapeBase * | GetParentShape () |
| Get pointer to a parent shape. More...
|
|
wxSFShapeBase * | GetGrandParentShape () |
| Get pointer to the topmost parent shape. More...
|
|
bool | IsAncestor (wxSFShapeBase *child) |
| Determine whether this shape is ancestor of given child shape. More...
|
|
bool | IsDescendant (wxSFShapeBase *parent) |
| Determine whether this shape is descendant of given parent shape. More...
|
|
void | SetUserData (xsSerializable *data) |
| Associate user data with the shape. More...
|
|
xsSerializable * | GetUserData () |
| Get associated user data. More...
|
|
wxSFDiagramManager * | GetShapeManager () |
| Get shape's parent diagram manager. More...
|
|
wxSFShapeCanvas * | GetParentCanvas () |
| Get shape's parent canvas. More...
|
|
bool | IsVisible () const |
| Get the shape's visibility status. More...
|
|
void | Show (bool show) |
| Show/hide shape. More...
|
|
void | SetHoverColour (const wxColour &col) |
| Set shape's hover color. More...
|
|
wxColour | GetHoverColour () const |
| Get shape's hover color. More...
|
|
bool | IsActive () const |
| Function returns value of a shape's activation flag. More...
|
|
void | Activate (bool active) |
| Shape's activation/deactivation. More...
|
|
bool | IsChildAccepted (const wxString &type) |
| Tells whether the given shape type is accepted by this shape (it means whether this shape can be its parent). More...
|
|
bool | AcceptCurrentlyDraggedShapes () |
| Function returns TRUE if all currently dragged shapes can be accepted as children of this shape. More...
|
|
void | AcceptChild (const wxString &type) |
| Add given shape type to an acceptance list. The acceptance list contains class names of the shapes which can be accepted as children of this shape. Note: Keyword 'All' behaves like any class name. More...
|
|
wxArrayString & | GetAcceptedChildren () |
| Get shape types acceptance list. More...
|
|
bool | IsConnectionAccepted (const wxString &type) |
| Tells whether the given connection type is accepted by this shape (it means whether this shape can be connected to another one by a connection of given type). More...
|
|
void | AcceptConnection (const wxString &type) |
| Add given connection type to an acceptance list. The acceptance list contains class names of the connection which can be accepted by this shape. Note: Keyword 'All' behaves like any class name. More...
|
|
wxArrayString & | GetAcceptedConnections () |
| Get connection types acceptance list. More...
|
|
bool | IsSrcNeighbourAccepted (const wxString &type) |
| Tells whether the given shape type is accepted by this shape as its source neighbour(it means whether this shape can be connected from another one of given type). More...
|
|
void | AcceptSrcNeighbour (const wxString &type) |
| Add given shape type to an source neighbours' acceptance list. The acceptance list contains class names of the shape types which can be accepted by this shape as its source neighbour. Note: Keyword 'All' behaves like any class name. More...
|
|
wxArrayString & | GetAcceptedSrcNeighbours () |
| Get source neighbour types acceptance list. More...
|
|
bool | IsTrgNeighbourAccepted (const wxString &type) |
| Tells whether the given shape type is accepted by this shape as its target neighbour(it means whether this shape can be connected to another one of given type). More...
|
|
void | AcceptTrgNeighbour (const wxString &type) |
| Add given shape type to an target neighbours' acceptance list. The acceptance list contains class names of the shape types which can be accepted by this shape as its target neighbour. Note: Keyword 'All' behaves like any class name. More...
|
|
wxArrayString & | GetAcceptedTrgNeighbours () |
| Get target neighbour types acceptance list. More...
|
|
void | ClearAcceptedChilds () |
| Clear shape object acceptance list. More...
|
|
void | ClearAcceptedConnections () |
| Clear connection object acceptance list. More...
|
|
void | ClearAcceptedSrcNeighbours () |
| Clear source neighbour objects acceptance list. More...
|
|
void | ClearAcceptedTrgNeighbours () |
| Clear target neighbour objects acceptance list. More...
|
|
HandleList & | GetHandles () |
| Get list of currently assigned shape handles. More...
|
|
wxSFShapeHandle * | GetHandle (wxSFShapeHandle::HANDLETYPE type, long id=-1) |
| Get shape handle. More...
|
|
void | AddHandle (wxSFShapeHandle::HANDLETYPE type, long id=-1) |
| Add new handle to the shape. More...
|
|
void | RemoveHandle (wxSFShapeHandle::HANDLETYPE type, long id=-1) |
| Remove given shape handle (if exists). More...
|
|
ConnectionPointList & | GetConnectionPoints () |
| Get reference to connection points list. More...
|
|
wxSFConnectionPoint * | GetConnectionPoint (wxSFConnectionPoint::CPTYPE type, long id=-1) |
| Get connection point of given type assigned to the shape. More...
|
|
wxSFConnectionPoint * | GetNearestConnectionPoint (const wxRealPoint &pos) |
| Get connection point closest to the diven position. More...
|
|
wxSFConnectionPoint * | AddConnectionPoint (wxSFConnectionPoint::CPTYPE type, bool persistent=true) |
| Assign connection point of given type to the shape. More...
|
|
void | AddConnectionPoint (wxSFConnectionPoint *cp, bool persistent=true) |
| Assigned given connection point to the shape. More...
|
|
wxSFConnectionPoint * | AddConnectionPoint (const wxRealPoint &relpos, long id=-1, bool persistent=true) |
| Assign custom connection point to the shape. More...
|
|
void | RemoveConnectionPoint (wxSFConnectionPoint::CPTYPE type) |
| Remove connection point of given type from the shape (if pressent). More...
|
|
virtual void | OnLeftClick (const wxPoint &pos) |
| Event handler called when the shape is clicked by the left mouse button. The function can be overrided if necessary. More...
|
|
virtual void | OnRightClick (const wxPoint &pos) |
| Event handler called when the shape is clicked by the right mouse button. The function can be overrided if necessary. More...
|
|
virtual void | OnLeftDoubleClick (const wxPoint &pos) |
| Event handler called when the shape is double-clicked by the left mouse button. The function can be overrided if necessary. More...
|
|
virtual void | OnRightDoubleClick (const wxPoint &pos) |
| Event handler called when the shape is double-clicked by the right mouse button. The function can be overrided if necessary. More...
|
|
virtual void | OnDragging (const wxPoint &pos) |
| Event handler called during the shape dragging process. The function can be overrided if necessary. More...
|
|
virtual void | OnMouseEnter (const wxPoint &pos) |
| Event handler called when a mouse pointer enters the shape area. The function can be overrided if necessary. More...
|
|
virtual void | OnMouseOver (const wxPoint &pos) |
| Event handler called when a mouse pointer moves above the shape area. The function can be overrided if necessary. More...
|
|
virtual void | OnMouseLeave (const wxPoint &pos) |
| Event handler called when a mouse pointer leaves the shape area. The function can be overrided if necessary. More...
|
|
virtual bool | OnKey (int key) |
| Event handler called when any key is pressed (in the shape canvas). The function can be overrided if necessary. More...
|
|
virtual void | OnChildDropped (const wxRealPoint &pos, wxSFShapeBase *child) |
| Event handler called when any shape is dropped above this shape (and the dropped shape is accepted as a child of this shape). The function can be overrided if necessary. More...
|
|
| 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...
|
|