a2dStDrawTool Class Reference

base for tools that draw and are stack based. More...

#include <sttool.h>

Inheritance diagram for a2dStDrawTool:

Inheritance graph
[legend]
Collaboration diagram for a2dStDrawTool:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 a2dStDrawTool (a2dStToolContr *controller)
virtual ~a2dStDrawTool ()
 destructor
void SetAllowModifyTemplate (bool allowModifyTemplate)
 template adepts to style change from outside or not
bool GetAllowModifyTemplate ()
 template adepts to style change from outside or not

Protected Member Functions

bool EnterBusyMode ()
 starts a new action (e.g drawing something ) in a tool that is already pushed.
virtual void FinishBusyMode (bool closeCommandGroup=true)
 Called when the user finishes editing a distinct object */.
void AbortBusyMode ()
 Called when the user aborts editing a distinct object */.
void OnKeyDown (wxKeyEvent &event)
 called on key down events
void OnKeyUp (wxKeyEvent &event)
 called on key up events
void OnChar (wxKeyEvent &event)
 called on key events
virtual bool CreateToolObjects ()
 Create the editcopy and other tool objects (e.g. decorations).
void AdjustRenderOptions ()
 Adjust the rendering options to the needs of this tool.

Protected Attributes

bool m_AllowModifyTemplate


Detailed Description

base for tools that draw and are stack based.

Definition at line 379 of file sttool.h.


Constructor & Destructor Documentation

a2dStDrawTool::a2dStDrawTool ( a2dStToolContr controller  ) 

Parameters:
controller Pointer to a a2dStToolContr controller.

Definition at line 1526 of file sttool.cpp.


Member Function Documentation

bool a2dStDrawTool::EnterBusyMode (  )  [protected, virtual]

starts a new action (e.g drawing something ) in a tool that is already pushed.

Opens a new a2dCommandGroup, which will be closed at the end of an action. This is normally in FinishBusyMode(), but might be delayed when other tools are pushed, like the edit tool to further edit the drawn figure. This should become part of the same command group.

Reimplemented from a2dStTool.

Reimplemented in a2dDrawWirePolylineLTool.

Definition at line 1559 of file sttool.cpp.

void a2dStDrawTool::FinishBusyMode ( bool  closeCommandGroup = true  )  [protected, virtual]

Called when the user finishes editing a distinct object */.

See also:
EnterBusyMode,

GetActive You should call the base class (this) version at the END of your function

Reimplemented from a2dStTool.

Reimplemented in a2dDrawWirePolylineLTool.

Definition at line 1565 of file sttool.cpp.

void a2dStDrawTool::AbortBusyMode (  )  [protected, virtual]

Called when the user aborts editing a distinct object */.

See also:
EnterBusyMode This is supposed to undo aeverything the tool did since entering busy mode

Reimplemented from a2dStTool.

Reimplemented in a2dDrawWirePolylineLTool.

Definition at line 1579 of file sttool.cpp.

bool a2dStDrawTool::CreateToolObjects (  )  [protected, virtual]

Create the editcopy and other tool objects (e.g. decorations).

m_original must be set before this function is called

Reimplemented from a2dStTool.

Reimplemented in a2dStDrawToolFast, a2dDrawRectangleToolFast, a2dDrawCircleToolFast, a2dDrawPolygonLToolFast, and a2dDrawPolylineLToolFast.

Definition at line 1539 of file sttool.cpp.


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