Wt Namespace Reference

The namespace for Wt. More...


Classes

class  WAbstractArea
 Abstract base class for interactive areas in a widget. More...
class  WAbstractItemModel
 An abstract table-like model for use with Wt's view classes. More...
class  WAbstractToggleButton
 An abstract base class for radio buttons and check boxes. More...
class  WAccordionLayout
 A layout manager which shows one item at a time. More...
class  WAnchor
 A widget that represents an HTML anchor (to link to other documents). More...
class  WApplication
 A class that represents an instance of a Wt Application, corresponding to a single session. More...
class  WBorder
 A style class for the border 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
 Class that defines the style for filling areas. 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 circular interactive area in a widget. More...
class  WColor
 A class that specifies a color. 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  WCssStyleSheet
 A CSS style sheet. More...
class  InvalidDateException
 Exception thrown when calculating with an invalid date. More...
class  WDate
 A gregorian calendar date. More...
class  WDatePicker
 A date picker. More...
class  WDateValidator
 A validator for date strings. More...
class  WDefaultLayout
 A default layout manager. More...
class  WDialog
 A WDialog emulates a modal window. More...
class  WDoubleValidator
 A validator for validating floating point user input. More...
class  WEnvironment
 A class that captures information on the application environment. More...
class  WMouseEvent
 A class providing details for a mouse event. More...
class  WKeyEvent
 A class providing details for a keyboard event. More...
class  WDropEvent
 A class providing details for a drop event. More...
class  WFileResource
 A Resource which streams 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  WFont
 A style class describing a font. More...
class  WFormWidget
 A widget that correspond to an HTML form element. 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 items depending on its state. More...
class  WImage
 A widget that displays an image. More...
class  WInPlaceEdit
 A widget that provides in-place-editable text. More...
class  WInteractWidget
 A widget that can receive user-interface interaction. More...
class  WIntValidator
 A validator that validates integer user input. 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  WLabel
 A widget that may act as a label corresponding to a form field. More...
class  WLayout
 An abstract base class for 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 class that specifies a 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  WLocalizedStrings
 An abstract class that provides support for localized strings. More...
class  WLogger
 A text stream logging class. More...
class  WLogEntry
 A stream-like object for creatin an entry in a log file. 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
 An index to a data item of a data model. More...
class  WObject
 A base class for objects that participate in the signal/slot system. 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
 Helper class for painting on a WPaintDevice. More...
class  WPainterPath
 Helper class for composing a (complex) path. More...
class  WPanel
 A WPanel provides a container which may be manipulated. More...
class  WPen
 Class that defines the style for pen strokes. More...
class  WPoint
 Utility class that defines a 2D point. More...
class  WPointF
 Utility class that defines a 2D point. More...
class  WPolygonArea
 An interactive area in a widget, specified by a polygon. More...
class  WPushButton
 A widget that represents a push button. More...
class  WRadioButton
 A user control that represents a radio button. More...
class  WRectArea
 A rectangular interactive area in a widget. More...
class  WRectF
 Utility 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  WScrollArea
 A widget that adds scrolling capabilities to its content. More...
class  WScrollBar
 A scrollbar attached to a scroll area. More...
class  WSelectionBox
 A selection box allows selection from a list of options. More...
class  WServer
 A class encapsulating an application server. More...
class  Signal
 A signal that propagates events to listeners. More...
class  EventSignal
 A signal that conveys user-interface events. More...
class  WSignalMapper
 A utility class to connect multiple senders to a single slot. More...
class  WSlider
 A horizontal or vertical slider control. More...
class  WSocketNotifier
 A utility class for asynchronous notification of socket activity. More...
class  WStackedWidget
 A container widget that stacks its widgets on top of each other. More...
class  WStandardItemModel
 A standard data model, which stores data in memory. More...
class  WString
 A unicode string class, with support for localization. More...
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 column in a WTable. More...
class  WTableRow
 A row in a WTable. More...
class  WTabWidget
 A widget that organizes contents in tab panes. 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  WTimer
 A utility class which provides timer signals and single-shot timers. More...
class  WTransform
 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  WValidationStatus
 A widget that keeps track of the validation status of a form widget. 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  WViewWidget
 An abstract base class for a MVC view that is rendered using a widget. More...
class  WStaticModelView
 A widget that implements a view for a non-changing model. 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
 A WWidget is the abstract base class for any Wt widget. More...
class  WWidgetItem
 A layout item that holds a single widget. More...

Namespaces

namespace  Chart
 Namespace for the Chart library.
namespace  Ext
 Namespace for Ext widgets.

Enumerations

enum  MatchFlags {
  MatchExactly = 0, MatchStringExactly = 1, MatchStartsWith = 2, MatchEndsWith = 3,
  MatchRegExp = 4, MatchWildCard = 5, MatchCaseSensitive = 0x10, MatchWrap = 0x20
}
 Flags that specify how to match two values. More...
enum  AnchorTarget { TargetSelf, TargetThisWindow, TargetNewWindow }
 Enumeration that specifies where the target of an anchor should be displayed. More...
enum  WBrushStyle { NoBrush = 0, SolidPattern = 1 }
 Enumeration that indicates a fill style. More...
enum  GlobalColor {
  white, black, red, darkRed,
  green, darkGreen, blue, darkBlue,
  cyan, darkCyan, magenta, darkMagenta,
  yellow, darkYellow, gray, darkGray,
  lightGray, transparent
}
 Predefined colors. More...
enum  KeyboardModifier {
  NoModifier = 0, ShiftModifier = 0x1, ControlModifier = 0x2, AltModifier = 0x4,
  MetaModifier = 0x8
}
 Enumeration flags for keyboard modifiers. More...
enum  Key {
  Key_unknown = 0, Key_Enter = 13, Key_Tab = 9, Key_Backspace = 8,
  Key_Shift = 16, Key_Control = 17, Key_Alt = 18, Key_PageUp = 33,
  Key_PageDown = 34, Key_End = 35, Key_Home = 36, Key_Left = 37,
  Key_Up = 38, Key_Right = 39, Key_Down = 40, Key_Insert = 45,
  Key_Delete = 46, Key_Escape = 27, Key_F1 = 112, Key_F2 = 113,
  Key_F3 = 114, Key_F4 = 115, Key_F5 = 116, Key_F6 = 117,
  Key_F7 = 118, Key_F8 = 119, Key_F9 = 120, Key_F10 = 121,
  Key_F11 = 122, Key_F12 = 123, Key_Space = ' ', Key_A = 'A',
  Key_B = 'B', Key_C = 'C', Key_D = 'D', Key_E = 'E',
  Key_F = 'F', Key_G = 'G', Key_H = 'H', Key_I = 'I',
  Key_J = 'J', Key_K = 'K', Key_L = 'L', Key_M = 'M',
  Key_N = 'N', Key_O = 'O', Key_P = 'P', Key_Q = 'Q',
  Key_R = 'R', Key_S = 'S', Key_T = 'T', Key_U = 'U',
  Key_V = 'V', Key_W = 'W', Key_X = 'X', Key_Y = 'Y',
  Key_Z = 'Z'
}
 Enumeration for key codes. More...
enum  PenStyle {
  NoPen = 0x0, SolidLine = 0x1, DashLine = 0x2, DotLine = 0x3,
  DashDotLine = 0x4, DashDotDotLine = 0x5
}
 Enumeration that indicates a pen style. More...
enum  PenCapStyle { FlatCap = 0x00, SquareCap = 0x10, RoundCap = 0x20 }
 Enumeration that indicates how line end points are rendered. More...
enum  PenJoinStyle { MiterJoin = 0x00, BevelJoin = 0x40, RoundJoin = 0x80 }
 Enumeration that indicates how line joins are rendered. More...
enum  CharEncoding { LocalEncoding, UTF8 }
 Enumeration that indicates a character encoding. More...
enum  TextFormat { XHTMLText, XHTMLUnsafeText, PlainText }
 Enumeration that indicates the text format. More...
enum  Orientation { Horizontal = 0x1, Vertical = 0x2 }
 Enumeration that indicates a direction. More...
enum  StandardButton {
  NoButton = 0x00, Ok = 0x01, Cancel = 0x02, Yes = 0x04,
  No = 0x08, Abort = 0x10, Retry = 0x20, Ignore = 0x40,
  YesAll = 0x80, NoAll = 0x100
}
 Enumeration that indicates a standard button for a message box. More...
enum  Icon {
  NoIcon = 0, Information = 1, Warning = 2, Critical = 3,
  Question = 4
}
 Enumeration that indiciates a standard icon for a message box. More...
enum  SelectionMode { NoSelection = 0, SingleSelection = 1, ExtendedSelection = 3 }
 Enumeration that indicates how items may be selected. More...
enum  SelectionBehavior { SelectItems = 0, SelectRows = 1 }
 Enumeration that indicates what is being selected. More...
enum  SelectionUnit { CellSelection = 0, RowSelection = 1 }
 Enumeration that indicates what is the selection unit (deprecated). More...
enum  Side {
  None = 0x0, Top = 0x1, Bottom = 0x2, Left = 0x4,
  Right = 0x8, CenterX = 0x10, CenterY = 0x20, CenterXY = (CenterX | CenterY),
  Verticals = (Left | Right), Horizontals = (Top | Bottom), All = (Top | Bottom | Left | Right)
}
 Enumeration that designates a relative location. More...
enum  VerticalAlignment {
  AlignBaseline = 0x0, AlignSub = 0x10, AlignSuper = 0x20, AlignTop = 0x30,
  AlignTextTop = 0x40, AlignMiddle = 0x50, AlignBottom = 0x60, AlignTextBottom = 0x70
}
 Enumeration that specifies a vertical alignment. More...
enum  HorizontalAlignment { AlignLeft = 0x1, AlignRight = 0x2, AlignCenter = 0x3, AlignJustify = 0x4 }
 Enumeration that specifies a horizontal alignment. More...
enum  PositionScheme { Static, Relative, Absolute, Fixed }
 Enumeration that specifies a layout mechanism for a widget. More...
enum  Cursor {
  ArrowCursor, AutoCursor, CrossCursor, PointingHandCursor,
  OpenHandCursor, WaitCursor, IBeamCursor, WhatsThisCursor
}
 Cursor style. More...


Detailed Description

The namespace for Wt.

Enumeration Type Documentation

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

Enumerator:
TargetSelf  Show Instead of the application.
TargetThisWindow  Show in the top level frame of the application window.
TargetNewWindow  Show in a separate new tab or window.

enum CharEncoding [related, inherited]

Enumeration that indicates a character encoding.

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

Enumerator:
LocalEncoding  Each byte represents a character, using the local server-side system locale.
UTF8  The byte stream represents unicode characters encoded using UTF-8.

enum Wt::Cursor

Cursor style.

See also:
WCssDecorationStyle::setCursor(), WImageArea::setCursor()
Enumerator:
ArrowCursor  Arrow, CSS 'default' cursor.
AutoCursor  Cursor chosen by the browser, CSS 'auto' cursor.
CrossCursor  Crosshair, CSS 'cross' cursor.
PointingHandCursor  Pointing hand, CSS 'pointer' cursor.
OpenHandCursor  Open hand, CSS 'move' cursor.
WaitCursor  Wait, CSS 'wait' cursor.
IBeamCursor  Text edit, CSS 'text' cursor.
WhatsThisCursor  Help, CSS 'help' cursor.

Enumeration that specifies a horizontal alignment.

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

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

Not all values are applicable in all situations. The most commonly used values are AlignLeft, AlignCenter and AlignRight.

Enumerator:
AlignLeft  Align children to the left.
AlignRight  Align children to the right.
AlignCenter  Align children to the center.
AlignJustify  Justify children left and right.

enum Wt::Icon

Enumeration that indiciates a standard icon for a message box.

Enumerator:
NoIcon  No icon.
Information  An information icon (not implemented).
Warning  An warning icon (not implemented).
Critical  An critical icon (not implemented).
Question  An question icon (not implemented).

Flags that specify how to match two values.

Except when MatchExactly, the lexical matching is done (by comparing string representations of the value with the query). This is by default case insensitive, unless MatchCaseSensitive is OR'ed.

Enumerator:
MatchExactly  Same type and value.
MatchStringExactly  Lexical match.
MatchStartsWith  Match start with query.
MatchEndsWith  Match end with query.
MatchRegExp  Regular expression match.
MatchWildCard  Wildcard match.
MatchCaseSensitive  Case sensitive.
MatchWrap  Wrap around whole model.

Enumeration that indicates a direction.

Enumerator:
Horizontal  Horizontal.
Vertical  Vertical.

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:
setPositionScheme(PositionScheme scheme)
Enumerator:
Static  Static position scheme.

The widget is layed-out with other Static and 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. Stacked widgets are stacked vertically.

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

Enumeration that indicates what is being selected.

Enumerator:
SelectItems  Select single items.
SelectRows  Select only rows.

Enumeration that indicates how items may be selected.

Enumerator:
NoSelection  No selections.
SingleSelection  Single selection only.
ExtendedSelection  Multiple selection.

Enumeration that indicates what is the selection unit (deprecated).

Deprecated:
Use SelectionBehavior instead.
Enumerator:
CellSelection  Select inividual cells.
RowSelection  Select whole rows.

enum Wt::Side

Enumeration that designates a relative location.

Values of CenterX, CenterY, and CenterXY are only valid for WCssDecorationStyle::setBackgroundImage()

See also:
setMargin(const WLength& x, int sides), setOffsets(const WLength& x, int sides)

setFloatSide(Side s), setClearSides(int sides)

WContainerWidget::setPadding(const WLength& x, int sides)

WCssDecorationStyle::setBackgroundImage()

Enumerator:
None  No side.
Top  Top side.
Bottom  Bottom side.
Left  Left side.
Right  Right side.
CenterX  Center horiziontally.
CenterY  Center vertically.
CenterXY  (CenterX | CenterY)
Verticals  (Left | Right)
Horizontals  (Top | Bottom)
All  All sides.

Enumeration that indicates a standard button for a message box.

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

Enumerator:
NoButton  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 the text format.

See also:
WText::setTextFormat()
Enumerator:
XHTMLText  Format text as XSS-safe XHTML markup'ed text.
XHTMLUnsafeText  Format text as XHTML markup'ed text.
PlainText  Format text as plain text.

Enumeration that specifies a vertical alignment.

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 vertical alignment of the text with respect to the bounding rectangle.

Not all values are applicable in all situations. The most commonly used values are AlignBottom, AlignMiddle and AlignTop.

Enumerator:
AlignBaseline  Align at baseline (default alignment).
AlignSub  Align below the baseline (as if subscript).
AlignSuper  Align above the baseline (as if superscript).
AlignTop  Align top of widget with top of tallest sibling widget.
AlignTextTop  Align top of widget with the top of the parent widget's font.
AlignMiddle  Align the middle to the middle of the parent widget.
AlignBottom  Align bottom of widget to the bottom of the lowest sigling widget.
AlignTextBottom  Align bottom of widget to the bottom of parent widget's font.


Generated on Fri Sep 12 17:01:14 2008 for Wt by doxygen 1.5.6