retval.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2007 - 2022
    by Mark de Wever <koraq@xs4all.nl>
    Part of the Battle for Wesnoth Project https://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.
*/

#pragma once

namespace gui2
{
/**
 * Default window/dialog return values.
 *
 * These values are named return values and most are assigned to a widget
 * automatically when using a certain id for that widget (ie, a widget with
 * the id "ok" will be assigned the OK return value.
 *
 * The automatic return values are always a negative number.
 */
enum retval : int
{
    /** Default, unset return value. */
    NONE = 0,

    /** Dialog was closed with the OK button. */
    OK = -1,

    /** Dialog was closed with the CANCEL button. */
    CANCEL = -2,

    /** The dialog was closed automatically as its timeout had been reached. */
    AUTO_CLOSE = -3,
};

} // namespace gui2