Wt  4.0.1
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
Wt Namespace Reference

The namespace for Wt. More...

Namespaces

 Auth
 Namespace for the Authentication module (Wt::Auth).
 
 Chart
 Namespace for the Charts (Wt::Chart).
 
 Core
 Namespace for core utility classes.
 
 Dbo
 Namespace for the Database Objects (Wt::Dbo).
 
 Http
 Namespace for HTTP protocol (Wt::Http) handling.
 
 Json
 Namespace for the JSON Library (Wt::Json).
 
 Mail
 Namespace for the SMTP client library (Wt::Mail).
 
 Payment
 Namespace for the Payment.
 
 Render
 Namespace for the XHTML Rendering (Wt::Render).
 
 Utils
 Namespace with utility functions.
 

Classes

struct  any_traits
 A traits class for a type stored in a cpp17::any. More...
 
struct  Coordinates
 A coordinate. More...
 
class  DomElement
 Class to represent a client-side DOM element (proxy). More...
 
class  EventSignal
 A signal that conveys user-interface events. More...
 
class  EventSignalBase
 Abstract base class of an event signal. More...
 
class  ItemDataRole
 Enumeration that indicates a role for a data item. More...
 
class  JSignal
 A signal to relay JavaScript to C++ calls. More...
 
class  JSlot
 A slot that is only implemented in client side JavaScript code. More...
 
class  LocalizedString
 The result of resolving a localized string. More...
 
class  PopupWindow
 Internal class that provides a JavaScript popup window managing function. More...
 
class  Signal
 A signal that propagates events to listeners. More...
 
class  SignalBase
 Abstract base class of a signal. More...
 
class  Touch
 A single finger touch of a touch event. More...
 
class  WAbstractArea
 Abstract base class for interactive areas in a widget. More...
 
class  WAbstractItemDelegate
 Abstract delegate class for rendering an item in an item view. More...
 
class  WAbstractItemModel
 An abstract model for use with Wt's view classes. More...
 
class  WAbstractItemView
 An abstract base class for item Views. More...
 
class  WAbstractListModel
 An abstract list model for use with Wt's view classes. More...
 
class  WAbstractMedia
 Abstract baseclass for native media elements. More...
 
class  WAbstractProxyModel
 An abstract proxy model for Wt's item models. More...
 
class  WAbstractSpinBox
 An abstract spin box. More...
 
class  WAbstractTableModel
 An abstract table model for use with Wt's view classes. More...
 
class  WAbstractToggleButton
 An abstract base class for radio buttons and check boxes. More...
 
class  WAggregateProxyModel
 A proxy model for Wt's item models that provides column aggregation. More...
 
class  WAnchor
 A widget that represents an HTML anchor (to link to other documents). More...
 
class  WAnimation
 A value class that defines a transition effect. More...
 
class  WApplication
 Represents an application instance for a single session. More...
 
class  WAudio
 A widget that plays audio. More...
 
class  WBatchEditProxyModel
 A proxy model for Wt's item models that provides batch editing. More...
 
class  WBootstrapTheme
 Theme based on the Twitter Bootstrap CSS framework. More...
 
class  WBorder
 A value class that defines the CSS border style of a widget. More...
 
class  WBorderLayout
 A layout manager which divides the container region in five regions. More...
 
class  WBoxLayout
 A layout manager which arranges widgets horizontally or vertically. More...
 
class  WBreak
 A widget that provides a line break between inline widgets. More...
 
class  WBrush
 A value class that defines the style for filling a path. More...
 
class  WButtonGroup
 A class for grouping radio buttons logically together. More...
 
class  WCalendar
 A calendar. More...
 
class  WCanvasPaintDevice
 A paint device for rendering using the HTML 5 <canvas> element. More...
 
class  WCheckBox
 A user control that represents a check box. More...
 
class  WCircleArea
 A interactive area in a widget, specified by a circle. More...
 
class  WColor
 A value class that defines a color. More...
 
class  WCombinedLocalizedStrings
 A localized string resolver that bundles multiple string resolvers. More...
 
class  WComboBox
 A widget that provides a drop-down combo-box control. More...
 
class  WCompositeWidget
 A widget that hides the implementation of composite widgets. More...
 
class  WContainerWidget
 A widget that holds and manages child widgets. More...
 
class  WCssDecorationStyle
 A style class for a single widget or style sheet rule. More...
 
class  WCssRule
 Abstract rule in a CSS style sheet. More...
 
class  WCssStyleSheet
 A CSS style sheet. More...
 
class  WCssTemplateRule
 A CSS rule based on a template widget. More...
 
class  WCssTextRule
 A CSS rule specified directly using CSS declarations. More...
 
class  WCssTheme
 
class  WDate
 A value class that represents a date on the Gregorian calendar. More...
 
class  WDateEdit
 A date edit. More...
 
class  WDatePicker
 A date picker. More...
 
class  WDateTime
 A calendar date and clock time. More...
 
class  WDateValidator
 A validator for date input. More...
 
class  WDefaultLoadingIndicator
 A default loading indicator. More...
 
class  WDialog
 A WDialog shows a dialog. More...
 
class  WDoubleSpinBox
 An input control for fixed point numbers. More...
 
class  WDoubleValidator
 A validator for validating floating point user input. More...
 
class  WDropEvent
 A class providing details for a drop event. More...
 
class  WEnvironment
 A class that captures information on the application environment. More...
 
class  WEvent
 An application event. More...
 
class  WException
 Base class for exceptions thrown by Wt. More...
 
class  WFileDropWidget
 A widget that allows dropping files for upload. More...
 
class  WFileResource
 A resource which streams the data from a local file. More...
 
class  WFileUpload
 A widget that allows a file to be uploaded. More...
 
class  WFitLayout
 A layout manager which spans a single widget to all available space. More...
 
class  WFlags
 Utility class for type-safe combinations of enumeration flags. More...
 
class  WFlashObject
 A widget that renders a Flash object (also known as Flash movie). More...
 
class  WFont
 A value class that describes a font. More...
 
class  WFontMetrics
 A value class that describes font metrics for a font. More...
 
class  WFormModel
 A basic model class for forms. More...
 
class  WFormWidget
 An abstract widget that corresponds to an HTML form element. More...
 
class  WGenericMatrix
 A value class that describes a matrix. More...
 
class  WGestureEvent
 A class providing details for a gesture event. More...
 
class  WGLWidget
 GL support class. More...
 
class  WGoogleMap
 A widget that displays a google map. More...
 
class  WGradient
 A linear or radial gradient. More...
 
class  WGridLayout
 A layout manager which arranges widgets in a grid. More...
 
class  WGroupBox
 A widget which group widgets into a frame with a title. More...
 
class  WHBoxLayout
 A layout manager which arranges widgets horizontally. More...
 
class  WIconPair
 A widget that shows one of two icons depending on its state. More...
 
class  WIdentityProxyModel
 A proxy model that proxies its source model unmodified. More...
 
class  WImage
 A widget that displays an image. More...
 
class  WInPlaceEdit
 A widget that provides in-place-editable text. More...
 
class  WInteractWidget
 An abstract widget that can receive user-interface interaction. More...
 
class  WIntValidator
 A validator that validates integer user input. More...
 
class  WIOService
 An I/O service. More...
 
class  WItemDelegate
 Standard delegate class for rendering a view item. More...
 
class  WItemSelectionModel
 A class that represents a selection for a WAbstractItemView. More...
 
class  WJavaScriptExposableObject
 A JavaScript exposable object. More...
 
class  WJavaScriptHandle
 A handle to a JavaScript representation of an object. More...
 
class  WKeyEvent
 A class providing details for a keyboard event. More...
 
class  WLabel
 A label for a form field. More...
 
class  WLayout
 An abstract base class for layout managers. More...
 
class  WLayoutImpl
 An abstract base class for implementing layout managers. More...
 
class  WLayoutItem
 An abstract base class for items that can participate in a layout. More...
 
class  WLayoutItemImpl
 An abstract base class for implementing layout managers. More...
 
class  WLength
 A value class that describes a CSS length. More...
 
class  WLengthValidator
 A validator that checks the string length of user input. More...
 
class  WLineEdit
 A widget that provides a single line edit. More...
 
class  WLineF
 Utility class that defines a single line. More...
 
class  WLink
 A value class that defines a hyperlink target. More...
 
class  WLinkedCssStyleSheet
 An external CSS style sheet. More...
 
class  WLoadingIndicator
 An abstract interface for a loading indicator. More...
 
class  WLocalDateTime
 A localized calendar date and clock time. More...
 
class  WLocale
 A locale. More...
 
class  WLocalizedStrings
 An abstract class that provides support for localized strings. More...
 
class  WLogEntry
 A stream-like object for creating an entry in a log file. More...
 
class  WLogger
 A simple logging class. More...
 
class  WMatrix4x4
 A value class that describes a 3D affine transformation matrix. More...
 
class  WMeasurePaintDevice
 WMeasurePaintDevice Wt/WMeasurePaintDevice Wt/WMeasurePaintDevice. More...
 
class  WMediaPlayer
 A media player. More...
 
class  WMemoryResource
 A resource which streams data from memory. More...
 
class  WMenu
 A widget that shows a menu of options. More...
 
class  WMenuItem
 A single item in a menu. More...
 
class  WMessageBox
 A standard dialog for confirmation or to get simple user input. More...
 
class  WMessageResourceBundle
 Support for localized strings using XML files. More...
 
class  WModelIndex
 A value class that describes an index to an item in a data model. More...
 
class  WMouseEvent
 A class providing details for a mouse event. More...
 
class  WNavigationBar
 A navigation bar. More...
 
class  WObject
 A base class for objects that participate in the signal/slot system. More...
 
class  WOverlayLoadingIndicator
 A more obvious loading indicator that grays the window. More...
 
class  WPaintDevice
 The abstract base class for a paint device. More...
 
class  WPaintedWidget
 A widget that is painted using vector graphics. More...
 
class  WPainter
 Vector graphics painting class. More...
 
class  WPainterPath
 A path defining a shape. More...
 
class  WPanel
 A WPanel provides a container with a title bar. More...
 
class  WPdfImage
 A paint device for rendering to a PDF. More...
 
class  WPen
 A value class that defines the style for pen strokes. More...
 
class  WPoint
 A value class that defines a 2D point with integer coordinates. More...
 
class  WPointF
 A value class that defines a 2D point. More...
 
class  WPolygonArea
 An interactive area in a widget, specified by a polygon. More...
 
class  WPopupMenu
 A menu presented in a popup window. More...
 
class  WPopupWidget
 Base class for popup widgets. More...
 
class  WProgressBar
 A progress bar. More...
 
class  WPushButton
 A widget that represents a push button. More...
 
class  WRadioButton
 A user control that represents a radio button. More...
 
class  WRandom
 Random number generator. More...
 
class  WRasterImage
 A paint device for rendering to a raster image. More...
 
class  WReadOnlyProxyModel
 A read-only wrapper for a source model. More...
 
class  WRectArea
 A interactive area in a widget, specified by a rectangle. More...
 
class  WRectF
 A value class that defines a rectangle. More...
 
class  WRegExpValidator
 A validator that checks user input against a regular expression. More...
 
class  WResource
 An object which can be rendered in the HTTP protocol. More...
 
class  WScrollEvent
 A class providing details for a scroll event. More...
 
class  WSelectionBox
 A selection box allows selection from a list of options. More...
 
class  WServer
 A class encapsulating a web application server. More...
 
class  WShadow
 A value class that defines a shadow style. More...
 
class  WSlider
 A horizontal or vertical slider control. More...
 
class  WSocketNotifier
 A utility class for asynchronous notification of socket activity. More...
 
class  WSortFilterProxyModel
 A proxy model for Wt's item models that provides filtering and/or sorting. More...
 
class  WSound
 A value class to play a sound effect. More...
 
class  WSpinBox
 An input control for integer numbers. More...
 
class  WSplitButton
 A split button. More...
 
class  WSslCertificate
 An interface to an SSL certificate. More...
 
class  WSslInfo
 Provides SSL information about the current session. More...
 
class  WStackedWidget
 A container widget that stacks its widgets on top of each other. More...
 
class  WStandardItem
 An item in a WStandardItemModel. More...
 
class  WStandardItemModel
 A standard data model, which stores its data in memory. More...
 
class  WStaticModelView
 A widget that implements a view for a non-changing model. More...
 
class  WStreamResource
 An object which streams the data from a std::istream. More...
 
class  WString
 A value class which describes a locale-aware unicode string. More...
 
class  WStringListModel
 An model that manages a list of strings. More...
 
class  WStringStream
 
class  WSuggestionPopup
 A widget which popups to assist in editing a textarea or lineedit. More...
 
class  WSvgImage
 A paint device for rendering using Scalable Vector Graphics (SVG). More...
 
class  WTable
 A container widget which provides layout of children in a table grid. More...
 
class  WTableCell
 A container widget that represents a cell in a table. More...
 
class  WTableColumn
 A table column. More...
 
class  WTableRow
 A table row. More...
 
class  WTableView
 An MVC View widget for tabular data. More...
 
class  WTabWidget
 A widget that organizes contents in tab panes. More...
 
class  WTemplate
 A widget that renders an XHTML template. More...
 
class  WTemplateFormView
 A template-based View class form models. More...
 
class  WText
 A widget that renders (XHTML) text. More...
 
class  WTextArea
 A widget that provides a multi-line edit. More...
 
class  WTextEdit
 A rich-text XHTML editor. More...
 
class  WTextItem
 The result of a font metrics computation. More...
 
class  WTheme
 
class  WTime
 A value class that defines a clock time. More...
 
class  WTimeEdit
 A Time field editor. More...
 
class  WTimer
 A utility class which provides timer signals and single-shot timers. More...
 
class  WTimeValidator
 A time validator. More...
 
class  WToolBar
 A toolbar. More...
 
class  WTouchEvent
 A class providing details for a touch event. More...
 
class  WTransform
 A value class that defines a 2D affine transformation matrix. More...
 
class  WTree
 A widget that represents a navigatable tree. More...
 
class  WTreeNode
 A single node in a tree. More...
 
class  WTreeTable
 A table with a navigatable tree in the first column. More...
 
class  WTreeTableNode
 A specialized tree node which allows additional data to be associated with each node. More...
 
class  WTreeView
 A view class that displays a model as a tree or tree table. More...
 
class  WValidator
 A validator is used to validate user input according to pre-defined rules. More...
 
class  WVBoxLayout
 A layout manager which arranges widgets vertically. More...
 
class  WVectorImage
 An abstract paint device for rendering using native vector graphics. More...
 
class  WVideo
 A video-playing widget. More...
 
class  WViewWidget
 An abstract base class for an MVC view that is rendered using a widget. More...
 
class  WVirtualImage
 An abstract widget that shows a viewport to a virtually large image. More...
 
class  WVmlImage
 A paint device for rendering using the VML pseudo-standard. More...
 
class  WWebWidget
 A base class for widgets with an HTML counterpart. More...
 
class  WWidget
 The abstract base class for a user-interface component. More...
 
class  WWidgetItem
 A layout item that holds a single widget. More...
 
class  WWidgetItemImpl
 An abstract base class for implementing layout managers. More...
 

Typedefs

typedef std::set< WModelIndexWModelIndexSet
 A set of WModelIndexes.
 
typedef std::vector< WModelIndexWModelIndexList
 List of indexes. More...
 

Enumerations

Functions

WString asString (const cpp17::any &v, const WString &formatString=WString())
 Interprets a cpp17::any as a string value. More...
 
double asNumber (const cpp17::any &v)
 Interprets a cpp17::any as a number value. More...
 
template<typename Type >
void registerType ()
 Registers MVC-support for a type passed in a cpp17::any. More...
 
template<typename T , std::size_t A, std::size_t B, std::size_t C>
WGenericMatrix< T, A, C > operator* (const WGenericMatrix< T, A, B > &l, const WGenericMatrix< T, B, C > &r)
 Multiply two matrices.
 
template<typename T , std::size_t Rows, std::size_t Cols>
std::ostream & operator<< (std::ostream &os, const WGenericMatrix< T, Rows, Cols > &m)
 Print the matrix to an ostream.
 
template<typename T , std::size_t Rows, std::size_t Cols>
WGenericMatrix< T, Rows, Cols > operator* (const T &factor, const WGenericMatrix< T, Rows, Cols > &m)
 Multiply every element in the matrix with the given factor.
 
template<typename T , std::size_t Rows, std::size_t Cols>
WGenericMatrix< T, Rows, Cols > operator* (const WGenericMatrix< T, Rows, Cols > &m, const T &factor)
 Multiply every element in the matrix with the given factor.
 
template<typename T , std::size_t Rows, std::size_t Cols>
WGenericMatrix< T, Rows, Cols > operator/ (const WGenericMatrix< T, Rows, Cols > &m, const T &factor)
 Divide every element in the matrix by the given factor.
 
template<typename T , std::size_t Rows, std::size_t Cols>
WGenericMatrix< T, Rows, Cols > operator+ (const WGenericMatrix< T, Rows, Cols > &l, const WGenericMatrix< T, Rows, Cols > &r)
 Add two matrices together.
 
template<typename T , std::size_t Rows, std::size_t Cols>
WGenericMatrix< T, Rows, Cols > operator- (const WGenericMatrix< T, Rows, Cols > &l, const WGenericMatrix< T, Rows, Cols > &r)
 Substract two matrices.
 
template<typename T , std::size_t Rows, std::size_t Cols>
WGenericMatrix< T, Rows, Cols > operator- (const WGenericMatrix< T, Rows, Cols > &m)
 Negate every element in the matrix.
 
std::u16string toUTF16 (const std::u32string &s)
 Convert a UTF-32 string to UTF-16.
 
std::u32string toUTF32 (const std::u16string &s)
 Convert a UTF-16 string to UTF-32.
 

Variables

static const WFlags< AlignmentFlagAlignHorizontalMask
 Combination of all horizontal alignment flags.
 
static const WFlags< AlignmentFlagAlignVerticalMask
 Combination of all vertical alignment flags.
 
static const WFlags< MatchFlagMatchTypeMask
 Type part of MatchFlags.
 
static const WFlags< ValidationStyleFlagValidationAllStyles = ValidationStyleFlag::InvalidStyle | ValidationStyleFlag::ValidStyle
 All validation styles.
 

Detailed Description

The namespace for Wt.

Typedef Documentation

typedef std::vector<WModelIndex> Wt::WModelIndexList

List of indexes.

The list is defined as std::vector<WModelIndex>.

Enumeration Type Documentation

enum Wt::AlignmentFlag
strong

Enumeration that specifies a horizontal or a vertical alignment.

The vertical alignment flags are AlignmentFlag::Baseline, AlignmentFlag::Sub, AlignmentFlag::super, AlignmentFlag::Top, AlignmentFlag::TextTop, AlignmentFlag::Middle, AlignmentFlag::Bottom and AlignmentFlag::TextBottom.

The horizontal alignment flags are AlignmentFlag::Left, AlignmentFlag::Right, AlignmentFlag::Center and AlignmentFlag::Justify.

When used with setVerticalAlignment(), this applies only to inline widgets and determines how to position itself on the current line, with respect to sibling inline widgets.

When used with WTableCell::setContentAlignment(), this determines the vertical alignment of contents within the table cell.

When used with WPainter::drawText(), this determines the horizontal and vertical alignment of the text with respect to the bounding rectangle.

When used with WContainerWidget::setContentAlignment(), this specifies how contents should be aligned horizontally within the container.

Not all values are applicable in all situations. The most commonly used values are AlignmentFlag::Left, AlignmentFlag::Center, AlignmentFlag::Right, AlignmentFlag::Bottom, AlignmentFlag::Middle and AlignmentFlag::Top.

Enumerator
Left 

Align to the left.

Right 

Align to the right.

Center 

Align horizontally in the center.

Justify 

Justify left and right.

Baseline 

Align at baseline (default alignment).

Sub 

Align below the baseline (as if subscript).

Super 

Align above the baseline (as if superscript).

Top 

Align top of widget with top of tallest sibling widget.

TextTop 

Align top of widget with the top of the parent widget's font.

Middle 

Align vertically the middle to the middle of the parent widget.

Bottom 

Align bottom of widget to the bottom of the lowest sigling widget.

TextBottom 

Align bottom of widget to the bottom of parent widget's font.

enum Wt::AnimationEffect
strong

An enumeration describing an animation effect.

An animation effect can be the combination of a motion and an optional fade effect, e.g:

You can specify only one motion effect.

See also
setEffects()
Enumerator
SlideInFromLeft 

Slides right to show, left to hide.

SlideInFromRight 

Slides left to show, right to hide.

SlideInFromBottom 

Slides up to show, down to hide.

SlideInFromTop 

Slides down to show, up to hide.

Pop 

Pops up to show, pops away to hide.

Fade 

Fade effect.

enum Wt::BootstrapVersion
strong

Enumeration to select a bootstrap version.

See also
setVersion()
Enumerator
v2 

Bootstrap 2.

v3 

Bootstrap 3.

enum Wt::BorderStyle
strong

Enumeration for border style.

Enumerator
None 

No border (width ignored), default.

Hidden 

Invisible border (of specified width).

Dotted 

Dotted border.

Dashed 

Dashed border.

Solid 

Solid border.

Double 

Double lined border.

Groove 

Relief border grooved into the canvas.

Ridge 

Relief border coming out of the canvas.

Inset 

Relief border lowering contents into the canvas.

Outset 

Relief border letting contents come out of the canvas.

enum Wt::BorderWidth
strong

Enumeration for border width.

Enumerator
Thin 

Browser-dependent 'thin' border.

Medium 

Browser-dependent 'medium' border, default.

Thick 

Browser-dependent 'thick' border.

Explicit 

Explicit width. See also explicitWidth()

The calendar header format.

Enumerator
SingleLetterDayNames 

First letter of a day (e.g. 'M' for Monday)

ShortDayNames 

First 3 letters of a day (e.g. 'Mon' for Monday)

LongDayNames 

Full day name.

enum CharEncoding
related

Enumeration that indicates a character encoding.

Character encodings are used to represent characters in a stream of bytes.

enum Wt::CheckState
strong

Enumeration for the check state of a check box.

See also
WCheckBox
Enumerator
Unchecked 

Unchecked.

PartiallyChecked 

Partially checked (for a tri-state checkbox)

Checked 

Checked.

An enumeration for the policy to display the child count.

Enumerator
Disabled 

Do not display a child count.

Enabled 

Always display a child count.

Lazy 

Only display a child count when the node is populated.

Lazy 

Lazy loading: on first use.

Values for the disposition type in the Content-Disposition header.

Enumerator
None 

Do not specify a disposition type.

Attachment 

Open with a helper application or show 'Save As' dialog.

Inline 

View with a browser plugin.

enum Wt::ContentLoading
strong

Enumeration that determines when contents should be loaded.

Enumerator
Lazy 

Lazy loading: on first use.

Eager 

Pre-loading: before first use.

NextLevel 

Pre-load also next level (if applicable, e.g. for WTreeNode)

enum Wt::Cursor
strong

Enumeration for a cursor style.

See also
WCssDecorationStyle::setCursor(), WAbstractArea::setCursor()
Enumerator
Arrow 

Arrow, CSS 'default' cursor.

Auto 

Cursor chosen by the browser, CSS 'auto' cursor.

Cross 

Crosshair, CSS 'cross' cursor.

PointingHand 

Pointing hand, CSS 'pointer' cursor.

OpenHand 

Open hand, CSS 'move' cursor.

Wait 

Wait, CSS 'wait' cursor.

IBeam 

Text edit, CSS 'text' cursor.

WhatsThis 

Help, CSS 'help' cursor.

enum Wt::DialogCode
strong

The result of a modal dialog execution.

Enumerator
Rejected 

Dialog closed with reject()

Accepted 

Dialog closed with accept()

enum Wt::DomElementType
strong

Enumeration for a DOM element type.

For internal use only.

enum Wt::EchoMode
strong

Enumeration that describes how the contents is displayed.

See also
setEchoMode(EchoMode)
Enumerator
Normal 

Characters are shown.

Password 

Hide the contents as for a password.

enum Wt::EditOption
strong

Enumeration that specifies editing options.

See also
setEditOptions()
Enumerator
SingleEditor 

Never show more than one active editor.

MultipleEditors 

Allow multiple editors at the same time.

SaveWhenClosed 

Always save the current edit value when closing.

LeaveEditorsOpen 

Editors can only be closed using closeEditor()

enum Wt::EditTrigger
strong

Enumeration that specifies the user action that triggers editing.

See also
setEditTriggers(), edit()
Enumerator
None 

Do not allow user to initiate editing.

SingleClicked 

Edit an item when clicked.

DoubleClicked 

Edit an item when double clicked.

SelectedClicked 

Edit a selected item that is clicked again.

Enumeration for the role of a DOM element (for theme support)

See also
WTheme::apply()
enum Wt::EntryPointType
strong

Enumeration that indicates a Wt entrypoint type.

An entry point binds a behavior to a public URL. Only the wthttpd connector currently supports multiple entry points.

Enumerator
Application 

Specifies a full-screen application.

A full screen application manages the entire browser window and provides its own HTML page.

See also
WServer::addEntryPoint(), WApplication::root()
WidgetSet 

Specifies an application that manages one or more widgets.

A widget set application is part of an existing HTML page. One or more HTML elements in that web page may be bound to widgets managed by the application.

The application presents itself as a JavaScript file, and therefore should be embedded in the web page using a <script> tag, from within the <body> (since it needs access to the <body>).

Note
A EntryPointType::WidgetSet application requires JavaScript support
See also
WServer::addEntryPoint(), WApplication::bindWidget()
StaticResource 

Specifies a static resource.

A static resource binds a WResource to a public URL, and is not bound to a specific session.

See also
WServer::addResource()
enum Wt::EventType
strong

An enumeration describing an event's type.

See also
WEvent::eventType()
Enumerator
Other 

An event which is not user- or timer-initiated.

User 

A user-initiated event.

Timer 

A timer-initiated event.

Resource 

An event which is a resource request.

enum Wt::FontFamily
strong

The generic font family.

Enumerator
Default 

Browser-dependent default.

Serif 

for example: Times

SansSerif 

for example: Helvetica

Cursive 

for example: Zapf-Chancery

Fantasy 

for example: Western

Monospace 

for example: Courier

enum Wt::FontSize
strong

The font size.

Enumerator
XXSmall 

Extra Extra small.

XSmall 

Extra small.

Small 

Small.

Medium 

Medium, default.

Large 

Large.

XLarge 

Extra large.

XXLarge 

Extra Extra large.

Smaller 

Relatively smaller than the parent widget.

Larger 

Relatively larger than the parent widget.

FixedSize 

Explicit size, See also fontFixedSize()

enum Wt::FontStyle
strong

The font style.

Enumerator
Normal 

Normal (default)

Italic 

Italic.

Oblique 

Oblique.

enum Wt::FontVariant
strong

The font variant.

Enumerator
Normal 

Normal (default)

SmallCaps 

Small Capitals.

enum Wt::FontWeight
strong

The font weight.

Enumerator
Normal 

Normal (default) (Value == 400)

Bold 

Bold (Value == 700)

Bolder 

Bolder than the parent widget.

Lighter 

Lighter than the parent widget.

Value 

Specify a value (100 - 900)

Specifies what GL function needs to be updated.

Enumerator
PAINT_GL 

refresh paintGL()

RESIZE_GL 

refresh resizeGL()

UPDATE_GL 

refresh updateGL()

enum Wt::GLRenderOption
strong

Enumeration for render options.

See also
setRenderOptions()
Enumerator
ClientSide 

Enables client-side rendering.

ServerSide 

Enables server-side rendering.

AntiAliasing 

Enables anti-aliasing.

enum Wt::GoogleMapsVersion
strong
Enumerator
v2 

API Version 2.x.

v3 

API Version 3.x.

enum Wt::HtmlContentType
strong

Enumeration for HTML content type.

Enumerator
XHTML1 

XHTML1.x.

HTML4 

HTML4.

HTML5 

HTML5.

enum Wt::Icon
strong

Enumeration that indiciates a standard icon.

See also
WMessageBox
Enumerator
None 

No icon.

Information 

An information icon.

Warning 

A warning icon.

Critical 

A critical icon.

Question 

A question icon.

enum Wt::InputMaskFlag
strong

Enumeration that describes options for input masks.

See also
setInputMask()
Enumerator
KeepMaskWhileBlurred 

Keep the input mask when blurred.

enum Wt::LayoutDirection
strong

An enumeration describing a layout direction.

Enumerator
LeftToRight 

Left-to-Right layout.

RightToLeft 

Right-to-left layout.

TopToBottom 

Top-to-bottom layout.

BottomToTop 

Bottom-to-top layout.

Enumeration to indicate which layout implementation to use.

See also
WLayout::setPreferredImplementation()
Enumerator
Flex 

Use CSS flex layout (if supported by the browser)

JavaScript 

Uses the classic JavaScript-based method. In some cases flex layout may fail when nesting multiple layouts, so this method can be used instead.

enum Wt::LayoutPosition
strong

Enumeration of possible positions in the layout.

Enumerator
North 

North (top)

East 

East (right)

South 

South (bottom)

West 

West (left)

Center 

Center.

enum Wt::LengthUnit
strong

CSS length unit type.

Enumerator
FontEm 

The relative font size.

FontEx 

The height of an 'x' in the font.

Pixel 

Pixel, relative to canvas resolution.

Inch 

Inch.

Centimeter 

Centimeter.

Millimeter 

Millimeter.

Point 

Point (1/72 Inch)

Pica 

Pica (12 Point)

Percentage 

Percentage (meaning context-sensitive)

enum Wt::LinkTarget
strong

Enumeration that specifies where the target of an anchor should be displayed.

See also
WAnchor::setTarget()
Enumerator
Self 

Show Instead of the application.

ThisWindow 

Show in the top level frame of the application window.

NewWindow 

Show in a separate new tab or window.

Download 

Useful only for a downloadable resource.

enum Wt::LinkType
strong

An enumeration for a link type.

See also
type()
Enumerator
Url 

A static URL.

Resource 

A dynamic resource.

InternalPath 

An internal path.

enum Wt::MapTypeControl
strong
Enumerator
None 

Show no maptype control.

Default 

Show the default maptype control.

Menu 

Show the dropdown menu maptype control.

Hierarchical 

Show the hierarchical maptype control.

HorizontalBar 

Show the horizontal bar maptype control.

enum Wt::MediaEncoding
strong

An enumeration for a media encoding.

See also
addSource()
http://www.jplayer.org/latest/developer-guide/#jPlayer-media-encoding
Enumerator
PosterImage 

The poster image (e.g. JPG/PNG) for a video.

MP3 

Audio: MP3 encoding (essential audio format)

M4A 

Audio: MP4 encoding (essential audio format)

OGA 

Audio: OGG encoding.

WAV 

Audio: WAV (uncompressed) format.

WEBMA 

Audio: WebM encoding.

FLA 

Audio: Flash format.

M4V 

Video: MP4 encoding (essential video format)

OGV 

Video: OGG encoding.

WEBMV 

Video: WebM encoding.

FLV 

Video: Flash format.

An enumeration for a button function.

See also
setButton(), button()
Enumerator
VideoPlay 

Play button which overlays the video (for Video only)

Play 

Play button, is hidden while playing.

Pause 

Pause button, is hidden while paused.

Stop 

Stop button.

VolumeMute 

Volume mute button.

VolumeUnmute 

Volume unmute button.

VolumeMax 

Volume max button.

FullScreen 

Toggle button for full screen, is hidden while full screen (for Video only)

RestoreScreen 

Toggle button to restore the screen, is shown only in full screen (for Video only)

RepeatOn 

Toggle button to enable looping, is hidden while repeating is on

RepeatOff 

Toggle button to disable looping, is hidden while repeat is off

An enumeration for a progressbar function.

See also
setProgressBar(), progressBar()
Enumerator
Time 

The time bar.

Volume 

The volume bar.

enum Wt::MediaPlayerTextId
strong

An enumeration for a text.

See also
setText(), text()
Enumerator
CurrentTime 

Displays the current time.

Duration 

Displays the total duration.

Title 

Displays the title set in setTitle()

enum Wt::MediaPreloadMode
strong

Enumeration for preload strategy.

Enumerator
None 

Hints that the user will probably not play the video.

Auto 

Hints that it is ok to download the entire resource.

Metadata 

Hints that retrieving metadata is a good option.

enum Wt::MediaReadyState
strong

Enumeration that indicates how much of (a media) is loaded.

Enumerator
HaveNothing 

No information available.

HaveMetaData 

Metadata loaded: duration, width, height.

HaveCurrentData 

Data at playback position is available.

HaveFutureData 

Have data to play for a while.

HaveEnoughData 

Enough to reach the end without stalling.

enum Wt::MediaType
strong

An enumeration for a media type.

Enumerator
Audio 

Defines an audio player.

Video 

Defines a video player.

enum Wt::MetaHeaderType
strong

Enumeration that indicates a meta header type.

See also
WApplication::addMetaHeader()
Enumerator
Meta 

Of the form <meta name=... content=... >.

Property 

Of the form <meta property=... content=... >.

HttpHeader 

Of the form <meta http-equiv=... content=... >.

enum Wt::MouseButton
strong

Enumeration for the mouse button.

Enumerator
None 

No button.

Left 

Left button.

Middle 

Middle button.

Right 

Right button.

enum Wt::Orientation
strong

Enumeration that indicates a direction.

Enumerator
Horizontal 

Horizontal.

Vertical 

Vertical.

enum Wt::Overflow
strong

How to handle overflow of inner content.

Enumerator
Visible 

Show content that overflows.

Auto 

Show scrollbars when needed.

Hidden 

Hide content that overflows.

Scroll 

Always show scroll bars.

Enumeration to indicate paint device features.

See also
features()
Enumerator
WordWrap 

Implements drawText() with Wt::TextFlag::WordWrap.

FontMetrics 

Implements fontMetrics() and measureText()

enum Wt::PainterChangeFlag
strong

Enumeration to communicate painter state changes.

See also
setChanged(WFlags<ChangeFlag>)
Enumerator
Pen 

Properties of the pen have changed.

Brush 

Properties of the brush have changed.

Font 

Properties of the font have changed.

Hints 

Some render hints have changed.

Transform 

The transformation has changed.

Clipping 

The clipping has changed.

Shadow 

Properties of the shadow have changed.

enum Wt::PaintFlag
strong

Enumeration that indicates how to change a selection.

See also
WPaintedWidget::update(), WPaintDevice::paintFlags()
Enumerator
Update 

The canvas is not cleared, but further painted on.

enum Wt::PlayerOption
strong

Enumeration for playback options.

Enumerator
Autoplay 

Start playing as soon as the video is loaded.

Loop 

Enable loop mode.

Controls 

Show video controls in the browser.

enum Wt::PopupTrigger
strong

Enumeration that defines a trigger for showing the popup.

See also
forEdit()
Enumerator
Editing 

Shows popup when the user starts editing.

The popup is shown when the currently edited text has a length longer than the filter length.

DropDownIcon 

Shows popup when user clicks a drop down icon.

The lineedit is modified to show a drop down icon, and clicking the icon shows the suggestions, very much like a WComboCox. line edit.

enum Wt::PositionScheme
strong

Enumeration that specifies a layout mechanism for a widget.

The layout mechanism determines how the widget positions itself relative to the parent or sibling widgets.

See also
WWidget::setPositionScheme(PositionScheme scheme)
Enumerator
Static 

Static position scheme.

The widget is layed-out with other PositionScheme::Static and PositionScheme::Relative sibling widgets, one after another.

Inline widgets are layed out in horizontal lines (like text), wrapping around at the end of the line to continue on the next line. Block widgets are stacked vertically.

PositionScheme::Static widgets may also float to the left or right border, using setFloatSide().

Relative 

Relative position scheme.

The widget is first layed out according to PositionScheme::Static layout rules, but after layout, the widget may be offset relative to where it would be in a static layout, using setOffsets().

Another common use of a PositionScheme::Relative position scheme (even with no specified offsets) is to provide a new reference coordinate system for Absolutely positioned widgets.

Absolute 

Absolute position scheme.

The widget is positioned at an absolute position with respect to the nearest ancestor widget that is either:

Fixed 

Fixed position scheme.

The widget is positioned at fixed position with respect to the browser's view-pane.

enum Wt::Property
strong

Enumeration for a DOM property.

This is an internal API, subject to change.

enum Wt::RenderHint
strong

Enumeration for render hints.

Enumerator
Antialiasing 

Antialiasing.

LowQualityShadows 

Use low-quality shadows (applies only to VML)

enum Wt::RenderMethod
strong

Enumeration that indicates a client-side rendering method for a painted widget.

See also
WPaintedWidget
Enumerator
InlineSvgVml 

SVG (Most browsers) or VML (Internet Explorer < 9) embedded in the page.

HtmlCanvas 

The HTML5 canvas element.

PngImage 

Using a PNG image resource.

enum Wt::ScrollHint
strong

Enumeration that specifies a scrolling option.

See also
scrollTo()
Enumerator
EnsureVisible 

Scrolls minimally to make it visible.

PositionAtTop 

Positions the item at the top of the viewport.

PositionAtBottom 

Positions the item at the bottom of the viewport.

PositionAtCenter 

Positions the item at the center of the viewport.

The segment type

Enumerator
MoveTo 

moveTo segment

LineTo 

lineTo segment

CubicC1 

first control point of cubic bezier curve.

Always followed by a CubicC2 and CubicEnd segment

CubicC2 

second control point of cubic bezier curve

Always followed by a CubicEnd segment

CubicEnd 

end point of cubic bezier curve

QuadC 

control point of quadratic bezier curve

QuadEnd 

end point of quadratic bezier curve

ArcC 

center of an arc

Always followed by an ArcR and ArcAngleSweep segment

ArcR 

radius of an arc Always followed by an ArcAngleSweep segment

ArcAngleSweep 

the sweep of an arc

x = startAngle, y = spanAngle

enum Wt::SelectionBehavior
strong

Enumeration that indicates what is being selected.

See also
WTreeView::setSelectionBehavior()
Enumerator
Items 

SelectionFlag::Select single items.

Rows 

SelectionFlag::Select only rows.

enum Wt::SelectionFlag
strong

Enumeration that indicates how to change a selection.

See also
WTreeView::select()
Enumerator
Select 

Add to selection.

Deselect 

Remove from selection.

ToggleSelect 

Toggle in selection.

ClearAndSelect 

Clear selection and add single item.

enum Wt::SelectionMode
strong

Enumeration that indicates how items may be selected.

See also
WTreeView::setSelectionMode()
Enumerator
None 

No selections.

Single 

Single selection only.

Extended 

Multiple selection.

enum Wt::Side
strong
enum Wt::StandardButton
strong

Enumeration that indicates a standard button.

Multiple buttons may be specified by logically or'ing these values together, e.g.

See also
WMessageBox
Enumerator
None 

No button.

Ok 

An OK button.

Cancel 

A Cancel button.

Yes 

A Yes button.

No 

A No button.

Abort 

An Abort button.

Retry 

A Retry button.

Ignore 

An Ignore button.

YesAll 

A Yes-to-All button.

NoAll 

A No-to-All button.

Enumeration that indicates how a widget's ID may be set.

See also
setWidgetIdMode()
Enumerator
None 

Do not set the widget ID.

SetObjectName 

Use setObjectName() to prefix the ID with the varName. This is a safe choice since Wt still guarantees that the IDs are unique.

SetId 

Use setId() to set the ID as the varName.

Warning
You must be careful that there are no two widgets with the same ID in yor application.
enum Wt::TextDecoration
strong

Text decoration options.

Enumerator
Underline 

Underline.

Overline 

Overline.

LineThrough 

LineThrough.

Blink 

Blink.

enum Wt::TextFlag
strong

Enumeration that specifies the way text should be printed.

See also
WPainter::drawText(const WRectF& rect, WFlags<AlignmentFlag> alignmentFlags, TextFlag textFlag, const WString& text)
Enumerator
SingleLine 

Text will be printed on just one line.

WordWrap 

Lines will break at word boundaries.

enum Wt::TextFormat
strong

Enumeration that indicates the text format.

See also
WText::setTextFormat()
Enumerator
XHTML 

Format text as XSS-safe XHTML markup'ed text.

UnsafeXHTML 

Format text as XHTML markup'ed text.

Plain 

Format text as plain text.

enum Wt::TimingFunction
strong

A timing function.

The timing function defines how the animation effects are animated during the total duration of the animation.

Enumerator
Ease 

Slow start and slow finish.

Linear 

Linear throughout.

EaseIn 

Slow start.

EaseOut 

Slow finish.

EaseInOut 

Slow start and even slower finish.

CubicBezier 

(Currently unsupported)

enum Wt::UserAgent
strong

An enumeration type for specific user agent.

See also
agent()
Enumerator
Unknown 

Unknown user agent.

IEMobile 

Internet Explorer Mobile, 5 or older.

IE6 

Internet Explorer 6.

IE7 

Internet Explorer 7.

IE8 

Internet Explorer 8.

IE9 

Internet Explorer 9.

IE10 

Internet Explorer 10.

IE11 

Internet Explorer 11.

Edge 

Edge.

Opera 

Opera.

Opera10 

Opera 10 or later.

WebKit 

WebKit.

Safari 

Safari 2 or older.

Safari3 

Safari 3.

Safari4 

Safari 4 or later.

Chrome0 

Chrome 0.

Chrome1 

Chrome 1.

Chrome2 

Chrome 2.

Chrome3 

Chrome 3.

Chrome4 

Chrome 4.

Chrome5 

Chrome 5 or later.

Arora 

Arora.

MobileWebKit 

Mobile WebKit.

MobileWebKitiPhone 

Mobile WebKit iPhone/iPad.

MobileWebKitAndroid 

Mobile WebKit Android.

Konqueror 

Konqueror.

Gecko 

Gecko.

Firefox 

Firefox 2 or older.

Firefox3_0 

Firefox 3.0.

Firefox3_1 

Firefox 3.1.

Firefox3_1b 

Firefox 3.1b.

Firefox3_5 

Firefox 3.5.

Firefox3_6 

Firefox 3.6.

Firefox4_0 

Firefox 4.0.

Firefox5_0 

Firefox 5.0 or later.

BotAgent 

Bot user agent.

Enumeration for the role of a css class (for theme support)

See also
WTheme::utilityCssClass()
enum Wt::ValidationState
strong

The state in which validated input can exist.

Enumerator
Invalid 

The input is invalid.

InvalidEmpty 

The input is invalid (empty and mandatory).

Valid 

The input is valid.

Enumeration that indicates what validation styles are to be applie.

See also
WTheme::applyValidationStyle()

Enumeration that specifies an option for rendering a view item.

See also
WAbstractItemDelegate::update()
Enumerator
Selected 

Render as selected

Editing 

Render in editing mode

Focused 

Render (the editor) focused

Invalid 

Render as invalid

Enumeration for the role of a subwidget (for theme support)

See also
WTheme::apply()

Generated on Thu Oct 19 2017 for the C++ Web Toolkit (Wt) by doxygen 1.8.11