MGUI::CTRL_MAGNIFIER Class Reference

Magnifier view control. More...

#include <mgui/ctrlmagnifier.h>

Inheritance diagram for MGUI::CTRL_MAGNIFIER:

[legend]

List of all members.

Public Types
typedef fastdelegate::FastDelegate < void(double)>	DELEGATE_ONZOOM
enum	STYLE { STYLE_Default = 0x00, STYLE_NoShowCenterCell = 0x01, STYLE_NoZoomControls = 0x02, STYLE_NoZoomFactor = 0x04 }
Public Member Functions
	CTRL_MAGNIFIER ()
virtual	~CTRL_MAGNIFIER ()
void	Create (LAYOUT_PANE_BASE &ParentPane, INT32 Width, INT32 Height, double MinimumZoomAllowed=2, double MaximumZoomAllowed=16, LAYOUT_SIZEALIGN sizealign=LAYOUT_SIZEALIGN_Expand, CTRL_MAGNIFIER::STYLE style=STYLE_Default)
ERRVALUE	Draw (SPATMOD::IMAGE::STAGE *PtrStage, bool TakeOwnership=true)
ERRVALUE	Draw (const MGUI::POINT &point, SPATMOD::IMAGE::STAGE *PtrStage, bool TakeOwnership=true)
ERRVALUE	Draw (const MGUI::POINT &point, MGD::DEVICE *Device)
void	Erase ()
double	GetZoom () const
void	Redraw ()
void	SetBackgroundColor (const COLOR &color)
void	SetDelegateOnZoom (DELEGATE_ONZOOM delegate)
void	SetShowCenter (bool bShowCenter)
void	SetZoom (double zoom)
void	SetZoomLimits (double MinimumZoomAllowed, double MaximumZoomAllowed)

---

Detailed Description

Magnifier view control.

---

Member Typedef Documentation

typedef fastdelegate::FastDelegate<void(double)> MGUI::CTRL_MAGNIFIER::DELEGATE_ONZOOM

---

Member Enumeration Documentation

enum MGUI::CTRL_MAGNIFIER::STYLE

Enumerator:

STYLE_Default
STYLE_NoShowCenterCell
STYLE_NoZoomControls
STYLE_NoZoomFactor

Reimplemented from MGUI::CANVAS.

---

Constructor & Destructor Documentation

MGUI::CTRL_MAGNIFIER::CTRL_MAGNIFIER

(

)

Constructor.

virtual MGUI::CTRL_MAGNIFIER::~CTRL_MAGNIFIER

(

)

[virtual]

Destructor.

---

Member Function Documentation

void MGUI::CTRL_MAGNIFIER::Create	(	LAYOUT_PANE_BASE &	ParentPane,
		INT32	Width,
		INT32	Height,
		double	MinimumZoomAllowed = 2,
		double	MaximumZoomAllowed = 16,
		LAYOUT_SIZEALIGN	sizealign = LAYOUT_SIZEALIGN_Expand,
		CTRL_MAGNIFIER::STYLE	style = STYLE_Default
	)

Create canvas control.

Parameters:

	ParentPane	Parent pane
	Width	Desired width in pixels
	Height	Desired height in pixels
	MinimumZoomAllowed	Minimum zoom allowed
	MaximumZoomAllowed	Maximum zoom allowed
	sizealign	Sizing and alignment options
	style	Style

ERRVALUE MGUI::CTRL_MAGNIFIER::Draw	(	SPATMOD::IMAGE::STAGE *	PtrStage,
		bool	TakeOwnership = true
	)

Draw magnifier.

Parameters:

	PtrStage	Stage to draw from, must match size of magnifier canvas
	TakeOwnership	Take owernship of stage and delete

ERRVALUE MGUI::CTRL_MAGNIFIER::Draw	(	const MGUI::POINT &	point,
		SPATMOD::IMAGE::STAGE *	PtrStage,
		bool	TakeOwnership = true
	)

Draw magnifier.

Parameters:

	point	Point in device coords at where to draw magnifier
	PtrStage	Stage to draw from
	TakeOwnership	Take owernship of stage and delete

ERRVALUE MGUI::CTRL_MAGNIFIER::Draw	(	const MGUI::POINT &	point,
		MGD::DEVICE *	Device
	)

Draw magnifier.

Parameters:

	point	Point in device coords at where to draw magnifier
	Device	Device to draw from

void MGUI::CTRL_MAGNIFIER::Erase

(

)

Erase with background color.

double MGUI::CTRL_MAGNIFIER::GetZoom

(

)

const [inline]

Get current zoom.

void MGUI::CTRL_MAGNIFIER::Redraw

(

)

Redraw.

void MGUI::CTRL_MAGNIFIER::SetBackgroundColor

(

const COLOR &

color

)

Set background color of magnifier.

Reimplemented from MGUI::CTRL.

void MGUI::CTRL_MAGNIFIER::SetDelegateOnZoom

(

DELEGATE_ONZOOM

delegate

)

[inline]

Set delegate to call when magnifier is zoomed.

void MGUI::CTRL_MAGNIFIER::SetShowCenter

(

bool

bShowCenter

)

Set whether border around center pixel is shown.

void MGUI::CTRL_MAGNIFIER::SetZoom

(

double

zoom

)

Set zoom.

void MGUI::CTRL_MAGNIFIER::SetZoomLimits	(	double	MinimumZoomAllowed,
		double	MaximumZoomAllowed
	)

Set zoom limits.

---

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

• mgui/ctrlmagnifier.h