GRE::UI::VIEWTOOLMGR Class Reference

Manager for tools attached to view. More...

#include <gre/uiviewtool.h>

List of all members.

Public Member Functions
	VIEWTOOLMGR (GRE::UI::VIEW_CANVAS *view)
	~VIEWTOOLMGR ()
bool	ActivateByHotKey (MGUI::KEYCODE keycode)
void	Add (VIEWTOOL *tool)
void	AddMenuItems (MGUI::MENU &Menu)
void	AddToolBarItems (MGUI::CTRL_TOOLBAR &ToolBar)
void	DeleteAllScripts (bool RemoveUI)
VIEWTOOL *	Find (VIEWTOOLID ViewToolID) const
VIEWTOOL *	FindByName (const MISTRING &name) const
VIEWTOOL *	GetActive () const
VIEWTOOL *	GetDefault () const
VIEW_CANVAS *	GetView () const
bool	IsActive (const VIEWTOOL *tool) const
void	Resume ()
void	SetActive (VIEWTOOL *tool)
void	Suspend ()

---

Detailed Description

Manager for tools attached to view.

---

Constructor & Destructor Documentation

GRE::UI::VIEWTOOLMGR::VIEWTOOLMGR

(

GRE::UI::VIEW_CANVAS *

view

)

[explicit]

Construct for specified view.

GRE::UI::VIEWTOOLMGR::~VIEWTOOLMGR

(

)

---

Member Function Documentation

bool GRE::UI::VIEWTOOLMGR::ActivateByHotKey

(

MGUI::KEYCODE

keycode

)

Activate tool by "hotkey" code.

Returns:

true if found matching tool, false if not.

void GRE::UI::VIEWTOOLMGR::Add

(

VIEWTOOL *

tool

)

Add tool to manager.

void GRE::UI::VIEWTOOLMGR::AddMenuItems

(

MGUI::MENU &

Menu

)

Add toggles to menu.

void GRE::UI::VIEWTOOLMGR::AddToolBarItems

(

MGUI::CTRL_TOOLBAR &

ToolBar

)

Add toggles to toolbar.

void GRE::UI::VIEWTOOLMGR::DeleteAllScripts

(

bool

RemoveUI

)

Delete all "script" tools.

Parameters:

RemoveUI

Remove user interface controls if any

VIEWTOOL* GRE::UI::VIEWTOOLMGR::Find

(

VIEWTOOLID

ViewToolID

)

const

Find tool using builtin ID.

VIEWTOOL* GRE::UI::VIEWTOOLMGR::FindByName

(

const MISTRING &

name

)

const

Find tool using name.

VIEWTOOL* GRE::UI::VIEWTOOLMGR::GetActive

(

)

const [inline]

Get active tool.

VIEWTOOL* GRE::UI::VIEWTOOLMGR::GetDefault

(

)

const

Get default tool.

VIEW_CANVAS* GRE::UI::VIEWTOOLMGR::GetView

(

)

const [inline]

Get canvas view.

bool GRE::UI::VIEWTOOLMGR::IsActive

(

const VIEWTOOL *

tool

)

const [inline]

Determine if specified tool is active.

void GRE::UI::VIEWTOOLMGR::Resume

(

)

Resume active tool.

void GRE::UI::VIEWTOOLMGR::SetActive

(

VIEWTOOL *

tool

)

[inline]

Set tool as active in manager.

For internal use only, does not activate tool itself.

void GRE::UI::VIEWTOOLMGR::Suspend

(

)

Suspend active tool.

---

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

• gre/uiviewtool.h