Wt::Timer Class Reference

Timer handles known events that must happen (fairly) regularly. More...

#include <timer.h>

Inheritance diagram for Wt::Timer:

[legend]Collaboration diagram for Wt::Timer:

[legend]List of all members.

Public Types
typedef std::list< Object * >	List
Public Member Functions
	Timer (Object *parent=0, const std::string &name="Timer::anon")
	Create a timer.
bool	isActive () const
int	start (int msec, bool sshot=false)
void	changeInterval (int msec)
void	stop ()
int	timerId () const
Object *	parent () const
const List &	children () const
List &	children ()
bool	isDescendant (const Object *p) const
virtual void	insertChild (Object *obj)
virtual void	removeChild (Object *obj)
void	reparent (Object *new_parent)
template<typename T>
void	deleteFirstChild ()
template<typename T>
void	deleteLastChild ()
template<typename T>
void	deleteAllChildren ()
Object *	topParent () const
	returns top level parent: it may return itself
const std::string &	name () const
void	installEventFilter (const Object *filterObj)
void	removeEventFilter (const Object *obj)
virtual bool	eventFilter (Object *, Event *)
int	startTimer (int interval)
void	killTimer (int id)
void	killTimers ()
virtual bool	event (Event *e)
	event handling
Public Attributes
sigc::signal< void >	timeout
	Emitted when the timer is triggered.
Signal01< void, const Object * >	destroyed
	signals
Protected Member Functions
virtual void	childEvent (ChildEvent *)
	event handling specialization
virtual void	customEvent (CustomEvent *)
bool	filterEvent (Event *)
Private Member Functions
virtual void	timerEvent (TimerEvent *e)
Private Attributes
int	timerid_
bool	sshot_
int	delivered_

---

Detailed Description

Timer handles known events that must happen (fairly) regularly.

Definition at line 29 of file timer.h.

---

Member Typedef Documentation

typedef std::list<Object*> Wt::Object::List [inherited]

Definition at line 47 of file object.h.

---

Constructor & Destructor Documentation

Wt::Timer::Timer	(	Object *	parent = 0,
		const std::string &	name = "Timer::anon"
	)

Create a timer.

Definition at line 25 of file timer.cpp.

                                                  :
        Object(parent, name),
        timerid_(0),
        sshot_(false),
delivered_(0) {}

---

Member Function Documentation

void Wt::Timer::changeInterval

(

int

msec

)

Definition at line 39 of file timer.cpp.

References sshot_, start(), and stop().

                                   {
    stop();
    start(msec, sshot_);
}

Here is the call graph for this function:

virtual void Wt::Object::childEvent

(

ChildEvent *

)

[inline, protected, virtual, inherited]

event handling specialization

Reimplemented in Wt::Window::Frame.

Definition at line 146 of file object.h.

Referenced by Wt::Object::event().

{}

List& Wt::Object::children

(

)

[inline, inherited]

Definition at line 61 of file object.h.

References Wt::Object::children_.

                     {
        return children_;
    }

const List& Wt::Object::children

(

)

const [inline, inherited]

Definition at line 57 of file object.h.

References Wt::Object::children_.

Referenced by Wt::RootWindow::blit_region_ex(), Wt::Widget::childAt(), Wt::Object::deleteAllChildren(), Wt::Object::deleteFirstChild(), Wt::Object::deleteLastChild(), Wt::Widget::focusNextPrevChild(), Wt::Widget::fontChange(), Wt::Widget::lower(), Wt::postLayoutHintEventRecursively(), and Wt::Widget::raise().

                                 {
        return children_;
    }

virtual void Wt::Object::customEvent

(

CustomEvent *

)

[inline, protected, virtual, inherited]

Definition at line 147 of file object.h.

Referenced by Wt::Object::event().

{}

template<typename T>

void Wt::Object::deleteAllChildren

(

)

[inline, inherited]

Definition at line 106 of file object.h.

References Wt::Object::children().

                             {
        List::iterator it(children().begin());
        List::iterator end(children().end());

        while (it != end) {
            T *t = dynamic_cast<T *>(*it);
            // before iteration invalidation
            ++it;
            // this will invalidate the iterator
            if (t) {
                delete t;
            }
        }
    }

Here is the call graph for this function:

template<typename T>

void Wt::Object::deleteFirstChild

(

)

[inline, inherited]

Definition at line 72 of file object.h.

References Wt::Object::children().

                            {
        List::iterator it(children().begin());
        List::iterator end(children().end());

        while (it != end) {
            T *t = dynamic_cast<T *>(*it);
            // before iteration invalidation
            ++it;
            // this will invalidate the iterator
            if (t) {
                delete t;
                break;
            }
        }
    }

Here is the call graph for this function:

template<typename T>

void Wt::Object::deleteLastChild

(

)

[inline, inherited]

Definition at line 89 of file object.h.

References Wt::Object::children().

                           {
        List::reverse_iterator it(children().rbegin());
        List::reverse_iterator end(children().rend());

        while (it != end) {
            T *t = dynamic_cast<T *>(*it);
            // before iteration invalidation
            ++it;
            // this will invalidate the iterator
            if (t) {
                delete t;
                break;
            }
        }
    }

Here is the call graph for this function:

bool Wt::Object::event

(

Event *

e

)

[virtual, inherited]

event handling

Reimplemented in Wt::Application, and Wt::Widget.

Definition at line 173 of file object.cpp.

References Wt::Object::childEvent(), Wt::Event::ChildInserted, Wt::Event::ChildRemoved, Wt::Object::customEvent(), Wt::Object::filterEvent(), Wt::SDLTimer::scheduleNext(), Wt::Object::timer(), Wt::Event::Timer, Wt::Object::timerEvent(), Wt::Event::type(), and Wt::Event::User.

Referenced by Wt::Widget::event(), Wt::Application::notify(), and Wt::Application::postEvent().

                           {
    bool handled = true;

    if (filterEvent(e))
        return true;

    switch (e->type()) {
    case Event::Timer: {
            TimerEvent *te = static_cast<TimerEvent *>(e);
            int id = te->timerid();
            if (timer(id)) {
                timerEvent(te);
            }
            // if it is signle shot it may have been killed
            // during eventhandling
            SDLTimer *t = timer(id);
            if (t)
                t->scheduleNext();
        }
        break;
    case Event::ChildInserted:
    case Event::ChildRemoved:
        childEvent(static_cast<ChildEvent *>(e));
        break;
    default:
        if (e->type() >= Event::User) {
            customEvent(static_cast<CustomEvent *>(e));
        } else {
            handled = false;
        }
        break;
    }

    return handled;
}

Here is the call graph for this function:

virtual bool Wt::Object::eventFilter	(	Object *	,
		Event *
	)			[inline, virtual, inherited]

Reimplemented in Wt::Layout.

Definition at line 130 of file object.h.

Referenced by Wt::Layout::eventFilter().

                                                {
        return false;
    }

bool Wt::Object::filterEvent

(

Event *

)

[protected, inherited]

Definition at line 164 of file object.cpp.

References Wt::Object::eventFilters_.

Referenced by Wt::Object::event(), and Wt::Application::event().

                                 {
    for (List::iterator filter(eventFilters_.begin()),
            end(eventFilters_.end()); filter != end; ++filter) {
        if ((*filter)->eventFilter(this, e))
            return true;
    }
    return false;
}

void Wt::Object::insertChild

(

Object *

obj

)

[virtual, inherited]

Definition at line 81 of file object.cpp.

References Wt::Event::ChildInserted, Wt::Object::children_, Wt::Object::parent_, and Wt::Application::postEvent().

Referenced by Wt::Object::Object(), and Wt::Object::reparent().

                                    {
    children_.push_back(obj);
    obj->parent_ = this;
    Event *child_event = new ChildEvent(Event::ChildInserted, obj);
    Application::postEvent(this, child_event);
}

Here is the call graph for this function:

void Wt::Object::installEventFilter

(

const Object *

filterObj

)

[inherited]

Definition at line 124 of file object.cpp.

References Wt::Object::destroyed, Wt::Object::eventFilters_, and Wt::Object::removeEventFilter().

Referenced by Wt::Widget::setLayout().

                                                       {
    // we have to deconstify here. We cannot deliver event to const objects
    Object *obj = const_cast<Object *>(filterObj);
    eventFilters_.push_back(obj);
    obj->destroyed.connect(sigc::slot1<void, const Object *>(
                               sigc::mem_fun(*this, &Object::removeEventFilter)));
}

Here is the call graph for this function:

bool Wt::Timer::isActive

(

)

const [inline]

Definition at line 34 of file timer.h.

References timerid_.

                          {
        return timerid_;
    }

bool Wt::Object::isDescendant

(

const Object *

p

)

const [inherited]

Definition at line 67 of file object.cpp.

References Wt::Object::parent().

Referenced by Wt::SDLInput::EventInfo::EventInfo(), and Wt::SDLInput::handleKeyEvent().

                                               {
    if (!p)
        return false;

    const Object *q = this;

    do {
        if (p == q)
            return true;
    } while ((q = q->parent()));

    return false;
}

Here is the call graph for this function:

void Wt::Object::killTimer

(

int

id

)

[inherited]

Definition at line 145 of file object.cpp.

References Wt::Object::timers_.

Referenced by stop().

                             {
    delete timers_[id];
    timers_.erase(id);
}

void Wt::Object::killTimers

(

)

[inherited]

Definition at line 150 of file object.cpp.

References Wt::Object::timers_.

Referenced by Wt::Object::~Object().

                        {
    uint n = timers_.size() + 1;
    for (uint i = 1; i < n; i++) {
        delete timers_[i];
    }
    timers_.clear();
}

const std::string& Wt::Object::name

(

)

const [inline, inherited]

Definition at line 124 of file object.h.

References Wt::Object::name_.

Referenced by Wt::operator<<(), Wt::Application::parseArgs(), and Wt::PushButton::setButtonSize().

                                  {
        return name_;
    }

Object* Wt::Object::parent

(

)

const [inline, inherited]

Definition at line 53 of file object.h.

References Wt::Object::parent_.

Referenced by Wt::Widget::event(), Wt::Widget::focusNextPrevChild(), Wt::Window::Frame::Frame(), Wt::Widget::is_hidden(), Wt::Object::isDescendant(), Wt::Layout::isTopLevel(), Wt::Layout::Layout(), Wt::Widget::lower(), Wt::Layout::mainWidget(), Wt::operator<<(), Wt::Widget::paintEvent(), Wt::Widget::parentWidget(), Wt::Application::postEvent(), Wt::Widget::raise(), Wt::Widget::updateGeometry(), Wt::Widget::Widget(), Wt::Window::Window(), Wt::Layout::~Layout(), and Wt::Widget::~Widget().

                           {
        return parent_;
    };

void Wt::Object::removeChild

(

Object *

obj

)

[virtual, inherited]

Definition at line 88 of file object.cpp.

References Wt::Event::ChildRemoved, Wt::Object::children_, Wt::Object::parent_, and Wt::Application::postEvent().

Referenced by Wt::Object::reparent(), and Wt::Object::~Object().

                                    {
    List::iterator end = children_.end();
    List::iterator p = find(children_.begin(), end, obj);

    if (p != end) {
        children_.erase(p);
        obj->parent_ = 0;
        Event *child_event = new ChildEvent(Event::ChildRemoved, obj);
        Application::postEvent(this, child_event);
    }
}

Here is the call graph for this function:

void Wt::Object::removeEventFilter

(

const Object *

obj

)

[inherited]

Definition at line 132 of file object.cpp.

References Wt::Object::eventFilters_.

Referenced by Wt::Object::installEventFilter().

                                                {
    List::iterator p, end(eventFilters_.end());
    p = find(eventFilters_.begin(), end, obj);
    if (p != end)
        eventFilters_.erase(p);
}

void Wt::Object::reparent

(

Object *

new_parent

)

[inherited]

Definition at line 100 of file object.cpp.

References Wt::Object::insertChild(), Wt::Object::parent_, Wt::Object::removeChild(), and trace.

Referenced by Wt::Layout::addItem(), Wt::Widget::reparent(), and Wt::Widget::setLayout().

                                        {
    if (parent_ == new_parent)
        return;
    trace("obj") << "Reparenting " <<  this << std::endl;

    if (parent_) {
        trace("obj") << "   Leaving parent " <<  parent_ << std::endl;
        parent_->removeChild(this);
    }
    if (new_parent) {
        trace("obj") << "   Going to new parent " <<  new_parent << std::endl;
        new_parent->insertChild(this);
    }
    parent_ = new_parent;
}

Here is the call graph for this function:

int Wt::Timer::start	(	int	msec,
		bool	sshot = false
	)

Definition at line 31 of file timer.cpp.

References delivered_, sshot_, Wt::Object::startTimer(), stop(), and timerid_.

Referenced by changeInterval().

                                     {
    stop();
    timerid_ = startTimer(msec);
    sshot_ = sshot;
    delivered_ = 0;
    return timerid_;
}

Here is the call graph for this function:

int Wt::Object::startTimer

(

int

interval

)

[inherited]

Definition at line 139 of file object.cpp.

References Wt::Object::timers_.

Referenced by start().

                                   {
    int id = timers_.size() + 1;
    timers_[id] = new SDLTimer(this, id, interval);
    return id;
}

void Wt::Timer::stop

(

)

Definition at line 44 of file timer.cpp.

References Wt::Object::killTimer(), and timerid_.

Referenced by changeInterval(), start(), and timerEvent().

                 {
    if (timerid_) {
        killTimer(timerid_);
        timerid_ = 0;
    }
}

Here is the call graph for this function:

void Wt::Timer::timerEvent

(

TimerEvent *

e

)

[private, virtual]

Reimplemented from Wt::Object.

Definition at line 51 of file timer.cpp.

References delivered_, sshot_, stop(), timeout, and Wt::Object::timerEvent().

                                    {
    Object::timerEvent(e);
    if (sshot_)
        stop();
    if (!sshot_ || (sshot_ && !delivered_)) {
        timeout();
        delivered_++;
    }
}

Here is the call graph for this function:

int Wt::Timer::timerId

(

)

const [inline]

Definition at line 42 of file timer.h.

References timerid_.

                        {
        return timerid_;
    }

Object * Wt::Object::topParent

(

)

const [inherited]

returns top level parent: it may return itself

Definition at line 116 of file object.cpp.

References Wt::Object::parent_.

Referenced by Wt::Widget::topParentWidget().

                                {
    const Object *p = this;
    while (p->parent_) {
        p = p->parent_;
    }
    return const_cast<Object *>(p);
}

---

Member Data Documentation

int Wt::Timer::delivered_ [private]

Definition at line 53 of file timer.h.

Referenced by start(), and timerEvent().

Signal01<void, const Object *> Wt::Object::destroyed [inherited]

signals

Definition at line 139 of file object.h.

Referenced by Wt::Layout::addItem(), Wt::Object::installEventFilter(), and Wt::Object::~Object().

bool Wt::Timer::sshot_ [private]

Definition at line 52 of file timer.h.

Referenced by changeInterval(), start(), and timerEvent().

sigc::signal<void> Wt::Timer::timeout

Emitted when the timer is triggered.

Definition at line 47 of file timer.h.

Referenced by timerEvent().

int Wt::Timer::timerid_ [private]

Definition at line 51 of file timer.h.

Referenced by isActive(), start(), stop(), and timerId().

---

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

• timer.h
• timer.cpp

---

Generated Fri Jul 28 19:33:20 2006.
Copyright © 1998-2003 by the respective authors.

This document is licensed under the terms of the GNU Free Documentation License and may be freely distributed under the conditions given by this license.