a2dControl Class Reference
[a2dCanvasObject related objects]

a2dControl captures a wxWindow inside More...

#include <canprim.h>

Inheritance diagram for a2dControl:

[legend]

Collaboration diagram for a2dControl:

[legend]

List of all members.

Public Member Functions
	a2dControl (double x, double y, double width, double height, wxWindow *control)
	constructor
	a2dControl (const a2dControl &ori, CloneOptions options)
	constructor
	~a2dControl ()
	destructor
virtual a2dObject *	Clone (CloneOptions options) const
	This is here so that this class cannot be used directly.
wxWindow *	GetControl ()
	Get control pointer.
Protected Member Functions
virtual bool	DoStartEdit (wxUint16 editmode, wxEditStyle editstyle)
	only used for editable objects and under control of a editing tool.
virtual void	DoEndEdit ()
	only used for editable objects and under control of a editing tool.
void	DoRender (a2dIterC &ic, OVERLAP clipparent)
	render derived object
bool	DoIsHitWorld (a2dIterC &ic, a2dHitEvent &hitEvent)
	Does hit test on the object (exclusif child objects).
bool	DoUpdate (UpdateMode mode, const a2dBoundingBox &childbox, const a2dBoundingBox &clipbox, const a2dBoundingBox &propbox)
	Update derived Object specific things ( mainly boundingbox).
Protected Attributes
wxWindow *	m_control
	control with a a2dCanvas as parent.

---

Detailed Description

a2dControl captures a wxWindow inside

Definition at line 2114 of file canprim.h.

---

Constructor & Destructor Documentation

a2dControl::a2dControl	(	double	x,
		double	y,
		double	width,
		double	height,
		wxWindow *	control
	)

constructor

Parameters:

	x,:	x left top
	y,:	y left top
	width,:	width of the control drawing
	height,:	height of the control drawing
	control	pointer to wxWindow derived control

Definition at line 6387 of file canprim.cpp.

---

Member Function Documentation

bool a2dControl::DoStartEdit	(	wxUint16	editmode,
		wxEditStyle	editstyle
	)			[protected, virtual]

only used for editable objects and under control of a editing tool.

If object is editable this function is used to initialize the object for editing. In general this means adding editing handles to the child list. In the event handling of the object those handles are hit and moved, the object itself is changed accordingly.

Returns:

true is this object can be edited and is initialized for that.

Todo:

edit of bbox ( children or not included )

Reimplemented from a2dRect.

Definition at line 6448 of file canprim.cpp.

void a2dControl::DoEndEdit

(

)

[protected, virtual]

only used for editable objects and under control of a editing tool.

Do a clean up at the end of an editing sesion of the object. In general this means, remove editing handles from child list.

Reimplemented from a2dCanvasObject.

Definition at line 6473 of file canprim.cpp.

void a2dControl::DoRender	(	a2dIterC &	ic,
		OVERLAP	clipparent
	)			[protected, virtual]

render derived object

if the object has sub objects (apart from the childobject which are handled here), those subobject most rendered by iterating on layer when needed/wanted, simular to child objects. We do not iterate here, since that is only needed if indeed there or subobjects. This will be know in a "wxDerivedCanvasObject DoRender".

SO parent objects that call this function, must:

• 1- clip object against area to redraw.
• 2- iterate on layers when needed.

A a2dCanvasObject is rendered as a + (plus sign) when there or no children.

Reimplemented from a2dRect.

Definition at line 6427 of file canprim.cpp.

bool a2dControl::DoIsHitWorld	(	a2dIterC &	ic,
		a2dHitEvent &	hitEvent
	)			[protected, virtual]

Does hit test on the object (exclusif child objects).

DoIsHitWorld() should return the way the object is hit by filling a2dHitEvent::m_how with the correct info.

Parameters:

	ic	iterative context ( e.g. current transform WITH the local transform applied )
	hitEvent	stores hit information

Returns:

true if hit

Reimplemented from a2dRect.

Definition at line 6442 of file canprim.cpp.

bool a2dControl::DoUpdate	(	UpdateMode	mode,
		const a2dBoundingBox &	childbox,
		const a2dBoundingBox &	clipbox,
		const a2dBoundingBox &	propbox
	)			[protected, virtual]

Update derived Object specific things ( mainly boundingbox).

Calculates the boundingbox of the object (exclusif base class child objects but with other nested objects).

Parameters:

	mode	way to update the objects
	childbox	size of children boundingbox
	clipbox	clip to this
	propbox	size of properties boundingbox

Remarks:

in a derived class this function can also be used to update object specific cache data.

force may or may not have direct influence on the object itself, if this function is called directly for some reason (e.g from derived objects), you must invalidate the boudingbox yourself. GetDrawerBox()->SetValid( false );

Reimplemented from a2dWH.

Definition at line 6418 of file canprim.cpp.

---

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

• canprim.h
• canprim.cpp