Wt  4.10.4
Public Member Functions | List of all members
Wt::WPolygonArea Class Reference

An interactive area in a widget, specified by a polygon. More...

#include <Wt/WPolygonArea.h>

Inheritance diagram for Wt::WPolygonArea:
[legend]

Public Member Functions

 WPolygonArea ()
 Creates an empty polygon. More...
 
 WPolygonArea (const std::vector< WPoint > &points)
 Creates a polygon area with given vertices. More...
 
 WPolygonArea (const std::vector< WPointF > &points)
 Creates a polygon area with given vertices. More...
 
void addPoint (int x, int y)
 Adds a point.
 
void addPoint (double x, double y)
 Adds a point.
 
void addPoint (const WPoint &point)
 Adds a point.
 
void addPoint (const WPointF &point)
 Adds a point.
 
void setPoints (const std::vector< WPoint > &points)
 Sets the polygon vertices. More...
 
void setPoints (const std::vector< WPointF > &points)
 Sets the polygon vertices. More...
 
const std::vector< WPointF > & pointFs () const
 Returns the polygon vertices. More...
 
const std::vector< WPoint > & points () const
 Returns the polygon vertices. More...
 
- Public Member Functions inherited from Wt::WAbstractArea
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 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=Cursor::Arrow)
 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...
 
EventSignalenterPressed ()
 Event signal emitted when enter was pressed. More...
 
EventSignalescapePressed ()
 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
void addChild (std::unique_ptr< WObject > child)
 Add a child WObject whose lifetime is determined by this WObject.
 
template<typename Child >
Child * addChild (std::unique_ptr< Child > child)
 Add a child WObject, returning a raw pointer. More...
 
std::unique_ptr< WObjectremoveChild (WObject *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject.
 
template<typename Child >
std::unique_ptr< Child > removeChild (Child *child)
 Remove a child WObject, so its lifetime is no longer determined by this WObject. 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...
 
- Public Member Functions inherited from Wt::Core::observable
 observable () noexcept
 Default constructor.
 
virtual ~observable ()
 Destructor. More...
 
template<typename... Args, typename C >
auto bindSafe (void(C::*method)(Args...)) noexcept
 Protects a method call against object destruction. More...
 
template<typename... Args, typename C >
auto bindSafe (void(C::*method)(Args...) const) const noexcept
 Protects a const method call against object destruction. More...
 
template<typename Function >
auto bindSafe (const Function &function) noexcept
 Protects a function against object destruction. More...
 

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...
 

Detailed Description

An interactive area in a widget, specified by a polygon.

The area may be added to a WImage or WPaintedWidget to provide interactivity on a polygon area of the image. The polygon is specified in pixel coordinates, and uses an even-odd winding rule (overlaps create holes).

auto image = std::make_unique<Wt::WImage>("images/family.jpg");
auto face = std::make_unique<Wt::WPolygonArea>();
face->addPoint(100, 120);
face->addPoint(300, 120);
face->addPoint (200, 250);
face->setToolTip("Uncle Frank");
image->addArea(std::move(face));
void addArea(std::unique_ptr< WAbstractArea > area)
Adds an interactive area.
Definition: WImage.C:144

The polygon area corresponds to the HTML <area shape="poly"> tag.

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

Constructor & Destructor Documentation

◆ WPolygonArea() [1/3]

Wt::WPolygonArea::WPolygonArea ( )

Creates an empty polygon.

Defines an empty polygon.

◆ WPolygonArea() [2/3]

Wt::WPolygonArea::WPolygonArea ( const std::vector< WPoint > &  points)

Creates a polygon area with given vertices.

The polygon is defined with vertices corresponding to points. The polygon is closed by connecting the last point with the first point.

◆ WPolygonArea() [3/3]

Wt::WPolygonArea::WPolygonArea ( const std::vector< WPointF > &  points)

Creates a polygon area with given vertices.

The polygon is defined with vertices corresponding to points. The polygon is closed by connecting the last point with the first point.

Member Function Documentation

◆ pointFs()

const std::vector<WPointF>& Wt::WPolygonArea::pointFs ( ) const

Returns the polygon vertices.

See also
setPoints(), points()

◆ points()

const std::vector< WPoint > & Wt::WPolygonArea::points ( ) const

Returns the polygon vertices.

See also
setPoints(), pointFs()

◆ setPoints() [1/2]

void Wt::WPolygonArea::setPoints ( const std::vector< WPoint > &  points)

Sets the polygon vertices.

The polygon is defined with vertices corresponding to points. The polygon is closed by connecting the last point with the first point.

◆ setPoints() [2/2]

void Wt::WPolygonArea::setPoints ( const std::vector< WPointF > &  points)

Sets the polygon vertices.

The polygon is defined with vertices corresponding to points. The polygon is closed by connecting the last point with the first point.