gui/auxiliary/iterator/iterator.hpp

Go to the documentation of this file.

/* $Id: iterator.hpp 52869 2012-02-03 20:18:33Z shadowmaster $ */
/*
   Copyright (C) 2011 - 2012 by Mark de Wever <koraq@xs4all.nl>
   Part of the Battle for Wesnoth Project http://www.wesnoth.org/

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY.

   See the COPYING file for more details.
*/

/**
 * @file
 * Contains the base iterator class for the gui2 widgets.
 *
 * For more information @see @ref gui2_iterator for more information.
 */

#ifndef GUI_WIDGETS_AUXILIARY_ITERATOR_ITERATOR_HPP_INCLUDED
#define GUI_WIDGETS_AUXILIARY_ITERATOR_ITERATOR_HPP_INCLUDED

#include "gui/auxiliary/iterator/policy_order.hpp"

namespace gui2 {

namespace iterator {

/**
 * The iterator class.
 *
 * @see @ref gui2_iterator_iterator for more information.
 */
template<class order>
class titerator
    : private order
    , private boost::noncopyable
{
public:

    /**
     * Contstructor.
     *
     * @param root                The widget where to start the iteration.
     */
    titerator(twidget& root)
        : order(root)
    {
    }

    /**
     * Has the iterator reached the end?
     *
     * @returns                   The status.
     * @retval [true]             At the end.
     * @retval [false]            Not at the end.
     */
    bool at_end() const { return order::at_end(); }

    /**
     * Visit the next widget.
     *
     * @pre @ref at_end() == false
     *
     * @throws @ref trange_error upon pre condition violation.
     *
     * @returns                   Whether the next widget can be safely
     *                            deferred.
     */
    bool next() { return order::next(); }

    /** See @ref next. */
    titerator<order>& operator++()
    {
        order::next();
        return *this;
    }

    /**
     * Returns the current widget.
     *
     * @returns                   The current widget.
     */
    twidget& operator*() { return order::operator*(); }

    /** See @ref operator*. */
    twidget* operator->()
    {
        return &(operator*());
    }
};

} // namespace iterator

} // namespace gui2

#endif