GRE::UI::VIEWTOOL_SIMPLE Class Reference

Base class for simple tool with associated MGUI tool, maintains transformation on MGUI tool. More...

#include <gre/uiviewtoolsimple.h>

Inheritance diagram for GRE::UI::VIEWTOOL_SIMPLE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 VIEWTOOL_SIMPLE (GRE::UI::VIEW_CANVAS &view, MGUI::TOOL_BASE &guitool, const MISTRING &name, ICONID iconid, ICID icidmenu, ICID icidbutton, bool AutoTrans=true, VIEWTOOLID toolid=VIEWTOOLID_Unspecified, char HotKey=0)
 VIEWTOOL_SIMPLE (GRE::UI::VIEW_CANVAS &view, MGUI::TOOL_BASE &guitool, const MISTRING &name, ICONID iconid, bool AutoTrans=true, VIEWTOOLID toolid=VIEWTOOLID_Unspecified, char HotKey=0)
virtual ~VIEWTOOL_SIMPLE ()
void EnableAutoTrans (bool enable)
void SetDelegateOnActivate (DELEGATE_VOID_NOPARMS delegate)
void SetDelegateOnDeactivate (DELEGATE_VOID_NOPARMS delegate)
void SetDelegateOnResume (DELEGATE_VOID_NOPARMS delegate)

Detailed Description

Base class for simple tool with associated MGUI tool, maintains transformation on MGUI tool.


Constructor & Destructor Documentation

GRE::UI::VIEWTOOL_SIMPLE::VIEWTOOL_SIMPLE ( GRE::UI::VIEW_CANVAS view,
MGUI::TOOL_BASE guitool,
const MISTRING name,
ICONID  iconid,
bool  AutoTrans = true,
VIEWTOOLID  toolid = VIEWTOOLID_Unspecified,
char  HotKey = 0 
)

Construct with associated MGUI tool.

Parameters:
AutoTrans Automatically maintain view/tool transformation to match "view" coordinates
GRE::UI::VIEWTOOL_SIMPLE::VIEWTOOL_SIMPLE ( GRE::UI::VIEW_CANVAS view,
MGUI::TOOL_BASE guitool,
const MISTRING name,
ICONID  iconid,
ICID  icidmenu,
ICID  icidbutton,
bool  AutoTrans = true,
VIEWTOOLID  toolid = VIEWTOOLID_Unspecified,
char  HotKey = 0 
)

Construct with associated MGUI tool and customization IDs.

Parameters:
AutoTrans Automatically maintain view/tool transformation to match "view" coordinates
virtual GRE::UI::VIEWTOOL_SIMPLE::~VIEWTOOL_SIMPLE (  )  [virtual]

Member Function Documentation

void GRE::UI::VIEWTOOL_SIMPLE::EnableAutoTrans ( bool  enable  )  [inline]

Enable automatic tool/view transformation.

Transformation is enabled by default.

void GRE::UI::VIEWTOOL_SIMPLE::SetDelegateOnActivate ( DELEGATE_VOID_NOPARMS  delegate  )  [inline]

Set delegate to call when tool becomes active.

Delegate is called just before GUI tool is activated to allow its position to be set.

void GRE::UI::VIEWTOOL_SIMPLE::SetDelegateOnDeactivate ( DELEGATE_VOID_NOPARMS  delegate  )  [inline]

Set delegate to call when tool becomes inactive.

Delegate is called just before GUI tool is activated to allow its position to be set.

void GRE::UI::VIEWTOOL_SIMPLE::SetDelegateOnResume ( DELEGATE_VOID_NOPARMS  delegate  )  [inline]

Set delegate to call when tool resumed after redraw.

Delegate is called just before GUI tool is resumed to allow its position to be set.


The documentation for this class was generated from the following file:

Generated on Sun Oct 7 21:35:00 2012 for TNTsdk 2012 by  doxygen 1.6.1