MGUI::TOOL_LIMITED Class Reference

TOOL_LIMITED - Tool with limit support. More...

#include <mgui/toolbase.h>

Inheritance diagram for MGUI::TOOL_LIMITED:

[legend]List of all members.

Public Member Functions
void	SetLimits (const DRECT2D &rect)
void	SetLimitsEnforced (bool enforced=true)
virtual	~TOOL_LIMITED ()
Protected Member Functions
const DRECT2D &	GetLimits () const
bool	IsLimitsEnforced () const
	TOOL_LIMITED (TOOLCANVAS *canvas, CONTROLNEED ControlNeed, bool HasManualControls)
virtual void	v_OnActivate ()
virtual void	v_OnSetTransToWindow ()

---

Detailed Description

TOOL_LIMITED - Tool with limit support.

Definition at line 603 of file toolbase.h.

---

Constructor & Destructor Documentation

virtual MGUI::TOOL_LIMITED::~TOOL_LIMITED (   )  [virtual]

Destructor.

MGUI::TOOL_LIMITED::TOOL_LIMITED (  TOOLCANVAS *  canvas, CONTROLNEED  ControlNeed, bool  HasManualControls )  [explicit, protected]

Constructor. Parameters: ControlNeed  Need for control dialog or form HasManualControls  Optional manual controls available

---

Member Function Documentation

const DRECT2D& MGUI::TOOL_LIMITED::GetLimits (   )  const [inline, protected]

Get limits. Definition at line 630 of file toolbase.h.

bool MGUI::TOOL_LIMITED::IsLimitsEnforced (   )  const [inline, protected]

Determine if limits are enforced. Definition at line 634 of file toolbase.h.

void MGUI::TOOL_LIMITED::SetLimits (  const DRECT2D &  rect  )

Set coordinate limits. Parameters: rect  Limits to set

void MGUI::TOOL_LIMITED::SetLimitsEnforced (  bool  enforced = true  )

Set whether limits are enforced. If SetLimits() has not been called then the tool will be limited to the visible canvas extent. Parameters: enforced  Set if limits are enforced

virtual void MGUI::TOOL_LIMITED::v_OnActivate (   )  [protected, virtual]

Called when tool is "activated". Derived class must call base class method BEFORE performing own processing. Reimplemented from MGUI::TOOL_BASE.

virtual void MGUI::TOOL_LIMITED::v_OnSetTransToWindow (   )  [protected, virtual]

Called when tool to window transformation is set. Derived class must call base class method BEFORE performing own processing. Reimplemented from MGUI::TOOL_BASE.

---

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

• mgui/toolbase.h

---