gui/widgets/stacked_widget.hpp

Go to the documentation of this file.

/* $Id: stacked_widget.hpp 52533 2012-01-07 02:35:17Z shadowmaster $ */
/*
   Copyright (C) 2009 - 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.
*/

#ifndef GUI_WIDGETS_STACKED_WIDGET_HPP_INCLUDED
#define GUI_WIDGETS_STACKED_WIDGET_HPP_INCLUDED

#include "gui/widgets/container.hpp"

namespace gui2 {

namespace implementation {
    struct tbuilder_stacked_widget;
}

class tgenerator_;

class tstacked_widget
        : public tcontainer_
{
    friend struct implementation::tbuilder_stacked_widget;
    friend class tdebug_layout_graph;

public:

    tstacked_widget();

    /***** ***** ***** inherited ***** ****** *****/

    /** Inherited from tcontrol. */
    bool get_active() const { return true; }

    /** Inherited from tcontrol. */
    unsigned get_state() const { return 0; }

    /** Inherited from tscrollbar_container. */
    void layout_children();

private:

    /**
     * Finishes the building initialization of the widget.
     *
     * @param widget_builder      The builder to build the contents of the
     *                            widget.
     */
    void finalize(std::vector<tbuilder_grid_const_ptr> widget_builder);

    /**
     * Contains a pointer to the generator.
     *
     * The pointer is not owned by this class, it's stored in the content_grid_
     * of the tscrollbar_container super class and freed when it's grid is
     * freed.
     */
    tgenerator_* generator_;

    /** Inherited from tcontrol. */
    const std::string& get_control_type() const;

    /** Inherited from tcontainer_. */
    void set_self_active(const bool /*active*/) {}
};

} // namespace gui2

#endif