gui/dialogs/folder_create.hpp

Go to the documentation of this file.

/* $Id: folder_create.hpp 52869 2012-02-03 20:18:33Z shadowmaster $ */
/*
   Copyright (C) 2011 - 2012 by Ignacio Riquelme Morelle <shadowm2006@gmail.com>
   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_FOLDER_CREATE_HPP_INCLUDED
#define GUI_DIALOGS_FOLDER_CREATE_HPP_INCLUDED

#include "gui/dialogs/dialog.hpp"

namespace gui2 {

class tfolder_create : public tdialog
{
public:
    /**
     * Constructor.
     *
     * @param folder_name [in]    A suggested folder name.
     * @param folder_name [out]   The folder name the user actually entered if the dialog
     *                            returns @ref twindow::OK; undefined otherwise.
     */
    tfolder_create(std::string& folder_name);

    /** The excute function; see @ref tdialog for more information. */
    static bool execute(std::string& folder_name, CVideo& video)
    {
        return tfolder_create(folder_name).show(video);
    }

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

}

#endif /* ! GUI_DIALOGS_EDIT_LABEL_INCLUDED */