OverlayPluginBase Class Reference

Overlay plugin object More...

Inherits OverlayBase.

Inherited by ExtendedOverlayPluginBase< TData >, and SmartRectOverlay.

Public Member Functions
abstract OverlayPluginBase	Clone ()
	virtual copy constructor for overlay objects More...

Protected Member Functions
	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
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
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

Overlay plugin object

Constructor & Destructor Documentation

OverlayPluginBase()

OverlayPluginBase ( string  text, bool  canDrag, System.Drawing.Color  color, bool  xorPaint, bool  filled, Point[]  vertices, OverlayPluginInfo  info, object  tag  )

protected

ctor for Overlay objects with user data

Parameters

text	status line text
canDrag	dragable flag
color	color
xorPaint	paint mode
filled	paint mode
vertices	vertices for the object
info	opi info (GUID, friendly name)
tag	object to be associated with this overlay

Exceptions

ArgumentException	If the information about the Overlay is missing (i.e. info equals OverlayInfo.Empty)
ArithmeticException	If the number of vertices is insufficient for the overlay to be created.

Member Function Documentation

Clone()

abstract OverlayPluginBase Clone ( )

pure virtual

virtual copy constructor for overlay objects

Returns

The cloned overlay object.

Implemented in SmartRectOverlay.

CreateOverlayWrapper()

virtual OverlayPluginWrapper CreateOverlayWrapper ( )

protectedvirtual

Overrideable creation function for overlay wrapper objects

Returns

a newly create overlay plugin wrapper

Reimplemented in ExtendedOverlayPluginBase< TData >.

Overlay_DisconnectedFromDisplay()

override void Overlay_DisconnectedFromDisplay ( bool  handBackID )

protectedvirtual

Remove an OPI from a display (effectively: kill it...)

Parameters

handBackID

true if the overlay's display ID is to be handed back to the display, false otherwise.

Exceptions

ObjectDisposedException

If the display we are trying to work on has already been disposed

Implements OverlayBase.