VCF::ToolTipEvent Class Reference

The tooltip event is fired when tooltip text is being requested and/or just before the tooltip is ready to be shown, allowing the handler to customize the tooltip's data or presentation. More...

#include <vcf/ApplicationKit/ToolTipEvent.h>

Inheritance diagram for VCF::ToolTipEvent:

List of all members.


Public Member Functions
	ToolTipEvent (Object *source, const uint32 &type)
	ToolTipEvent (const ToolTipEvent &rhs)
virtual	~ToolTipEvent ()
ToolTipEvent &	operator= (const ToolTipEvent &rhs)
String	getToolTipString ()
virtual Object *	clone (bool deep=false)
	Makes a complete clone of this object.
void	setToolTipString (const String &tooltipString)
Point *	getToolTipLocation ()
void	setToolTipLocation (Point *pt)
Size *	getToolTipSize ()
void	setToolTipSize (Size *size)
GraphicsContext *	getCustomToolTipContext ()
void	setCustomTooltipContext (GraphicsContext *customToolTipGraphicsCtx)
Control *	getEmbeddedControl ()
void	setEmbeddedControl (Control *val)
bool	getAutoDestroyEmbeddedControl ()
void	setAutoDestroyEmbeddedControl (const bool &val)
Color *	getBackgroundColor ()
void	setBackgroundColor (Color *color)
Protected Attributes
String	tooltipString_
GraphicsContext *	customToolTipGraphicsCtx_
Point	tooltipLocation_
Size	tooltipSize_
Control *	embeddedControl_
bool	autoDestroyEmbeddedControl_
Color	backgroundColor_

Detailed Description

The tooltip event is fired when tooltip text is being requested and/or just before the tooltip is ready to be shown, allowing the handler to customize the tooltip's data or presentation.

Constructor & Destructor Documentation

VCF::ToolTipEvent::ToolTipEvent ( Object * source,

const uint32 & type

) [inline]

VCF::ToolTipEvent::ToolTipEvent ( const ToolTipEvent & rhs ) [inline]

virtual VCF::ToolTipEvent::~ToolTipEvent ( ) [inline, virtual]

Member Function Documentation

virtual Object* VCF::ToolTipEvent::clone ( bool deep = false ) [inline, virtual]

Makes a complete clone of this object.
A typical implementation might be:
virtual Object* clone( bool deep ) { return new MyObject( this ); }
In which the implementer simply creates a new instance on the heap and calls the copy constructor. Objects which support cloning should also have a copy constructor defined as well.

Parameters:

bool deep if deep is true then any object instances that this object owns should probably be cloned as well, with full new copies made. Otherwise it would be acceptable to simply copy the pointer values. The default value is for deep cloning to be false.

Returns:
Object a new instance that should be an copy of this. If the object doesn't support cloning the return will value will be NULL.

Reimplemented from VCF::Event.