Wt Namespace Reference

A namespace for Wt. More...


Classes

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  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  WColor
 A style class for specifying 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
 An exception that is thrown when trying to calculate 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  WGroupBox
 A widget which group widgets into a frame with a title. 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  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
 A class which manages text messages that may be adapted to the current locale. 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  WPen
 Class that defines the style for pen strokes. More...
class  WPointF
 Utility class that defines a 2D point. More...
class  WPushButton
 A widget that represents a push button. More...
class  WRadioButton
 A user control that represents a radio button. 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  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 (XHMTL) text. More...
class  WTextArea
 A widget that provides a multi-line edit. 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  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  Ext
 A namespace for Wt Ext widgets.

Typedefs

typedef WApplication *(* ApplicationCreator )(const WEnvironment &env)
 Typedef for a function that creates WApplication objects.
typedef WString WMessage
 Deprecated Alias to WString for the depreacated WMessage classes.

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  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  Orientation { Horizontal, Vertical }
 Enumeration that indicates direction. More...
enum  StandardButton {
  NoButton = 0x00, Ok = 0x01, Cancel = 0x02, Yes = 0x04,
  No = 0x08, Abort = 0x10, Retry = 0x20, Ignore = 0x40,
  YesAll = 0x80, NoAll = 0x100
}
 A standard button for the message box. More...
enum  Icon {
  NoIcon = 0, Information = 1, Warning = 2, Critical = 3,
  Question = 4
}
 A standard icon for the 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. More...

Functions

int WTCONNECTOR_API WRun (int argc, char **argv, ApplicationCreator createApplication=0)
 Entry point for a Wt application.
WT_API WString operator+ (const WString &lhs, const WString &rhs)
 Concatenate two WStrings.
WT_API WString operator+ (const WString &lhs, const std::wstring &rhs)
 Conatenate a WString with a C++ wide string.
WT_API WString operator+ (const WString &lhs, const wchar_t *rhs)
 Conatenate a WString with a C wide string.
WT_API WString operator+ (const WString &lhs, const std::string &rhs)
 Conatenate a WStrin with a C++ string.
WT_API WString operator+ (const WString &lhs, const char *rhs)
 Conatenate a WString with a C string.
WT_API WString operator+ (const std::wstring &lhs, const WString &rhs)
 Conatenate a C++ wide string with a WString.
WT_API WString operator+ (const wchar_t *lhs, const WString &rhs)
 Conatenate a C wide string with a WString.
WT_API WString operator+ (const std::string &lhs, const WString &rhs)
 Conatenate a C++ string with a WString.
WT_API WString operator+ (const char *lhs, const WString &rhs)
 Conatenate a C string with a WString.
WT_API bool operator== (const char *lhs, const WString &rhs)
 Compare a C string with a WString.
WT_API bool operator== (const wchar_t *lhs, const WString &rhs)
 Compare a C wide string with a WString.
WT_API bool operator== (const std::string &lhs, const WString &rhs)
 Compare a C++ string with a WString.
WT_API bool operator== (const std::wstring &lhs, const WString &rhs)
 Compare a C++ wide string with a WString.
WT_API bool operator!= (const char *lhs, const WString &rhs)
 Compare a C string with a WString.
WT_API bool operator!= (const wchar_t *lhs, const WString &rhs)
 Compare a C wide string with a WString.
WT_API bool operator!= (const std::string &lhs, const WString &rhs)
 Compare a C++ string with a WString.
WT_API bool operator!= (const std::wstring &lhs, const WString &rhs)
 Compare a C++ wide string with a WString.
WT_API std::wostream & operator<< (std::wostream &lhs, const WString &rhs)
 Output a WString to a C++ wide stream.
WT_API std::ostream & operator<< (std::ostream &lhs, const WString &rhs)
 Output a WString to a C++ stream.
WT_API std::wstring widen (const std::string &s)
 Convert a narrow to a wide string.
WT_API std::string narrow (const std::wstring &s)
 Convert a wide to a narrow string.
WT_API std::wstring fromUTF8 (const std::string &s)
 Decode a UTF8 string a wide string.
WT_API std::string toUTF8 (const std::wstring &s)
 Encode a wide string to UTF8.
template<typename Renderer>
WStaticModelView
< Renderer > * 
makeStaticModel (Renderer f, WContainerWidget *parent=0)
 Wrap a widget into a view with a non-changing model.


Detailed Description

A namespace for Wt.

Typedef Documentation

typedef WApplication*(* Wt::ApplicationCreator)(const WEnvironment &env)

Typedef for a function that creates WApplication objects.

See also:
WRun()

typedef WString Wt::WMessage

Deprecated Alias to WString for the depreacated WMessage classes.

WString provides all the functionality of WMessage, but is used more consistently through the interface everywhere wide character support is needed, instead of previously std::wstring.


Enumeration Type Documentation

enum Wt::AnchorTarget

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 Wt::CharEncoding

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::GlobalColor

Predefined colors.

Enumerator:
white  Color white.
black  Color black.
red  Color red.
darkRed  Color dark red.
green  Color green.
darkGreen  Color dark green.
blue  Color blue.
darkBlue  Color dark blue.
cyan  Color cyan.
darkCyan  Color dark cyan.
magenta  Color magenta.
darkMagenta  Color dark magenta.
yellow  Color yellow.
darkYellow  Color dark yellow.
gray  Color medium gray.
darkGray  Color dark gray.
lightGray  Color light gray.
transparent  Color transparent.

enum Wt::Icon

A standard icon for the 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).

enum Wt::MatchFlags

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.

enum Wt::Orientation

Enumeration that indicates direction.

Enumerator:
Horizontal  Horizontal.
Vertical  Vertical.

enum Wt::PenCapStyle

Enumeration that indicates how line end points are rendered.

Enumerator:
FlatCap  Flat ends.
SquareCap  Square ends (prolongs line with half width).
RoundCap  Round ends (terminates with a half circle).

enum Wt::PenJoinStyle

Enumeration that indicates how line joins are rendered.

Enumerator:
MiterJoin  Pointy joins.
BevelJoin  Squared-off joins.
RoundJoin  Rounded joins.

enum Wt::PenStyle

Enumeration that indicates a pen style.

Enumerator:
NoPen  Do not stroke.
SolidLine  Stroke with a solid line.
DashLine  Stroked with a dashed line.
DotLine  Stroke with a dotted line.
DashDotLine  Stroke with a dash dot line.
DashDotDotLine  Stroke with a dash dot dot line.

enum Wt::SelectionBehavior

Enumeration that indicates what is being selected.

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

enum Wt::SelectionMode

Enumeration that indicates how items may be selected.

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

enum Wt::SelectionUnit

Enumeration that indicates what is the selection unit.

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

enum Wt::StandardButton

A standard button for the 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.

enum Wt::WBrushStyle

Enumeration that indicates a fill style.

Enumerator:
NoBrush  Do not fill.
SolidPattern  Fill with a solid color.


Function Documentation

std::wstring Wt::fromUTF8 ( const std::string &  s  ) 

Decode a UTF8 string a wide string.

Decode a UTF8 string to a wide string. In a UTF8 encoded unicode string, some unicode characters are represented in more than one byte. This method will decode to extract the proper unicode characters from the string. The resulting string may thus be shorter (has less characters) than the original, but does not lead to a loss of information.

See also:
toUTF8(const std::string& s), narrow(const std::wstring&)

template<typename Renderer>
WStaticModelView<Renderer>* Wt::makeStaticModel ( Renderer  f,
WContainerWidget *  parent = 0 
) [inline]

Wrap a widget into a view with a non-changing model.

The ViewRenderer is called without arguments and must return a newly created widget (WWidget *).

See also:
WStaticModelView

std::string Wt::narrow ( const std::wstring &  s  ) 

Convert a wide to a narrow string.

Convert a wide string to a narrow string. This method will not perform any code conversion, it simply represents (as far as possible) the same string with a same number of narrow characters.

In general this will lead to a loss of information. If you wish to preserve all information, you should us toUTF8() instead.

See also:
widen(const std::string&), toUTF8(const std::wstring& s)

std::string Wt::toUTF8 ( const std::wstring &  s  ) 

Encode a wide string to UTF8.

Convert a wide string to UTF8. This method will encode the given wide string in UTF8. This may result in a string that is possibly longer (has more characters), but does not lead to a loss of information.

See also:
fromUTF8(const std::string& s), narrow(const std::wstring&)

std::wstring Wt::widen ( const std::string &  s  ) 

Convert a narrow to a wide string.

Convert a narrow string to a wide string. This method will not perform any code conversion, it simply represents the same string with a same number of wide characters.

See also:
narrow(const std::wstring&), fromUTF8(const std::string& s)

int WTCONNECTOR_API Wt::WRun ( int  argc,
char **  argv,
ApplicationCreator  createApplication = 0 
)

Entry point for a Wt application.

This function must be called in the main of your application. The createApplication parameter is a function pointer that creates a Wt application.


Generated on Mon Apr 14 15:15:00 2008 for Wt by doxygen 1.5.3