CountDownWidget Class Reference

A widget which displays a decrementing number. More...

#include <CountDownWidget.h>

Inheritance diagram for CountDownWidget:

Public Member Functions
	CountDownWidget (int start, int stop, unsigned msec, WContainerWidget *parent=0)
	Create a new CountDownWidget. More...
Wt::Signal< void > &	done ()
	Signal emitted when the countdown reached stop. More...
void	cancel ()
	Cancel the count down. More...
Public Member Functions inherited from Wt::WWidget
virtual void	setPositionScheme (PositionScheme scheme)=0
virtual PositionScheme	positionScheme () const =0
virtual void	setOffsets (const WLength &offset, WFlags< Side > sides=All)=0
virtual WLength	offset (Side side) const =0
virtual void	resize (const WLength &width, const WLength &height)
virtual WLength	width () const =0
virtual WLength	height () const =0
virtual void	setMinimumSize (const WLength &width, const WLength &height)=0
virtual WLength	minimumWidth () const =0
virtual WLength	minimumHeight () const =0
virtual void	setMaximumSize (const WLength &width, const WLength &height)=0
virtual WLength	maximumWidth () const =0
virtual WLength	maximumHeight () const =0
virtual void	setLineHeight (const WLength &height)=0
virtual WLength	lineHeight () const =0
virtual void	setFloatSide (Side s)=0
virtual Side	floatSide () const =0
virtual void	setClearSides (WFlags< Side > sides)=0
virtual WFlags< Side >	clearSides () const =0
virtual void	setMargin (const WLength &margin, WFlags< Side > sides=All)=0
virtual WLength	margin (Side side) const =0
virtual void	setHiddenKeepsGeometry (bool enabled)=0
virtual bool	hiddenKeepsGeometry () const =0
virtual void	setHidden (bool hidden, const WAnimation &animation=WAnimation())=0
virtual bool	isHidden () const =0
virtual bool	isVisible () const =0
virtual void	setDisabled (bool disabled)=0
virtual bool	isDisabled () const =0
virtual bool	isEnabled () const =0
virtual void	setPopup (bool popup)=0
virtual bool	isPopup () const =0
virtual void	setInline (bool inlined)=0
virtual bool	isInline () const =0
virtual void	setDecorationStyle (const WCssDecorationStyle &style)=0
virtual WCssDecorationStyle &	decorationStyle ()=0
virtual void	setStyleClass (const WString &styleClass)=0
virtual WString	styleClass () const =0
virtual void	addStyleClass (const WString &styleClass, bool force=false)=0
virtual void	removeStyleClass (const WString &styleClass, bool force=false)=0
virtual bool	hasStyleClass (const WString &styleClass) const =0
virtual void	setVerticalAlignment (AlignmentFlag alignment, const WLength &length=WLength::Auto)=0
virtual AlignmentFlag	verticalAlignment () const =0
virtual WLength	verticalAlignmentLength () const =0
virtual void	setToolTip (const WString &text, TextFormat textFormat=PlainText)=0
virtual WString	toolTip () const =0
virtual void	setDeferredToolTip (bool enable, TextFormat textFormat=PlainText)=0
virtual void	refresh ()
virtual void	setAttributeValue (const std::string &name, const WString &value)=0
virtual WString	attributeValue (const std::string &name) const =0
virtual void	setJavaScriptMember (const std::string &name, const std::string &value)=0
virtual std::string	javaScriptMember (const std::string &name) const =0
virtual void	callJavaScriptMember (const std::string &name, const std::string &args)=0
virtual void	load ()=0
virtual bool	loaded () const =0
virtual void	setTabIndex (int index)=0
virtual int	tabIndex () const =0
virtual void	setId (const std::string &id)=0
virtual WWidget *	find (const std::string &name)=0
virtual void	setSelectable (bool selectable)=0
virtual void	doJavaScript (const std::string &js)=0

Private Member Functions
void	timerTick ()
	Process one timer tick. More...

Private Attributes
Wt::Signal< void >	done_
int	start_
int	stop_
int	current_
WTimer *	timer_

Additional Inherited Members
Protected Member Functions inherited from Wt::WWidget
virtual void	enableAjax ()=0
virtual void	propagateSetEnabled (bool enabled)=0
virtual void	render (WFlags< RenderFlag > flags)

Detailed Description

A widget which displays a decrementing number.

Definition at line 25 of file CountDownWidget.h.

Constructor & Destructor Documentation

CountDownWidget::CountDownWidget	(	int	start,
		int	stop,
		unsigned	msec,
		WContainerWidget *	parent = 0
	)

Create a new CountDownWidget.

The widget will count down from start to stop, decrementing the number every msec milliseconds.

Definition at line 12 of file CountDownWidget.C.

  : WText(parent),
    done_(this),
    start_(start),
    stop_(stop)
{
  stop_ = std::min(start_ - 1, stop_);  // stop must be smaller than start
  current_ = start_;

  timer_ = new WTimer(this);
  timer_->setInterval(msec);
  timer_->timeout().connect(this, &CountDownWidget::timerTick);
  timer_->start();

  setText(boost::lexical_cast<std::string>(current_));
}

Member Function Documentation

void CountDownWidget::cancel

(

)

Cancel the count down.

Definition at line 30 of file CountDownWidget.C.

{
  timer_->stop();
}

Wt::Signal<void>& CountDownWidget::done ( )

inline

Signal emitted when the countdown reached stop.

Definition at line 38 of file CountDownWidget.h.

{ return done_; }

void CountDownWidget::timerTick ( )

private

Process one timer tick.

Definition at line 35 of file CountDownWidget.C.

{
  setText(boost::lexical_cast<std::string>(--current_));

  if (current_ <= stop_) {
    timer_->stop();
    done_.emit();
  }
}

Member Data Documentation

int CountDownWidget::current_

private

Definition at line 49 of file CountDownWidget.h.

Wt::Signal<void> CountDownWidget::done_

private

Definition at line 45 of file CountDownWidget.h.

int CountDownWidget::start_

private

Definition at line 46 of file CountDownWidget.h.

int CountDownWidget::stop_

private

Definition at line 47 of file CountDownWidget.h.

WTimer* CountDownWidget::timer_

private

Definition at line 51 of file CountDownWidget.h.

---

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

• /build/witty-HtnADi/witty-3.3.3+dfsg/examples/mission/CountDownWidget.h
• /build/witty-HtnADi/witty-3.3.3+dfsg/examples/mission/CountDownWidget.C