Wt  3.3.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Public Member Functions | Protected Member Functions | List of all members
Wt::Chart::WAbstractChart Class Referenceabstract

Abstract base class for MVC-based charts. More...

#include <Wt/Chart/WAbstractChart>

Inheritance diagram for Wt::Chart::WAbstractChart:
Inheritance graph
[legend]

Public Member Functions

virtual ~WAbstractChart ()
 Destructor.
 
void setModel (WAbstractItemModel *model)
 Set the model. More...
 
WAbstractItemModelmodel () const
 Returns the model. More...
 
void setBackground (const WBrush &background)
 Sets a background for the chart. More...
 
const WBrushbackground () const
 Returns the background of the chart. More...
 
void setPalette (WChartPalette *palette)
 Set a palette for the chart. More...
 
WChartPalettepalette () const
 Returns the palette for the chart. More...
 
void setPlotAreaPadding (int padding, WFlags< Side > sides=All)
 Set an internal margin for the main plot area. More...
 
int plotAreaPadding (Side side) const
 Returns the internal margin for the main plot area. More...
 
void setTitle (const WString &title)
 Set a chart title. More...
 
const WStringtitle () const
 Return the chart title. More...
 
void setTitleFont (const WFont &titleFont)
 Set the font for the chart title. More...
 
const WFonttitleFont () const
 Returns the font for the chart title. More...
 
virtual void paint (WPainter &painter, const WRectF &rectangle=WRectF()) const =0
 Paint the chart in a rectangle of the given painter. More...
 
- Public Member Functions inherited from Wt::WPaintedWidget
 WPaintedWidget (WContainerWidget *parent=0)
 Create a new painted widget.
 
 ~WPaintedWidget ()
 Destructor.
 
void setPreferredMethod (Method method)
 Sets the preferred rendering method. More...
 
Method preferredMethod () const
 Returns the preferred rendering method. More...
 
void update (WFlags< PaintFlag > flags=0)
 Lets the widget repaint itself. More...
 
virtual void resize (const WLength &width, const WLength &height)
 Resizes the widget. More...
 
void addArea (WAbstractArea *area)
 Adds an interactive area. More...
 
void insertArea (int index, WAbstractArea *area)
 Inserts an interactive area. More...
 
void removeArea (WAbstractArea *area)
 Removes an interactive area. More...
 
WAbstractAreaarea (int index) const
 Returns the interactive area at the given index. More...
 
const std::vector
< WAbstractArea * > 
areas () const
 Returns the interactive areas set for this widget. More...
 
- Public Member Functions inherited from Wt::WInteractWidget
 WInteractWidget (WContainerWidget *parent=0)
 Create an InteractWidget with optional parent.
 
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...
 
EventSignal< WTouchEvent > & touchStarted ()
 Event signal emitted when a finger is placed on the screen. More...
 
EventSignal< WTouchEvent > & touchEnded ()
 Event signal emitted when a finger is removed from the screen. More...
 
EventSignal< WTouchEvent > & touchMoved ()
 Event signal emitted when a finger, which is already placed on the screen, is moved across the screen. More...
 
EventSignal< WGestureEvent > & gestureStarted ()
 Event signal emitted when a gesture is started. More...
 
EventSignal< WGestureEvent > & gestureChanged ()
 Event signal emitted when a gesture is changed. More...
 
EventSignal< WGestureEvent > & gestureEnded ()
 Event signal emitted when a gesture is ended. More...
 
void setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0)
 Configure dragging for drag and drop. More...
 
void setMouseOverDelay (int delay)
 Sets a delay for the mouse over event. More...
 
int mouseOverDelay () const
 Returns the mouse over signal delay. More...
 
virtual void setPopup (bool popup)
 Lets the widget overlay over other sibling widgets. More...
 
virtual void load ()
 Loads content just before the widget is used. More...
 
virtual bool isEnabled () const
 Returns whether the widget is enabled. More...
 
- Public Member Functions inherited from Wt::WWebWidget
 WWebWidget (WContainerWidget *parent=0)
 Construct a WebWidget with a given parent. 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 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 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())
 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 void setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
 Enable deferred tooltip. More...
 
virtual WString toolTip () const
 Returns the tooltip.
 
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 bool loaded () const
 Returns whether this widget has been loaded. More...
 
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 void setSelectable (bool selectable)
 Sets as selectable. More...
 
virtual void doJavaScript (const std::string &javascript)
 Executes the given JavaScript statements when the widget is rendered or updated. More...
 
virtual const std::string id () const
 Returns the (unique) identifier for this object. More...
 
void setLoadLaterWhenInvisible (bool)
 Change the way the widget is loaded when invisible. More...
 
const std::vector< WWidget * > & children () const
 Returns contained widgets. More...
 
SignalchildrenChanged ()
 Signal emitted when children have been added or removed. More...
 
virtual bool setFirstFocus ()
 Set focus on the widget's first descendant. 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...
 
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...
 
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...
 
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 modelChanged ()
 Method called whenever the entire model was changed. More...
 
virtual void modelReset ()
 Method called whenever the entire model was reset. More...
 
virtual void modelColumnsInserted (const WModelIndex &parent, int start, int end)=0
 Method called when colums have been inserted in the model. More...
 
virtual void modelColumnsRemoved (const WModelIndex &parent, int start, int end)=0
 Method called when colums have been removed from the model. More...
 
virtual void modelRowsInserted (const WModelIndex &parent, int start, int end)=0
 Method called when rows have been inserted from the model. More...
 
virtual void modelRowsRemoved (const WModelIndex &parent, int start, int end)=0
 Method called when rows have been removed from the model. More...
 
virtual void modelDataChanged (const WModelIndex &topLeft, const WModelIndex &bottomRight)=0
 Method called when data has been changed in the model. More...
 
virtual void modelHeaderDataChanged (Orientation orientation, int start, int end)=0
 Method called when header data has been changed in the model. More...
 
- Protected Member Functions inherited from Wt::WPaintedWidget
virtual void layoutSizeChanged (int width, int height)
 Virtual method that indicates a size change. More...
 
virtual Method getMethod () const
 Returns the actual method used for rendering. More...
 
virtual void paintEvent (WPaintDevice *paintDevice)=0
 Paints the widget. More...
 
virtual void enableAjax ()
 Progresses to an Ajax-enabled widget. More...
 
- Protected Member Functions inherited from Wt::WInteractWidget
virtual void propagateSetEnabled (bool enabled)
 Propagates that a widget was enabled or disabled through children. More...
 
- Protected Member Functions inherited from Wt::WWebWidget
virtual void render (WFlags< RenderFlag > flags)
 Renders the widget. 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...
 
 WWidget (WContainerWidget *parent=0)
 Creates a widget. More...
 
virtual void dropEvent (WDropEvent dropEvent)
 Handles a drop event. 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...
 
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

- Public Types inherited from Wt::WPaintedWidget
enum  Method { InlineSvgVml, HtmlCanvas, PngImage }
 Enumeration that indicates a rendering method. More...
 
- Static Public Member Functions inherited from Wt::WWebWidget
static WString escapeText (const WString &text, bool newlinesToo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static std::string & escapeText (std::string &text, bool newlinestoo=false)
 Escape HTML control characters in the text, to display literally (deprecated). More...
 
static bool removeScript (WString &text)
 Remove tags/attributes from text that are not passive (deprecated). More...
 
static std::string jsStringLiteral (const std::string &v, char delimiter= '\'')
 Turn a UTF8 encoded string into a JavaScript string literal. More...
 
- Static Protected Member Functions inherited from Wt::WObject
static WObjectsender ()
 Returns the sender of the current slot call. More...
 

Detailed Description

Abstract base class for MVC-based charts.

This is an abstract class and should not be used directly.

As an abstract base for MVC-based charts, this class manages the model setModel() and provides virtual methods that listen to model changes. In addition, it gives access to generic chart properties such as the title setTitle() and title font setTitleFont(), the chart palette setPalette(), plot area padding setPlotAreaPadding(), and the background fill color setBackground().

CSS

Styling through CSS is not applicable.

See Also
WCartesianChart, WPieChart

Member Function Documentation

const WBrush& Wt::Chart::WAbstractChart::background ( ) const

Returns the background of the chart.

See Also
setBackground(const WBrush&)
WAbstractItemModel* Wt::Chart::WAbstractChart::model ( ) const

Returns the model.

See Also
setModel(WAbstractItemModel *)
void Wt::Chart::WAbstractChart::modelChanged ( )
protectedvirtual

Method called whenever the entire model was changed.

See Also
setModel(WAbstractItemModel *)

Reimplemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::modelColumnsInserted ( const WModelIndex parent,
int  start,
int  end 
)
protectedpure virtual

Method called when colums have been inserted in the model.

See Also
WAbstractItemModel::columnsInserted

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::modelColumnsRemoved ( const WModelIndex parent,
int  start,
int  end 
)
protectedpure virtual

Method called when colums have been removed from the model.

See Also
WAbstractItemModel::columnsRemoved

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::modelDataChanged ( const WModelIndex topLeft,
const WModelIndex bottomRight 
)
protectedpure virtual

Method called when data has been changed in the model.

See Also
WAbstractItemModel::dataChanged

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::modelHeaderDataChanged ( Orientation  orientation,
int  start,
int  end 
)
protectedpure virtual

Method called when header data has been changed in the model.

See Also
WAbstractItemModel::headerDataChanged

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

void Wt::Chart::WAbstractChart::modelReset ( )
protectedvirtual

Method called whenever the entire model was reset.

Bound to the WAbstractItemModel::modelReset() and WAbstractItemModel::layoutChanged() signals.

Reimplemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::modelRowsInserted ( const WModelIndex parent,
int  start,
int  end 
)
protectedpure virtual

Method called when rows have been inserted from the model.

See Also
WAbstractItemModel::rowsInserted

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::modelRowsRemoved ( const WModelIndex parent,
int  start,
int  end 
)
protectedpure virtual

Method called when rows have been removed from the model.

See Also
WAbstractItemModel::rowsRemoved

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

virtual void Wt::Chart::WAbstractChart::paint ( WPainter painter,
const WRectF rectangle = WRectF() 
) const
pure virtual

Paint the chart in a rectangle of the given painter.

Paints the chart inside the painter, in the area indicated by rectangle. When rectangle is a null rectangle, the entire painter window is used.

Implemented in Wt::Chart::WCartesianChart, and Wt::Chart::WPieChart.

WChartPalette* Wt::Chart::WAbstractChart::palette ( ) const

Returns the palette for the chart.

See Also
setPalette(WChartPalette *palette)
int Wt::Chart::WAbstractChart::plotAreaPadding ( Side  side) const

Returns the internal margin for the main plot area.

See Also
setPlotAreaPadding(int, WFlags<Side>)
void Wt::Chart::WAbstractChart::setBackground ( const WBrush background)

Sets a background for the chart.

Set the background color for the main plot area.

The default is a completely transparent background.

See Also
background()
void Wt::Chart::WAbstractChart::setModel ( WAbstractItemModel model)

Set the model.

The model is used by the chart to get its data. Ownership of the model is not transferred, and if a previous model was set it is not deleted.

The default model is a 0 model.

See Also
model()
void Wt::Chart::WAbstractChart::setPalette ( WChartPalette palette)

Set a palette for the chart.

A palette is used to provide the style information to render the chart series. Ownership of the palette is transferred to the chart.

The default palette is dependent on the chart type.

See Also
palette()
void Wt::Chart::WAbstractChart::setPlotAreaPadding ( int  padding,
WFlags< Side sides = All 
)

Set an internal margin for the main plot area.

This configures the area (in pixels) around the plot area that is available for axes, labels, and titles. You need to set this appropriately so that labels fit inside these margins.

The default is dependent on the chart type.

void Wt::Chart::WAbstractChart::setTitle ( const WString title)

Set a chart title.

The title is displayed on top of the chart, using the titleFont().

The default title is an empty title ("").

See Also
title()
void Wt::Chart::WAbstractChart::setTitleFont ( const WFont titleFont)

Set the font for the chart title.

Changes the font for the chart title.

The default title font is a 15 point Sans Serif font.

See Also
titleFont(), setTitle(const WString&)
const WString& Wt::Chart::WAbstractChart::title ( ) const

Return the chart title.

See Also
title()
const WFont& Wt::Chart::WAbstractChart::titleFont ( ) const

Returns the font for the chart title.

See Also
setTitleFont(const WFont&)

Generated on Tue May 27 2014 for the C++ Web Toolkit (Wt) by doxygen 1.8.4