scroll_label.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2008 - 2016 by Mark de Wever <[email protected]>
   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_SCROLL_LABEL_HPP_INCLUDED
#define GUI_WIDGETS_SCROLL_LABEL_HPP_INCLUDED

#include "gui/widgets/scrollbar_container.hpp"

#include "gui/core/widget_definition.hpp"
#include "gui/core/window_builder.hpp"

namespace gui2
{

// ------------ WIDGET -----------{

class tlabel;
class tspacer;

namespace implementation
{
struct tbuilder_scroll_label;
}

/**
 * Label showing a text.
 *
 * This version shows a scrollbar if the text gets too long and has some
 * scrolling features. In general this widget is slower as the normal label so
 * the normal label should be preferred.
 */
class tscroll_label : public tscrollbar_container
{
    friend struct implementation::tbuilder_scroll_label;

public:
    tscroll_label(bool wrap);

    /** See @ref tcontrol::set_label. */
    virtual void set_label(const t_string& label) override;

    /** See @ref tcontrol::set_use_markup. */
    virtual void set_use_markup(bool use_markup) override;

    /** See @ref tcontainer_::set_self_active. */
    virtual void set_self_active(const bool active) override;

    /***** ***** ***** setters / getters for members ***** ****** *****/

    /** See @ref tcontrol::get_active. */
    virtual bool get_active() const override;

    /** See @ref tcontrol::get_state. */
    virtual unsigned get_state() const override;
    
    bool can_wrap() const;
    void set_can_wrap(bool can_wrap);

private:
    /**
     * Possible states of the widget.
     *
     * Note the order of the states must be the same as defined in settings.hpp.
     */
    enum tstate {
        ENABLED,
        DISABLED,
        COUNT
    };

    // It's not needed for now so keep it disabled, no definition exists yet.
    // void set_state(const tstate state);

    /**
     * Current state of the widget.
     *
     * The state of the widget determines what to render and how the widget
     * reacts to certain 'events'.
     */
    tstate state_;
    bool wrap_on;

    void finalize_subclass();

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

    /** See @ref tcontrol::get_control_type. */
    virtual const std::string& get_control_type() const override;

    /***** ***** ***** signal handlers ***** ****** *****/

    void signal_handler_left_button_down(const event::tevent event);
};

// }---------- DEFINITION ---------{

struct tscroll_label_definition : public tcontrol_definition
{
    explicit tscroll_label_definition(const config& cfg);

    struct tresolution : public tresolution_definition_
    {
        explicit tresolution(const config& cfg);

        tbuilder_grid_ptr grid;
    };
};

// }---------- BUILDER -----------{

namespace implementation
{

struct tbuilder_scroll_label : public tbuilder_control
{
    explicit tbuilder_scroll_label(const config& cfg);

    using tbuilder_control::build;

    twidget* build() const;

    tscrollbar_container::tscrollbar_mode vertical_scrollbar_mode;
    tscrollbar_container::tscrollbar_mode horizontal_scrollbar_mode;
    bool wrap_on;
};

} // namespace implementation

// }------------ END --------------

} // namespace gui2

#endif