wml_message.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_DIALOGS_WML_MESSAGE_HPP_INCLUDED
#define GUI_DIALOGS_WML_MESSAGE_HPP_INCLUDED

#include "gui/dialogs/dialog.hpp"

namespace gui2
{

/**
 *  Helper class for message options
 */
class twml_message_option {
public:
    explicit twml_message_option(std::string label, std::string description = "", std::string image = "")
        : label_(label)
        , description_(description)
        , image_(image)
    {}
    std::string label() const {return label_;};
    std::string description() const {return description_;};
    std::string image() const {return image_;};
private:
    std::string label_, description_, image_;
};

/**
 * Base class for the wml generated messages.
 *
 * We have a separate sub class for left and right images.
 */
class twml_message_ : public tdialog
{
public:
    twml_message_(const std::string& title,
                  const std::string& message,
                  const std::string& portrait,
                  const bool mirror)
        : title_(title)
        , image_("")
        , message_(message)
        , portrait_(portrait)
        , mirror_(mirror)
        , has_input_(false)
        , input_caption_("")
        , input_text_(nullptr)
        , input_maximum_length_(0)
        , option_list_()
        , chosen_option_(nullptr)
    {
    }

    /**
     * Sets the input text variables.
     *
     * @param caption             The caption for the label.
     * @param [in,out] text       The initial text, after showing the final
     *                            text.
     * @param maximum_length      The maximum length of the text.
     */
    void set_input(const std::string& caption,
                   std::string* text,
                   const unsigned maximum_length);
    /**
     * Sets the option list
     *
     * @param option_list            The list of options to display.
     * @param [in,out] chosen_option Pointer to the index of the initially
     *                               selected option; after showing, the
     *                               chosen option.
     */
    void set_option_list(const std::vector<twml_message_option>& option_list,
                         int* chosen_option);

private:
    /** The title for the dialog. */
    std::string title_;

    /**
     * The image which is shown in the dialog.
     *
     * This image can be an icon or portrait or any other image.
     */
    std::string image_;

    /** The message to show to the user. */
    std::string message_;
    /** Filename of the portrait. */
    std::string portrait_;

    /** Mirror the portrait? */
    bool mirror_;

    /** Do we need to show an input box? */
    bool has_input_;

    /** The caption to show for the input text. */
    std::string input_caption_;

    /** The text input. */
    std::string* input_text_;

    /** The maximum length of the input text. */
    unsigned input_maximum_length_;

    /** The list of options the user can choose. */
    std::vector<twml_message_option> option_list_;

    /** The chosen option. */
    int* chosen_option_;

    /** Inherited from tdialog. */
    void pre_show(twindow& window);

    /** Inherited from tdialog. */
    void post_show(twindow& window);
};

/** Shows a dialog with the portrait on the left side. */
class twml_message_left : public twml_message_
{
public:
    twml_message_left(const std::string& title,
                      const std::string& message,
                      const std::string& portrait,
                      const bool mirror)
        : twml_message_(title, message, portrait, mirror)
    {
    }

private:
    /** Inherited from tdialog, implemented by REGISTER_DIALOG. */
    virtual const std::string& window_id() const;
};

/** Shows a dialog with the portrait on the right side. */
class twml_message_right : public twml_message_
{
public:
    twml_message_right(const std::string& title,
                       const std::string& message,
                       const std::string& portrait,
                       const bool mirror)
        : twml_message_(title, message, portrait, mirror)
    {
    }

private:
    /** Inherited from tdialog, implemented by REGISTER_DIALOG. */
    virtual const std::string& window_id() const;
};


/**
 *  Helper function to show a portrait.
 *
 *  @param left_side              If true the portrait is shown on the left,
 *                                on the right side otherwise.
 *  @param video                  The display variable.
 *  @param title                  The title of the dialog.
 *  @param message                The message to show.
 *  @param portrait               Filename of the portrait.
 *  @param mirror                 Does the portrait need to be mirrored?
 *
 *  @param has_input              Do we need to show the input box.
 *  @param input_caption          The caption for the optional input text
 *                                box. If this value != "" there is an input
 *                                and the input text parameter is mandatory.
 *  @param input_text             Pointer to the initial text value will be
 *                                set to the result.
 *  @param maximum_length         The maximum length of the text.
 *
 *  @param option_list            A list of options to select in the dialog.
 *  @param chosen_option          Pointer to the initially chosen option.
 *                                Will be set to the chosen option when the
 *                                dialog closes.
 */
int show_wml_message(const bool left_side,
                     CVideo& video,
                     const std::string& title,
                     const std::string& message,
                     const std::string& portrait,
                     const bool mirror,
                     const bool has_input,
                     const std::string& input_caption,
                     std::string* input_text,
                     const unsigned maximum_length,
                     const std::vector<twml_message_option>& option_list,
                     int* chosen_option);


} // namespace gui2

#endif