transient_message.hpp

Go to the documentation of this file.

/*
   Copyright (C) 2009 - 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_TRANSIENT_MESSAGE_HPP_INCLUDED
#define GUI_DIALOGS_TRANSIENT_MESSAGE_HPP_INCLUDED

#include "gui/dialogs/dialog.hpp"

namespace gui2
{

/** Shows a transient message. */
class ttransient_message : public tdialog
{
public:
    ttransient_message(const std::string& title,
                       const bool title_use_markup,
                       const std::string& message,
                       const bool message_use_markup,
                       const std::string& image);

private:
    bool hide_title_;
    bool hide_image_;

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

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

/**
 * Shows a transient message to the user.
 *
 * This shows a dialog with a short message which can be dismissed with a
 * single click.
 *
 * @note The message _should_ be small enough to fit on the window, the text
 * can contain newlines and will wrap when needed.
 *
 * @param video               The video which contains the surface to draw
 *                            upon.
 * @param title               The title of the dialog.
 * @param message             The message to show in the dialog.
 * @param image               An image to show in the dialog.
 * @param message_use_markup  Use markup for the message?
 * @param title_use_markup    Use markup for the title?
 * @param restore_background  Restore the background to the state it was before
 *                            the message appeared
 */
void show_transient_message(CVideo& video,
                            const std::string& title,
                            const std::string& message,
                            const std::string& image = std::string(),
                            const bool message_use_markup = false,
                            const bool title_use_markup = false,
                            const bool restore_background = false);

/**
 * Shows a transient error message to the user.
 *
 * This shows a dialog with a short message which can be dismissed with a
 * single click.
 *
 * @param video               The video which contains the surface to draw
 *                            upon.
 * @param message             The message to show in the dialog.
 * @param image               An image to show in the dialog.
 * @param message_use_markup  Use markup for the message?
 */
void show_transient_error_message(CVideo& video,
                                  const std::string& message,
                                  const std::string& image = std::string(),
                                  const bool message_use_markup = false);

} // namespace gui2

#endif