Abstract base class for interactive areas in a widget. More...

#include <Wt/WAbstractArea>

Inheritance diagram for Wt::WAbstractArea:

[legend]

Public Member Functions
virtual	~WAbstractArea ()
	Destructor. More...

void	setHole (bool hole)
	Specifies that this area specifies a hole for another area. More...

bool	isHole () const
	Returns whether this area specifies a hole. More...

void	setLink (const WLink &link)
	Sets a link. More...

WLink	link () const
	Returns the link. More...

void	setRef (const std::string &ref)
	Sets the destination URL (deprecated). More...

const std::string	ref () const
	Returns the the destination URL (deprecated). More...

void	setResource (WResource *resource)
	Sets a destination resource (deprecated). More...

WResource *	resource () const
	Returns the destination resource (deprecated). More...

void	setTarget (AnchorTarget target)
	Specifies the location where the referred content should be displayed. More...

AnchorTarget	target () const
	Returns the location where the referred content should be displayed. More...

void	setAlternateText (const WString &text)
	Sets an alternate text. More...

const WString	alternateText () const
	Returns the alternate text. More...

void	setToolTip (const WString &text)
	Sets the tooltip. More...

WString	toolTip () const
	Returns the tooltip text. More...

void	setStyleClass (const WString &styleClass)
	Defines a style class. More...

WString	styleClass () const
	Returns the style class. More...

void	addStyleClass (const WString &styleClass, bool force=false)
	Adds a style class. More...

void	removeStyleClass (const WString &styleClass, bool force=false)
	Removes a style class.

void	setCursor (Cursor cursor)
	Sets the cursor. More...

void	setCursor (std::string cursorImage, Cursor fallback=ArrowCursor)
	Sets a custom cursor image URL. More...

Cursor	cursor () const
	Returns the cursor. More...

EventSignal< WKeyEvent > &	keyWentDown ()
	Event signal emitted when a keyboard key is pushed down. More...

EventSignal< WKeyEvent > &	keyPressed ()
	Event signal emitted when a "character" was entered. More...

EventSignal< WKeyEvent > &	keyWentUp ()
	Event signal emitted when a keyboard key is released. More...

EventSignal &	enterPressed ()
	Event signal emitted when enter was pressed. More...

EventSignal &	escapePressed ()
	Event signal emitted when escape was pressed. More...

EventSignal< WMouseEvent > &	clicked ()
	Event signal emitted when a mouse key was clicked on this widget. More...

EventSignal< WMouseEvent > &	doubleClicked ()
	Event signal emitted when a mouse key was double clicked on this widget. More...

EventSignal< WMouseEvent > &	mouseWentDown ()
	Event signal emitted when a mouse key was pushed down on this widget. More...

EventSignal< WMouseEvent > &	mouseWentUp ()
	Event signal emitted when a mouse key was released on this widget. More...

EventSignal< WMouseEvent > &	mouseWentOut ()
	Event signal emitted when the mouse went out of this widget. More...

EventSignal< WMouseEvent > &	mouseWentOver ()
	Event signal emitted when the mouse entered this widget. More...

EventSignal< WMouseEvent > &	mouseMoved ()
	Event signal emitted when the mouse moved over this widget. More...

EventSignal< WMouseEvent > &	mouseDragged ()
	Event signal emitted when the mouse is dragged over this widget. More...

EventSignal< WMouseEvent > &	mouseWheel ()
	Event signal emitted when the mouse scroll wheel was used. More...

Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
	Create a WObject with a given parent object. More...

virtual	~WObject ()
	Destructor. More...

virtual const std::string	id () const
	Returns the (unique) identifier for this object. More...

virtual void	setObjectName (const std::string &name)
	Sets an object name. More...

virtual std::string	objectName () const
	Returns the object name. More...

void	resetLearnedSlots ()
	Resets learned stateless slot implementations. More...

template<class T >
void	resetLearnedSlot (void(T::*method)())
	Resets a learned stateless slot implementation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::*method)())
	Declares a slot to be stateless and learn client-side behaviour on first invocation. More...

template<class T >
WStatelessSlot *	implementStateless (void(T::method)(), void(T::undoMethod)())
	Declares a slot to be stateless and learn client-side behaviour in advance. More...

void	isNotStateless ()
	Marks the current function as not stateless. More...

template<class T >
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
	Provides a JavaScript implementation for a method. More...

void	addChild (WObject *child)
	Adds a child object. More...

virtual void	removeChild (WObject *child)
	Removes a child object. More...

const std::vector< WObject * > &	children () const
	Returns the children.

WObject *	parent () const
	Returns the parent object.

Additional Inherited Members
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
	Typedef for a WObject method without arguments.

Protected Member Functions inherited from Wt::WObject
virtual WStatelessSlot *	getStateless (Method method)
	On-demand stateless slot implementation. More...

Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()
	Returns the sender of the current slot call. More...

Detailed Description

Abstract base class for interactive areas in a widget.

Use an WAbstractArea (or rather, one of its concrete implementations), to define interactivity that applies on a part of a WImage or WPaintedWidget. The area may be defined using different shapes through WRectArea, WCircleArea or WPolygonArea.

See also: WImage::addArea(), WPaintedWidget::addArea()

Constructor & Destructor Documentation

Wt::WAbstractArea::~WAbstractArea ( )

virtual

Destructor.

The area is automatically removed from the WImage or WPaintedWidget to which it was added.

See also: WImage::removeArea(), WPaintedWidget::removeArea()

Member Function Documentation

void Wt::WAbstractArea::addStyleClass	(	const WString &	styleClass,
		bool	force = `false`
	)

Adds a style class.

Note: Only few CSS declarations are known to affect the look of a image area, the most notable one being the 'cursor'. Other things will simply be ignored.

const WString Wt::WAbstractArea::alternateText ( ) const

Returns the alternate text.

See also: setAlternateText()

EventSignal< WMouseEvent > & Wt::WAbstractArea::clicked ( )

Event signal emitted when a mouse key was clicked on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the event details contain invalid information.

Cursor Wt::WAbstractArea::cursor ( ) const

Returns the cursor.

See also: setCursor()

EventSignal< WMouseEvent > & Wt::WAbstractArea::doubleClicked ( )

Event signal emitted when a mouse key was double clicked on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal & Wt::WAbstractArea::enterPressed ( )

Event signal emitted when enter was pressed.

This signal is emitted when the Enter or Return key was pressed.

See also: keyPressed(), Key_Enter

EventSignal & Wt::WAbstractArea::escapePressed ( )

Event signal emitted when escape was pressed.

This signal is emitted when the Escape key was pressed.

See also: keyPressed(), Key_Escape

bool Wt::WAbstractArea::isHole ( ) const

Returns whether this area specifies a hole.

See also: setHole()

EventSignal< WKeyEvent > & Wt::WAbstractArea::keyPressed ( )

Event signal emitted when a "character" was entered.

The keyPressed signal is emitted when a key is pressed, and a character is entered. Unlike keyWentDown(), it is emitted only for key presses that result in a character being entered, and thus not for modifier keys or keyboard navigation keys.

See also: keyWentDown()

EventSignal< WKeyEvent > & Wt::WAbstractArea::keyWentDown ( )

Event signal emitted when a keyboard key is pushed down.

The keyWentDown signal is the first signal emitted when a key is pressed (before the keyPressed() signal). Unlike keyPressed() however it is also emitted for modifier keys (such as "shift", "control", ...) or keyboard navigation keys that do not have a corresponding character.

See also: keyPressed(), keyWentUp()

EventSignal< WKeyEvent > & Wt::WAbstractArea::keyWentUp ( )

Event signal emitted when a keyboard key is released.

This is the counter-part of the keyWentDown() event. Every key-down has its corresponding key-up.

See also: keyWentDown()

WLink Wt::WAbstractArea::link ( ) const

Returns the link.

See also: setLink()

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseDragged ( )

Event signal emitted when the mouse is dragged over this widget.

The mouse event contains information on the button(s) currently pressed. If multiple buttons are currently pressed, only the button with smallest enum value is returned.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseMoved ( )

Event signal emitted when the mouse moved over this widget.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseWentDown ( )

Event signal emitted when a mouse key was pushed down on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseWentOut ( )

Event signal emitted when the mouse went out of this widget.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseWentOver ( )

Event signal emitted when the mouse entered this widget.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseWentUp ( )

Event signal emitted when a mouse key was released on this widget.

The event details contains information such as the button, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

EventSignal< WMouseEvent > & Wt::WAbstractArea::mouseWheel ( )

Event signal emitted when the mouse scroll wheel was used.

The event details contains information such as the wheel delta, optional keyboard modifiers, and mouse coordinates relative to the widget, the window window, or the document.

Note: When JavaScript is disabled, the signal will never fire.

const std::string Wt::WAbstractArea::ref ( ) const

Returns the the destination URL (deprecated).

When the area refers to a resource, the current resource URL is returned.

See also: setRef(), WResource::url()

Deprecated:: Use link() instead.

WResource * Wt::WAbstractArea::resource ( ) const

Returns the destination resource (deprecated).

Returns 0 if no resource has been set.

See also: setResource()

Deprecated:: Use link() instead.

void Wt::WAbstractArea::setAlternateText ( const WString & text )

Sets an alternate text.

The alternate text should provide a fallback for browsers that do not display an image. If no sensible fallback text can be provided, an empty text is preferred over nonsense.

This should not be confused with toolTip() text, which provides additional information that is displayed when the mouse hovers over the area.

The default alternate text is an empty text ("").

See also: alternateText()

void Wt::WAbstractArea::setCursor ( Cursor cursor )

Sets the cursor.

This sets the mouse cursor that is shown when the mouse pointer is over the area. Most browsers only support PointingHandCursor, which is activated by a non-empty ref.

See also: setRef()

void Wt::WAbstractArea::setCursor	(	std::string	cursorImage,
		Cursor	fallback = `ArrowCursor`
	)

Sets a custom cursor image URL.

The URL should point to a .cur file. For optimal portability, make sure that the .cur file is proparly constructed. A renamed .ico file will not work on Internet Explorer.

void Wt::WAbstractArea::setHole ( bool hole )

Specifies that this area specifies a hole for another area.

When set to true, this area will define an area that does not provide interactivity. When it preceeds other, overlapping, areas, it acts as if it cuts a hole in those areas.

The default value is false.

See also: isHole()

void Wt::WAbstractArea::setLink ( const WLink & link )

Sets a link.

By setting a link, the area behaves like a WAnchor.

By default, no destination link is set.

Note: Even when no destination link is set, in some circumstances, an identity URL ('#') will be linked to on the underlying HTML <area> element (see also setCursor()).

void Wt::WAbstractArea::setRef ( const std::string & ref )

Sets the destination URL (deprecated).

By setting a destination URL, the area behaves like a WAnchor.

By default, no destination URL is set (ref = "").

This method should not be used when the area has been pointed to a dynamically generated resource using setResource().

See also: setResource()

Note: Even when no destination URL is set, in some circumstances, a identity URL ('#') will be set on the underlying HTML <area> element (see also setCursor()).

Deprecated:: Use setLink() instead.

void Wt::WAbstractArea::setResource ( WResource * resource )

Sets a destination resource (deprecated).

A resource specifies application-dependent content, which may be generated by your application on demand.

By setting a resource, the area behaves like a WAnchor that links to the resource resource. The resource may be cleared by passing resource = 0.

The area does not assume ownership of the resource.

See also: setRef()

Deprecated:: Use setLink() instead.

void Wt::WAbstractArea::setStyleClass ( const WString & styleClass )

Defines a style class.

Note: Only few CSS declarations are known to affect the look of a image area, the most notable one being the 'cursor'. Other things will simply be ignored.

void Wt::WAbstractArea::setTarget ( AnchorTarget target )

Specifies the location where the referred content should be displayed.

This configures the location where referred content should be displayed, that was specified using setRef() or setResource().

By default, the reference is displayed in the application (Wt::TargetSelf). When the destination is an HTML document, the application is replaced with the new document. When the reference is a document that cannot be displayed in the browser, it is offered for download or opened using an external program, depending on browser settings.

By setting target to Wt::TargetNewWindow, the destination is displayed in a new browser window or tab.