Wt  3.3.9
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
Wt::WGoogleMap Class Reference

A widget that displays a google map. More...

#include <Wt/WGoogleMap>

Inheritance diagram for Wt::WGoogleMap:
Inheritance graph
[legend]

Classes

class  Coordinate
 A geographical coordinate (latitude/longitude) More...
 

Public Types

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

Public Member Functions

 WGoogleMap (ApiVersion version, WContainerWidget *parent=0)
 Creates a map widget with a version and optionally a parent argument.
 
 WGoogleMap (WContainerWidget *parent=0)
 Creates a map widget with optionally a parent argument.
 
virtual ~WGoogleMap ()
 Destructor.
 
void addMarker (const Coordinate &pos)
 Adds a marker overlay to the map.
 
void addPolyline (const std::vector< Coordinate > &points, const WColor &color=WColor(red), int width=2, double opacity=1.0)
 Adds a polyline overlay to the map. More...
 
void addCircle (const Coordinate &center, double radius, const WColor &strokeColor, int strokeWidth, const WColor &fillColor=WColor())
 Adds a circle to the map. More...
 
void addIconMarker (const Coordinate &pos, const std::string &iconURL)
 Adds a icon marker overlay to the map.
 
void clearOverlays ()
 Removes all overlays from the map.
 
void openInfoWindow (const Coordinate &pos, const Wt::WString &myHtml)
 Opens a text bubble with html text at a specific location.
 
void setCenter (const Coordinate &center)
 Sets the map view to the given center.
 
void setCenter (const Coordinate &center, int zoom)
 Sets the map view to the given center and zoom level.
 
void panTo (const Coordinate &center)
 Changes the center point of the map to the given point. More...
 
void zoomWindow (const std::pair< Coordinate, Coordinate > &bbox)
 Zooms the map to a region defined by a bounding box.
 
void zoomWindow (const Coordinate &topLeft, const Coordinate &bottomRight)
 Zooms the map to a region defined by a bounding box.
 
void setZoom (int level)
 Sets the zoom level to the given new value.
 
void zoomIn ()
 Increments zoom level by one.
 
void zoomOut ()
 Decrements zoom level by one.
 
void savePosition ()
 Stores the current map position and zoom level. More...
 
void returnToSavedPosition ()
 Restores the map view that was saved by savePosition().
 
void checkResize ()
 Notifies the map of a change of the size of its container. More...
 
void enableDragging ()
 Enables the dragging of the map (enabled by default).
 
void disableDragging ()
 Disables the dragging of the map.
 
void enableDoubleClickZoom ()
 Enables double click to zoom in and out (enabled by default).
 
void disableDoubleClickZoom ()
 Disables double click to zoom in and out.
 
void enableGoogleBar ()
 Enables the GoogleBar, an integrated search control, on the map. More...
 
void disableGoogleBar ()
 Disables the GoogleBar integrated search control. More...
 
void enableScrollWheelZoom ()
 Enables zooming using a mouse's scroll wheel. More...
 
void disableScrollWheelZoom ()
 Disables zooming using a mouse's scroll wheel. More...
 
void setMapTypeControl (MapTypeControl type)
 Sets the map type control. More...
 
JSignal< Coordinate > & clicked ()
 The click event. More...
 
JSignal< Coordinate > & doubleClicked ()
 The double click event. More...
 
JSignal< Coordinate > & mouseMoved ()
 This event is fired when the user moves the mouse inside the map.
 
ApiVersion apiVersion ()
 Return the used Google Maps API version.
 
- Public Member Functions inherited from Wt::WCompositeWidget
 WCompositeWidget (WContainerWidget *parent=0)
 Creates a WCompositeWidget. More...
 
 WCompositeWidget (WWidget *implementation, WContainerWidget *parent)
 Creates a WCompositeWidget with given implementation. More...
 
virtual void setObjectName (const std::string &name)
 Sets an object name. More...
 
virtual std::string objectName () const
 Returns the object name. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
virtual void setPositionScheme (PositionScheme scheme)
 Sets the CSS position scheme. More...
 
virtual PositionScheme positionScheme () const
 Returns the CSS position scheme. More...
 
virtual void setOffsets (const WLength &offset, WFlags< Side > sides=All)
 Sets CSS offsets for a non-statically positioned widget. More...
 
virtual WLength offset (Side s) const
 Returns a CSS offset. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
virtual WLength width () const
 Returns the width. More...
 
virtual WLength height () const
 Returns the height. More...
 
virtual void setMinimumSize (const WLength &width, const WLength &height)
 Sets a minimum size. More...
 
virtual WLength minimumWidth () const
 Returns the minimum width. More...
 
virtual WLength minimumHeight () const
 Returns the minimum height. More...
 
virtual void setMaximumSize (const WLength &width, const WLength &height)
 Sets a maximum size. More...
 
virtual WLength maximumWidth () const
 Returns the maximum width. More...
 
virtual WLength maximumHeight () const
 Returns the maximum height. More...
 
virtual void setLineHeight (const WLength &height)
 Sets the CSS line height for contained text.
 
virtual WLength lineHeight () const
 Returns the CSS line height for contained text. More...
 
virtual void setFloatSide (Side s)
 Specifies a CSS float side. More...
 
virtual Side floatSide () const
 Returns the CSS float side. More...
 
virtual void setClearSides (WFlags< Side > sides)
 Sets the sides that should be cleared of floats. More...
 
virtual WFlags< SideclearSides () const
 Returns the sides that should remain empty. More...
 
virtual void setMargin (const WLength &margin, WFlags< Side > sides=All)
 Sets CSS margins around the widget. More...
 
virtual WLength margin (Side side) const
 Returns a CSS margin set. More...
 
virtual void setHiddenKeepsGeometry (bool enabled)
 Sets whether the widget keeps its geometry when hidden. More...
 
virtual bool hiddenKeepsGeometry () const
 Returns whether the widget keeps its geometry when hidden. More...
 
virtual void setHidden (bool hidden, const WAnimation &animation=WAnimation())
 Hides or shows the widget. More...
 
virtual bool isHidden () const
 Returns whether the widget is set hidden. More...
 
virtual bool isVisible () const
 Returns whether the widget is visible. More...
 
virtual void setDisabled (bool disabled)
 Sets whether the widget is disabled. More...
 
virtual bool isDisabled () const
 Returns whether the widget is set disabled. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual bool isPopup () const
 Returns whether the widget is overlayed. More...
 
virtual void setInline (bool isInline)
 Sets whether the widget is displayed inline or as a block. More...
 
virtual bool isInline () const
 Returns whether the widget is displayed inline or as block. More...
 
virtual void setDecorationStyle (const WCssDecorationStyle &style)
 Sets a CSS decoration style. More...
 
virtual WCssDecorationStyledecorationStyle ()
 Returns the decoration style of this widget. More...
 
virtual void setStyleClass (const WString &styleClass)
 Sets (one or more) CSS style classes. More...
 
virtual WString styleClass () const
 Returns the CSS style class. More...
 
virtual void addStyleClass (const WString &styleClass, bool force=false)
 Adds a CSS style class. More...
 
virtual void removeStyleClass (const WString &styleClass, bool force=false)
 Removes a CSS style class. More...
 
virtual bool hasStyleClass (const WString &styleClass) const
 Returns whether the widget has a style class.
 
virtual void setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)
 Sets the vertical alignment. More...
 
virtual AlignmentFlag verticalAlignment () const
 Returns the vertical alignment. More...
 
virtual WLength verticalAlignmentLength () const
 Returns the fixed vertical alignment that was set. More...
 
virtual void setToolTip (const WString &text, TextFormat textFormat=PlainText)
 Sets a tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
virtual void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual void refresh ()
 Refresh the widget. More...
 
virtual void setAttributeValue (const std::string &name, const WString &value)
 Sets an attribute value. More...
 
virtual WString attributeValue (const std::string &name) const
 Returns an attribute value. More...
 
virtual void setJavaScriptMember (const std::string &name, const std::string &value)
 Sets a JavaScript member. More...
 
virtual std::string javaScriptMember (const std::string &name) const
 Returns the value of a JavaScript member. More...
 
virtual void callJavaScriptMember (const std::string &name, const std::string &args)
 Calls a JavaScript member. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool loaded () const
 Returns whether this widget has been loaded. More...
 
virtual void setCanReceiveFocus (bool enabled)
 Sets whether the widget can receive focus. More...
 
virtual bool canReceiveFocus () const
 Returns whether the widget can receive focus. More...
 
virtual void setFocus (bool focus)
 Sets focus. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. More...
 
virtual bool hasFocus () const
 Returns whether the widget currently has the focus.
 
virtual void setTabIndex (int index)
 Sets the tab index. More...
 
virtual int tabIndex () const
 Returns the tab index. More...
 
virtual void setId (const std::string &id)
 Sets the CSS Id. More...
 
virtual WWidgetfind (const std::string &name)
 Finds a descendent widget by name. More...
 
virtual WWidgetfindById (const std::string &name)
 Finds a descendent widget by id.
 
virtual void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &js)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
virtual bool scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
 Returns whether scroll visibility detection is enabled for this widget. More...
 
virtual void setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
 Sets whether scroll visibility detection is enabled for this widget. More...
 
virtual int scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
 Returns the margin around the viewport within which the widget is considered visible. More...
 
virtual void setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
 Sets the margin around the viewport within which the widget is considered visible. More...
 
virtual Signal< bool > & scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
 Signal triggered when the scroll visibility of this widget changes. More...
 
virtual bool isScrollVisible () const WT_CXX11ONLY(finaloverride)
 Returns whether this widget is currently considered scroll visible. More...
 
virtual void setThemeStyleEnabled (bool enabled)
 Sets whether theme styling for a widget is enabled or disabled. More...
 
virtual bool isThemeStyleEnabled () const
 Returns whether this widget is currently styled by the chosen theme. More...
 
- Public Member Functions inherited from Wt::WWidget
virtual ~WWidget ()
 Destructor. More...
 
WWidgetparent () const
 Returns the parent widget. More...
 
virtual void removeChild (WObject *child)
 Removes a child object. More...
 
void setWidth (const WLength &width)
 Sets the width. More...
 
void setHeight (const WLength &height)
 Sets the height. More...
 
virtual void positionAt (const WWidget *widget, Orientation orientation=Vertical)
 Positions a widget next to another widget. More...
 
virtual void toggleStyleClass (const WString &styleClass, bool add, bool force=false)
 Toggles a CSS style class.
 
std::string jsRef () const
 Returns a JavaScript expression to the corresponding DOM node. More...
 
void setFocus ()
 Sets focus. More...
 
virtual void acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
 Sets a mime type to be accepted for dropping. More...
 
virtual void stopAcceptDrops (const std::string &mimeType)
 Indicates that a mime type is no longer accepted for dropping. More...
 
virtual void htmlText (std::ostream &out)
 Streams the (X)HTML representation. More...
 
bool isRendered () const
 Returns whether the widget is rendered. More...
 
void hide ()
 Hides the widget. More...
 
void animateHide (const WAnimation &animation)
 Hides the widget using an animation. More...
 
void show ()
 Shows the widget. More...
 
void animateShow (const WAnimation &animation)
 Shows the widget using an animation. More...
 
void enable ()
 Enables the widget. More...
 
void disable ()
 Disable thes widget. More...
 
bool layoutSizeAware () const
 Returns whether the widget is layout size aware. 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...
 
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...
 
const std::vector< WObject * > & children () const
 Returns the children.
 
WObjectparent () const
 Returns the parent object.
 

Protected Member Functions

virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. More...
 
virtual void doGmJavaScript (const std::string &jscode)
 Execute a piece of JavaScript that manipulates the map. More...
 
- Protected Member Functions inherited from Wt::WCompositeWidget
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
void setImplementation (WWidget *widget)
 Set the implementation widget. More...
 
WWidgetimplementation ()
 Get the implementation widget. More...
 
virtual int boxPadding (Orientation orientation) const
 Returns the widget's built-in padding. More...
 
virtual int boxBorder (Orientation orientation) const
 Returns the widget's built-in border width. More...
 
- Protected Member Functions inherited from Wt::WWidget
void setLayoutSizeAware (bool sizeAware)
 Sets the widget to be aware of its size set by a layout manager. More...
 
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
 WWidget (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. More...
 
void scheduleRender (WFlags< RepaintFlag > flags=0)
 Schedules rerendering of the widget. More...
 
virtual WStatelessSlot * getStateless (Method method)
 On-demand stateless slot implementation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Wt::WWidget
static WString tr (const char *key)
 Short hand for WString::tr() More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

A widget that displays a google map.

This widget uses the online Google Maps server to display a map. It exposes a part of the google maps API.

This widget supports both version 2 and version 3 of the Google Maps API. The version 2 API is used by default, to enable the version 3 API, use the constructor's version argument.

To use the map on a public server you will need to obtain a key. The widget will look for this key as the configuration property "google_api_key". If this configuration property has not been set, it will use a key that is suitable for localhost.

CSS

Styling through CSS is not applicable.

Contributed by: Richard Ulrich.

Member Enumeration Documentation

ApiVersion.

Enumerator
Version2 

API Version 2.x.

Version3 

API Version 3.x.

MapTypeControl.

Enumerator
NoControl 

Show no maptype control.

DefaultControl 

Show the default maptype control.

MenuControl 

Show the dropdown menu maptype control.

HierarchicalControl 

Show the hierarchical maptype control.

HorizontalBarControl 

Show the horizontal bar maptype control.

Member Function Documentation

void Wt::WGoogleMap::addCircle ( const Coordinate center,
double  radius,
const WColor strokeColor,
int  strokeWidth,
const WColor fillColor = WColor() 
)

Adds a circle to the map.

The stroke and fill opacity can be configured respectively in the strokeColor and fillColor. This feature is only supported by the Google Maps API version 3.

void Wt::WGoogleMap::addPolyline ( const std::vector< Coordinate > &  points,
const WColor color = WColor(red),
int  width = 2,
double  opacity = 1.0 
)

Adds a polyline overlay to the map.

Specify a value between 0.0 and 1.0 for the opacity or set the alpha value in the color.

void Wt::WGoogleMap::checkResize ( )

Notifies the map of a change of the size of its container.

Call this method after the size of the container DOM object has changed, so that the map can adjust itself to fit the new size.

Deprecated:
the map is resized automatically when necessary
JSignal<Coordinate>& Wt::WGoogleMap::clicked ( )

The click event.

This event is fired when the user clicks on the map with the mouse.

void Wt::WGoogleMap::disableGoogleBar ( )

Disables the GoogleBar integrated search control.

When disabled, the default Powered by Google logo occupies the position formerly containing this control. Note that this control is already disabled by default.

Note
This functionality is no longer available in the Google Maps API v3.
void Wt::WGoogleMap::disableScrollWheelZoom ( )

Disables zooming using a mouse's scroll wheel.

Scroll wheel zoom is disabled by default.

void Wt::WGoogleMap::doGmJavaScript ( const std::string &  jscode)
protectedvirtual

Execute a piece of JavaScript that manipulates the map.

This is like doJavaScript() but delays the javascript until the map has been loaded.

JSignal<Coordinate>& Wt::WGoogleMap::doubleClicked ( )

The double click event.

This event is fired when a double click is done on the map.

void Wt::WGoogleMap::enableGoogleBar ( )

Enables the GoogleBar, an integrated search control, on the map.

When enabled, this control takes the place of the default Powered By Google logo.

This control is initially disabled.

Note
This functionality is no longer available in the Google Maps API v3.
void Wt::WGoogleMap::enableScrollWheelZoom ( )

Enables zooming using a mouse's scroll wheel.

Scroll wheel zoom is disabled by default.

void Wt::WGoogleMap::panTo ( const Coordinate center)

Changes the center point of the map to the given point.

If the point is already visible in the current map view, change the center in a smooth animation.

void Wt::WGoogleMap::render ( WFlags< RenderFlag flags)
protectedvirtual

Renders the widget.

This function renders the widget (or an update for the widget), after this has been scheduled using scheduleRender().

The default implementation will render the widget by serializing changes to JavaScript and HTML. You may want to reimplement this widget if you have been postponing some of the layout / rendering implementation until the latest moment possible. In that case you should make sure you call the base implementation however.

Reimplemented from Wt::WCompositeWidget.

void Wt::WGoogleMap::savePosition ( )

Stores the current map position and zoom level.

You can later restore this position using returnToSavedPosition().

void Wt::WGoogleMap::setMapTypeControl ( MapTypeControl  type)

Sets the map type control.

The control allows selecting and switching between supported map types via buttons.


Generated on Tue Nov 21 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11