Option Class Reference

A clickable option. More...

#include <Option.h>

Inheritance diagram for Option:

Public Member Functions
	Option (const WString &text, WContainerWidget *parent=0)
	Create an Option with the given text. More...
void	setText (const WString &text)
	Change the text. More...
WInteractWidget *	item ()
	Returns the clickable part. More...
virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation())
Public Member Functions inherited from Wt::WContainerWidget
	WContainerWidget (WContainerWidget *parent=0)
	~WContainerWidget ()
void	setLayout (WLayout *layout)
void	setLayout (WLayout *layout, WFlags< AlignmentFlag > alignment)
WLayout *	layout ()
virtual void	addWidget (WWidget *widget)
virtual void	insertBefore (WWidget *widget, WWidget *before)
virtual void	insertWidget (int index, WWidget *widget)
virtual void	removeWidget (WWidget *widget)
virtual void	clear ()
virtual int	indexOf (WWidget *widget) const
virtual WWidget *	widget (int index) const
virtual int	count () const
void	setContentAlignment (WFlags< AlignmentFlag > contentAlignment)
void	setPadding (const WLength &padding, WFlags< Side > sides=All)
WLength	padding (Side side) const
WFlags< AlignmentFlag >	contentAlignment () const
void	setOverflow (Overflow overflow, WFlags< Orientation > orientation=(Horizontal|Vertical))
void	setList (bool list, bool ordered=false)
bool	isList () const
bool	isUnorderedList () const
bool	isOrderedList () const
EventSignal< WScrollEvent > &	scrolled ()
int	scrollTop () const
int	scrollLeft () const
Public Member Functions inherited from Wt::WInteractWidget
	WInteractWidget (WContainerWidget *parent=0)
EventSignal< WKeyEvent > &	keyWentDown ()
EventSignal< WKeyEvent > &	keyPressed ()
EventSignal< WKeyEvent > &	keyWentUp ()
EventSignal &	enterPressed ()
EventSignal &	escapePressed ()
EventSignal< WMouseEvent > &	clicked ()
EventSignal< WMouseEvent > &	doubleClicked ()
EventSignal< WMouseEvent > &	mouseWentDown ()
EventSignal< WMouseEvent > &	mouseWentUp ()
EventSignal< WMouseEvent > &	mouseWentOut ()
EventSignal< WMouseEvent > &	mouseWentOver ()
EventSignal< WMouseEvent > &	mouseMoved ()
EventSignal< WMouseEvent > &	mouseDragged ()
EventSignal< WMouseEvent > &	mouseWheel ()
EventSignal< WTouchEvent > &	touchStarted ()
EventSignal< WTouchEvent > &	touchEnded ()
EventSignal< WTouchEvent > &	touchMoved ()
EventSignal< WGestureEvent > &	gestureStarted ()
EventSignal< WGestureEvent > &	gestureChanged ()
EventSignal< WGestureEvent > &	gestureEnded ()
void	setDraggable (const std::string &mimeType, WWidget *dragWidget=0, bool isDragWidgetOnly=false, WObject *sourceWidget=0)
void	unsetDraggable ()
void	setMouseOverDelay (int delay)
int	mouseOverDelay () const
virtual void	setPopup (bool popup)
virtual void	load ()
virtual bool	isEnabled () const
Public Member Functions inherited from Wt::WWebWidget
	WWebWidget (WContainerWidget *parent=0)
virtual void	setPositionScheme (PositionScheme scheme)
virtual PositionScheme	positionScheme () const
virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=All)
virtual WLength	offset (Side s) const
virtual void	resize (const WLength &width, const WLength &height)
virtual WLength	width () const
virtual WLength	height () const
virtual void	setMinimumSize (const WLength &width, const WLength &height)
virtual WLength	minimumWidth () const
virtual WLength	minimumHeight () const
virtual void	setMaximumSize (const WLength &width, const WLength &height)
virtual WLength	maximumWidth () const
virtual WLength	maximumHeight () const
virtual void	setLineHeight (const WLength &height)
virtual WLength	lineHeight () const
virtual void	setFloatSide (Side s)
virtual Side	floatSide () const
virtual void	setClearSides (WFlags< Side > sides)
virtual WFlags< Side >	clearSides () const
virtual void	setMargin (const WLength &margin, WFlags< Side > sides=All)
virtual WLength	margin (Side side) const
virtual void	setHiddenKeepsGeometry (bool enabled)
virtual bool	hiddenKeepsGeometry () const
virtual bool	isHidden () const
virtual bool	isVisible () const
virtual void	setDisabled (bool disabled)
virtual bool	isDisabled () const
virtual bool	isPopup () const
virtual void	setInline (bool isInline)
virtual bool	isInline () const
virtual void	setDecorationStyle (const WCssDecorationStyle &style)
virtual WCssDecorationStyle &	decorationStyle ()
virtual void	setStyleClass (const WString &styleClass)
virtual WString	styleClass () const
virtual void	addStyleClass (const WString &styleClass, bool force=false)
virtual void	removeStyleClass (const WString &styleClass, bool force=false)
virtual bool	hasStyleClass (const WString &styleClass) const
virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength())
virtual AlignmentFlag	verticalAlignment () const
virtual WLength	verticalAlignmentLength () const
virtual void	setToolTip (const WString &text, TextFormat textFormat=PlainText)
virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)
virtual WString	toolTip () const
virtual void	refresh ()
virtual void	setAttributeValue (const std::string &name, const WString &value)
virtual WString	attributeValue (const std::string &name) const
virtual void	setJavaScriptMember (const std::string &name, const std::string &value)
virtual std::string	javaScriptMember (const std::string &name) const
virtual void	callJavaScriptMember (const std::string &name, const std::string &args)
virtual bool	loaded () const
virtual void	setId (const std::string &id)
virtual WWidget *	find (const std::string &name)
virtual WWidget *	findById (const std::string &id)
virtual void	setSelectable (bool selectable)
virtual void	doJavaScript (const std::string &javascript)
virtual const std::string	id () const
void	setLoadLaterWhenInvisible (bool)
std::string	htmlTagName () const
void	setHtmlTagName (const std::string &tag)
const std::vector< WWidget * > &	children () const
Signal &	childrenChanged ()
virtual void	setCanReceiveFocus (bool enabled)
virtual bool	canReceiveFocus () const
virtual bool	setFirstFocus ()
virtual void	setFocus (bool focus)
virtual bool	hasFocus () const
virtual void	setTabIndex (int index)
virtual int	tabIndex () const
EventSignal &	blurred ()
EventSignal &	focussed ()
virtual bool	scrollVisibilityEnabled () const WT_CXX11ONLY(finaloverride)
virtual void	setScrollVisibilityEnabled (bool enabled) WT_CXX11ONLY(finaloverride)
virtual int	scrollVisibilityMargin () const WT_CXX11ONLY(finaloverride)
virtual void	setScrollVisibilityMargin (int margin) WT_CXX11ONLY(finaloverride)
virtual Signal< bool > &	scrollVisibilityChanged () WT_CXX11ONLY(finaloverride)
virtual bool	isScrollVisible () const WT_CXX11ONLY(finaloverride)
virtual void	setThemeStyleEnabled (bool enabled)
virtual bool	isThemeStyleEnabled () const
Public Member Functions inherited from Wt::WWidget
virtual	~WWidget ()
WWidget *	parent () const
virtual void	removeChild (WObject *child)
void	setWidth (const WLength &width)
void	setHeight (const WLength &height)
virtual void	positionAt (const WWidget *widget, Orientation orientation=Vertical)
virtual void	toggleStyleClass (const WString &styleClass, bool add, bool force=false)
std::string	jsRef () const
void	setFocus ()
virtual void	acceptDrops (const std::string &mimeType, const WString &hoverStyleClass=WString())
virtual void	stopAcceptDrops (const std::string &mimeType)
virtual void	setObjectName (const std::string &name)
virtual void	htmlText (std::ostream &out)
bool	isRendered () const
void	hide ()
void	animateHide (const WAnimation &animation)
void	show ()
void	animateShow (const WAnimation &animation)
void	enable ()
void	disable ()
bool	layoutSizeAware () const
Public Member Functions inherited from Wt::WObject
	WObject (WObject *parent=0)
virtual	~WObject ()
virtual std::string	objectName () const
void	resetLearnedSlots ()
void	resetLearnedSlot (void(T::*method)())
WStatelessSlot *	implementStateless (void(T::*method)())
WStatelessSlot *	implementStateless (void(T::*method)(), void(T::*undoMethod)())
void	isNotStateless ()
WStatelessSlot *	implementJavaScript (void(T::*method)(), const std::string &jsCode)
void	addChild (WObject *child)
const std::vector< WObject * > &	children () const
WObject *	parent () const

Private Member Functions
void	setOptionList (OptionList *l)
void	addSeparator ()
	Create and show the separator. More...
void	showSeparator ()
	Show the separator. More...
void	hideSeparator ()
	Hide the separator. More...

Private Attributes
WText *	option_
	The option command text. More...
WText *	sep_
	The separator '|'. More...
OptionList *	list_
	The list in which this option is managed, if managed. More...

Friends
class	OptionList

Additional Inherited Members
Public Types inherited from Wt::WContainerWidget
enum	Overflow
Public Types inherited from Wt::WObject
typedef void(WObject::*	Method) ()
Static Public Member Functions inherited from Wt::WWebWidget
static WString	escapeText (const WString &text, bool newlinesToo=false)
static std::string &	escapeText (std::string &text, bool newlinestoo=false)
static bool	removeScript (WString &text)
static std::string	jsStringLiteral (const std::string &v, char delimiter= '\'')
Static Public Member Functions inherited from Wt::WWidget
static WString	tr (const char *key)
Public Attributes inherited from Wt::WContainerWidget
	OverflowVisible
	OverflowAuto
	OverflowHidden
	OverflowScroll
Protected Member Functions inherited from Wt::WInteractWidget
virtual void	propagateSetEnabled (bool enabled)
Protected Member Functions inherited from Wt::WWebWidget
virtual void	enableAjax ()
virtual WStatelessSlot *	getStateless (Method method)
virtual void	render (WFlags< RenderFlag > flags)
Protected Member Functions inherited from Wt::WWidget
void	setLayoutSizeAware (bool sizeAware)
virtual void	layoutSizeChanged (int width, int height)
	WWidget (WContainerWidget *parent=0)
virtual void	dropEvent (WDropEvent dropEvent)
virtual int	boxPadding (Orientation orientation) const
virtual int	boxBorder (Orientation orientation) const
void	scheduleRender (WFlags< RepaintFlag > flags=0)
Static Protected Member Functions inherited from Wt::WObject
static WObject *	sender ()

Detailed Description

A clickable option.

This widget is part of the Wt composer example.

On its own, an option is a text which is style "option". An Option may also be used as items in an OptionList.

See also

OptionList

Definition at line 31 of file Option.h.

Constructor & Destructor Documentation

Option::Option	(	const WString &	text,
		WContainerWidget *	parent = 0
	)

Create an Option with the given text.

Definition at line 12 of file Option.C.

  : WContainerWidget(parent),
    sep_(0),
    list_(0)
{
  setInline(true);

  option_ = new WText(text, this);
  option_->setStyleClass("option");
}

Member Function Documentation

void Option::addSeparator ( )

private

Create and show the separator.

Definition at line 33 of file Option.C.

{
  sep_ = new WText("|", this);
  sep_->setStyleClass("sep");
}

void Option::hideSeparator ( )

private

Hide the separator.

Definition at line 39 of file Option.C.

{
  sep_->hide();
}

WInteractWidget* Option::item ( )

inline

Returns the clickable part.

Definition at line 44 of file Option.h.

{ return option_; }

void Option::setHidden ( bool  hidden, const WAnimation &  animation = WAnimation()  )

virtual

Reimplemented from Wt::WWebWidget.

Definition at line 49 of file Option.C.

{
  WContainerWidget::setHidden(hidden, animation);

  if (list_)
    list_->optionVisibilityChanged(this, hidden);
}

void Option::setOptionList ( OptionList *  l )

private

Definition at line 28 of file Option.C.

{
  list_ = l;
}

void Option::setText

(

const WString &

text

)

Change the text.

Definition at line 23 of file Option.C.

{
  option_->setText(text);
}

void Option::showSeparator ( )

private

Show the separator.

Definition at line 44 of file Option.C.

{
  sep_->show();
}

Friends And Related Function Documentation

friend class OptionList

friend

Definition at line 59 of file Option.h.

Member Data Documentation

OptionList* Option::list_

private

The list in which this option is managed, if managed.

Definition at line 57 of file Option.h.

WText* Option::option_

private

The option command text.

Definition at line 51 of file Option.h.

WText* Option::sep_

private

The separator '|'.

Definition at line 54 of file Option.h.

---

The documentation for this class was generated from the following files:

• /home/roel/project/wt/public-git/wt/examples/composer/Option.h
• /home/roel/project/wt/public-git/wt/examples/composer/Option.C