RectOverlay Class Reference

An overlay representing a Rect object. More...

Inherits PenStyleOverlayPluginBase.

Public Member Functions
	RectOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Rect rect, object tag)
	Constructor for a Rectangle overlay More...
	RectOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Rect rect)
	Constructor for a Rectangle overlay More...
	RectOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Rect rect, DashStyle dashStyle, int penWidth, object tag)
	Constructor for a Rectangle overlay More...
	RectOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Rect rect, DashStyle dashStyle, int penWidth)
	Constructor for a Rectangle overlay More...
override OverlayPluginBase	Clone ()
	Virtual copy constructor. More...

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

Properties
Rect	Rect [get, set]
	Extent of the visible rectangle
Properties inherited from PenStyleOverlayPluginBase
int	PenWidth [get, set]
	Width of the pen to be used for painting. More...
DashStyle	DashStyle [get, set]
	Dash style to be used for painting. More...

Additional Inherited Members
Protected Member Functions inherited from PenStyleOverlayPluginBase
	PenStyleOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
	Constructor for pen-styled overlay plugins. More...
	PenStyleOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, DashStyle dashStyle, int penWidth, object tag)
	Constructor for pen-styled overlay plugins. More...
override PluginData.PenStylePlugInData	CreatePluginData ()
	Build the plugin data structure using the current settings. More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.PenStylePlugInData >
	ExtendedOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
	Standard constructor for overlays with a plugin data structure. More...
override OverlayPluginWrapper	CreateOverlayWrapper ()
	overrideable creation function for overlay wrapper objects More...
abstract TData	CreatePluginData ()
	Inheritors must override this and in the override prepare the plugin data reflecting the OPI's current state (depending usually on the current values of the Overlay object's properties) More...
virtual void	OpiDataPropertyChanged ()
	A property that is relevant for the opi data structure has been changed; as a consequence, the opi may potentially need to be re-generated in order to reflect the changes.
virtual void	OpiDataPropertyChanged (bool skipDestroyAndCreate)
	A property that is relevant for the opi data structure has been changed; as a consequence, the opi may potentially need to be re-generated in order to reflect the changes. More...
Protected Attributes inherited from ExtendedOverlayPluginBase< PluginData.PenStylePlugInData >
TData	opiData_
	The plugin-specific data structure

Detailed Description

An overlay representing a Rect object.

Constructor & Destructor Documentation

RectOverlay() [1/4]

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

Constructor for a 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

RectOverlay() [2/4]

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

Constructor for a Rectangle overlay

Parameters

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

RectOverlay() [3/4]

RectOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		bool	filled,
		Rect	rect,
		DashStyle	dashStyle,
		int	penWidth,
		object	tag
	)

Constructor for a Rectangle overlay

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
filled	paint mode
rect	Rectangle's extent
dashStyle	dash style for painting
penWidth	pen width for painting
tag	object to be associated with this overlay

RectOverlay() [4/4]

RectOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		bool	filled,
		Rect	rect,
		DashStyle	dashStyle,
		int	penWidth
	)

Constructor for a Rectangle overlay

Parameters

text	status line string
canDrag	drag able or not
color	color
xorPaint	paint mode
filled	paint mode
rect	Rectangle's extent
dashStyle	dash style for painting
penWidth	pen width for painting

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy constructor.

Returns

The clones RectOverlay object.

operator Rect()

static implicit operator Rect ( RectOverlay  r )

static

Typecasting to System.Drawing.Rectangle makes life easier

Parameters

r	The RectOverlay to be converted.

Returns

The Stemmer.Cvb.Rect that this RectOverlay represents on the display.