SmartRectOverlay Class Reference

A rectangle object More...

Inherits OverlayPluginBase.

Public Member Functions
	SmartRectOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Rect rect, object tag)
	Constructor for a Smart Rectangle Overlay. More...
	SmartRectOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Rect rect)
	Constructor for a Smart Rectangle Overlay. More...
override OverlayPluginBase	Clone ()
	Virtual copy Constructor. More...
abstract OverlayPluginBase	Clone ()
	virtual copy constructor for overlay objects More...

Static Public Member Functions
static implicit	operator Rect (SmartRectOverlay r)
	Typecasting to System.Drawing.Rectangle makes life easier More...

Additional Inherited Members
Protected Member Functions inherited from OverlayPluginBase
	OverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
	ctor for Overlay objects with user data More...
virtual OverlayPluginWrapper	CreateOverlayWrapper ()
	Overrideable creation function for overlay wrapper objects More...
override void	Overlay_ConnectedToDisplay ()
	Connect the overlay plugin to the display by means of an OPI wrapper
override void	Overlay_DisconnectedFromDisplay (bool handBackID)
	Remove an OPI from a display (effectively: kill it...) More...
Protected Member Functions inherited from OverlayBase
	OverlayBase (string text, bool canDrag, System.Drawing.Color color, object tag)
	ctor for DisplayObjects More...
Protected Attributes inherited from OverlayPluginBase
OverlayPluginInfo	opiInfo_
	information about the OPI that is being used by this object
Point[]	vertices_
	Array with the most up-to-date construction vertices
Protected Attributes inherited from OverlayBase
System.Drawing.Color	color_ = System.Drawing.Color.White
	Internally stored color.
Properties inherited from OverlayPluginBase
string	Name [get]
	Friendly name of the overlay plugin
virtual bool	Filled [get, set]
	Specifies whether or not the OPI should be painted filled
virtual bool	XORPainting [get, set]
	specifies the paint mode (opaque or XOR)
Properties inherited from OverlayBase
Display	Parent [get]
	The display on which the label lives (if any...). Note that a label may only be associated with one display at a time
object	Tag [get, set]
	Field for user-definable data to be associated with the overlay object.
bool	InvokeRequired [get]
	tell whether actions on the display object require an invoke action or not (being user interface objects, display objects should not be modified asynchronously)
string	Text [get, set]
	Text being displayed on the label and/or in the status line
virtual System.Drawing.Color	Color [get, set]
	Color of the label
bool	IsDragable [get, set]
	Label dragable?

Detailed Description

A rectangle object

Constructor & Destructor Documentation

SmartRectOverlay() [1/2]

SmartRectOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		bool	filled,
		Rect	rect,
		object	tag
	)

Constructor for a Smart Rectangle Overlay.

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
filled	paint mode
rect	rectangle's extent
tag	object to be associated with this overlay

SmartRectOverlay() [2/2]

SmartRectOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		bool	filled,
		Rect	rect
	)

Constructor for a Smart Rectangle Overlay.

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
filled	paint mode
rect	rectangle's extent

Member Function Documentation

Clone()

override OverlayPluginBase Clone ( )

virtual

Virtual copy Constructor.

Returns

The cloned SmartRectOverlay object.

Implements OverlayPluginBase.

operator Rect()

static implicit operator Rect ( SmartRectOverlay  r )

static

Typecasting to System.Drawing.Rectangle makes life easier

Parameters

r	The SmartRectOverlay object to be converted.

Returns

The Rect that this overlay object represents on the display.