edit_label.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2010 - 2016 by Ignacio Riquelme Morelle <[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_DIALOGS_EDITOR_EDIT_LABEL_HPP_INCLUDED
#define GUI_DIALOGS_EDITOR_EDIT_LABEL_HPP_INCLUDED

#include "gui/dialogs/dialog.hpp"
#include "map/label.hpp"

namespace gui2
{

class teditor_edit_label : public tdialog
{
public:
    /**
     * Constructor.
     *
     * @param[in, out] text       The parameter's usage is:
     *                            - Input: The initial value of the label.
     *                            - Output: The label text the user entered if
     *                              the dialog returns @ref twindow::OK
     *                              undefined otherwise.
     */
    teditor_edit_label(std::string& text,
                       bool& immutable,
                       bool& visible_fog,
                       bool& visible_shroud,
                       SDL_Color& color,
                       std::string& category);

    /** The execute function see @ref tdialog for more information. */
    static bool execute(std::string& text,
                        bool& immutable,
                        bool& visible_fog,
                        bool& visible_shroud,
                        SDL_Color& color,
                        std::string& category,
                        CVideo& video)
    {
        return teditor_edit_label(text, immutable, visible_fog, visible_shroud, color, category)
                .show(video);
    }

private:
    SDL_Color& color_store;
    int load_color_component(Uint8 SDL_Color::* component);
    void save_color_component(Uint8 SDL_Color::* component, const int value);
    void register_color_component(std::string widget_id, Uint8 SDL_Color::* component);
    /** Inherited from tdialog, implemented by REGISTER_DIALOG. */
    virtual const std::string& window_id() const;
};
}

#endif /* ! GUI_DIALOGS_EDIT_LABEL_INCLUDED */