GRE::UI::VIEWTOOL Class Reference

Base class for tool attached to view. More...

#include <gre/uiviewtool.h>

Inheritance diagram for GRE::UI::VIEWTOOL:

[legend]

List of all members.

Public Member Functions
virtual	~VIEWTOOL ()
void	Activate ()
void	AddMenuItem (MGUI::MENU &Menu)
void	AddToolBarItem (MGUI::CTRL_TOOLBAR &ToolBar)
void	Deactivate ()
MDLGPARENT	GetDlgParent () const
MGUI::KEYCODE	GetHotKeyCode () const
ICONID	GetIconID () const
const MISTRING &	GetName () const
GRE::UI::VIEW_CANVAS *	GetView () const
VIEWABLE *	GetViewable () const
const VIEWTOOLID	GetViewToolID () const
bool	IsActive () const
bool	IsDisabled () const
bool	IsScript () const
bool	IsSuspended () const
void	RemoveUI ()
void	Resume ()
void	SetEnabled (bool enable)
void	Suspend ()
Protected Types
enum	TOOLSTATE {   STATE_NotInitialized = 0, STATE_Inactive, STATE_Active, STATE_NoLayers,   STATE_Suspended }
Protected Member Functions
	VIEWTOOL (GRE::UI::VIEW_CANVAS &view, const MISTRING &name, ICONID iconid, VIEWTOOLID toolid=VIEWTOOLID_Unspecified, char HotKey=0)
	VIEWTOOL (GRE::UI::VIEW_CANVAS &view, const MISTRING &name, ICONID iconid, ICID icidMenu, ICID icidToolBar, VIEWTOOLID toolid=VIEWTOOLID_Unspecified, char HotKey=0)
TOOLSTATE	GetState () const
void	SetIsScript ()
Private Member Functions
Overridables
virtual bool	v_Activate ()=0
virtual void	v_Deactivate ()=0
virtual bool	v_Initialize ()
virtual void	v_Resume ()
virtual void	v_Suspend ()

---

Detailed Description

Base class for tool attached to view.

---

Member Enumeration Documentation

enum GRE::UI::VIEWTOOL::TOOLSTATE [protected]

Enumerator:

STATE_NotInitialized
STATE_Inactive
STATE_Active
STATE_NoLayers
STATE_Suspended

---

Constructor & Destructor Documentation

virtual GRE::UI::VIEWTOOL::~VIEWTOOL

(

)

[virtual]

Destructor.

GRE::UI::VIEWTOOL::VIEWTOOL	(	GRE::UI::VIEW_CANVAS &	view,
		const MISTRING &	name,
		ICONID	iconid,
		ICID	icidMenu,
		ICID	icidToolBar,
		VIEWTOOLID	toolid = VIEWTOOLID_Unspecified,
		char	HotKey = 0
	)			[protected]

GRE::UI::VIEWTOOL::VIEWTOOL	(	GRE::UI::VIEW_CANVAS &	view,
		const MISTRING &	name,
		ICONID	iconid,
		VIEWTOOLID	toolid = VIEWTOOLID_Unspecified,
		char	HotKey = 0
	)			[protected]

---

Member Function Documentation

void GRE::UI::VIEWTOOL::Activate

(

)

Activate this tool.

void GRE::UI::VIEWTOOL::AddMenuItem

(

MGUI::MENU &

Menu

)

Add toggle to menu.

void GRE::UI::VIEWTOOL::AddToolBarItem

(

MGUI::CTRL_TOOLBAR &

ToolBar

)

Add toggle to toolbar.

void GRE::UI::VIEWTOOL::Deactivate

(

)

Deactivate this tool.

MDLGPARENT GRE::UI::VIEWTOOL::GetDlgParent

(

)

const [inline]

Get parent for tool dialogs.

MGUI::KEYCODE GRE::UI::VIEWTOOL::GetHotKeyCode

(

)

const [inline]

Get "hotkey" KEYCODE.

ICONID GRE::UI::VIEWTOOL::GetIconID

(

)

const [inline]

Get icon ID.

const MISTRING& GRE::UI::VIEWTOOL::GetName

(

)

const [inline]

Get name for menu and ToolTip.

TOOLSTATE GRE::UI::VIEWTOOL::GetState

(

)

const [inline, protected]

Get current tool state.

GRE::UI::VIEW_CANVAS* GRE::UI::VIEWTOOL::GetView

(

)

const [inline]

Get view.

VIEWABLE* GRE::UI::VIEWTOOL::GetViewable

(

)

const [inline]

Get viewable object.

const VIEWTOOLID GRE::UI::VIEWTOOL::GetViewToolID

(

)

const [inline]

Get ID for builtin tool.

bool GRE::UI::VIEWTOOL::IsActive

(

)

const

Determine if tool is currently active.

bool GRE::UI::VIEWTOOL::IsDisabled

(

)

const [inline]

Determine if tool is currently disabled.

bool GRE::UI::VIEWTOOL::IsScript

(

)

const [inline]

Determine if tool is user-added script.

bool GRE::UI::VIEWTOOL::IsSuspended

(

)

const [inline]

Determine if tool is "suspended".

void GRE::UI::VIEWTOOL::RemoveUI

(

)

Remove user interface controls.

void GRE::UI::VIEWTOOL::Resume

(

)

Resume tool (after screen update).

void GRE::UI::VIEWTOOL::SetEnabled

(

bool

enable

)

Set whether items on toolbar and menu are enabled.

void GRE::UI::VIEWTOOL::SetIsScript

(

)

[inline, protected]

void GRE::UI::VIEWTOOL::Suspend

(

)

Suspend tool (during screen update).

virtual bool GRE::UI::VIEWTOOL::v_Activate

(

)

[private, pure virtual]

virtual void GRE::UI::VIEWTOOL::v_Deactivate

(

)

[private, pure virtual]

virtual bool GRE::UI::VIEWTOOL::v_Initialize

(

)

[private, virtual]

virtual void GRE::UI::VIEWTOOL::v_Resume

(

)

[private, virtual]

virtual void GRE::UI::VIEWTOOL::v_Suspend

(

)

[private, virtual]

---

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

• gre/uiviewtool.h