TSLMagnifyingGlass Class Reference

Detailed Description

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

Public Member Functions
	TSLMagnifyingGlass (TSLInteractionModeDisplay *display)
	~TSLMagnifyingGlass ()
bool	clearBackgroundColour ()
bool	draw (TSLDrawableHandle buffer, bool restoreBackground)
bool	draw (TSLDeviceContext buffer, bool restoreBackground)
TSLStyleID	getBackgroundColour () const
void	onSize (TSLDeviceUnits cx, TSLDeviceUnits cy)
void	reset ()
bool	setWinExtent (int leftX, int topY, int rightX, int bottomY)
bool	setMagExtent (double uux1, double uuy1, double uux2, double uuy2)
void	magnification (double val, bool setDefault)
void	size (double val)
void	offset (double val)
void	setBackgroundColour (int red, int green, int blue)
void	setBorder (int thickness, int red, int green, int blue)
void *	operator new (size_t size) TSL_NO_THROW
void	operator delete (void *self)
void *	operator new (size_t size, char *filename, int line)
double	magnification (bool getDefault) const
double	offset () const
double	size () const

Constructor & Destructor Documentation

TSLMagnifyingGlass()

TSLMagnifyingGlass::TSLMagnifyingGlass

(

TSLInteractionModeDisplay *

display

)

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

~TSLMagnifyingGlass()

TSLMagnifyingGlass::~TSLMagnifyingGlass

(

)

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

Member Function Documentation

clearBackgroundColour()

bool TSLMagnifyingGlass::clearBackgroundColour

(

)

Clears the background colour of the Magnifying Glass so that anything beneath shall be visible.

draw() [1/2]

bool TSLMagnifyingGlass::draw	(	TSLDeviceContext	buffer,
		bool	restoreBackground )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

draw() [2/2]

bool TSLMagnifyingGlass::draw	(	TSLDrawableHandle	buffer,
		bool	restoreBackground )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

getBackgroundColour()

TSLStyleID TSLMagnifyingGlass::getBackgroundColour

(

)

const

This method returns the background colour for the magnifying glass.

Returns the background colour of the magnifying glass or -1 if the colour is not defined. The return value will either be a colour index or a composed RGB value. See tslcolourhelper.h for information on determining the type and in the case of an RGB value uncomposing it back into its respective components.

magnification() [1/2]

double TSLMagnifyingGlass::magnification ( bool getDefault ) const

inline

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

magnification() [2/2]

void TSLMagnifyingGlass::magnification	(	double	val,
		bool	setDefault )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

offset() [1/2]

double TSLMagnifyingGlass::offset ( ) const

inline

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

offset() [2/2]

void TSLMagnifyingGlass::offset

(

double

val

)

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

onSize()

void TSLMagnifyingGlass::onSize	(	TSLDeviceUnits	cx,
		TSLDeviceUnits	cy )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

operator delete()

void TSLMagnifyingGlass::operator delete

(

void *

self

)

operator new() [1/2]

void * TSLMagnifyingGlass::operator new

(

size_t

size

)

operator new() [2/2]

void * TSLMagnifyingGlass::operator new	(	size_t	size,
		char *	filename,
		int	line )

When included in an MFC application in debug mode, the debug new expects this to be here. Override it and return the same as the normal one. The library must include it when compiled in release mode, since the user's application may be in debug mode.

reset()

void TSLMagnifyingGlass::reset

(

)

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

setBackgroundColour()

void TSLMagnifyingGlass::setBackgroundColour	(	int	red,
		int	green,
		int	blue )

Set the background colour of the magnifying glass.

Parameters

red,green,blue

RGB components of the background colour.

setBorder()

void TSLMagnifyingGlass::setBorder	(	int	thickness,
		int	red,
		int	green,
		int	blue )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

setMagExtent()

bool TSLMagnifyingGlass::setMagExtent	(	double	uux1,
		double	uuy1,
		double	uux2,
		double	uuy2 )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

setWinExtent()

bool TSLMagnifyingGlass::setWinExtent	(	int	leftX,
		int	topY,
		int	rightX,
		int	bottomY )

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

size() [1/2]

double TSLMagnifyingGlass::size ( ) const

inline

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.

size() [2/2]

void TSLMagnifyingGlass::size

(

double

val

)

This class is for use by the TSLInteractionModeMagnify and should not be used directly by the application.