widget_definition.cpp

Go to the documentation of this file.

/*
   Copyright (C) 2007 - 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.
*/

#define GETTEXT_DOMAIN "wesnoth-lib"

#include "gui/core/widget_definition.hpp"

#include "gettext.hpp"
#include "gui/core/log.hpp"
#include "gui/widgets/helper.hpp"
#include "wml_exception.hpp"

namespace gui2
{

/*WIKI
 * @page = GUIToolkitWML
 * @order = 1_widget
 * @begin{parent}{name=generic/widget_definition/}
 * == Resolution ==
 * @begin{tag}{name="resolution"}{min="0"}{max="-1"}
 *
 * Depending on the resolution a widget can look different. Resolutions are
 * evaluated in order of appearance. The ''window_width'' and ''window_height''
 * are the upper limit this resolution is valid for. When one of the sizes
 * gets above the limit, the next resolution is selected. There's one special
 * case where both values are ''0''. This resolution always matches. (Resolution
 * definitions behind that one will never be picked.) This resolution can be
 * used as upper limit or if there's only one resolution.
 *
 * The default (and also minimum) size of a button is determined by two items,
 * the wanted default size and the size needed for the text. The size of the
 * text differs per used widget so needs to be determined per button.
 *
 * Container widgets like panels and windows have other rules for their sizes.
 * Their sizes are based on the size of their children (and the border they need
 * themselves). It's wise to set all sizes to 0 for these kind of widgets.
 *
 * @begin{table}{config}
 * window_width & unsigned & 0 &   Width of the application window. $
 * window_height & unsigned & 0 &  Height of the application window. $
 *
 *
 * min_width & unsigned & 0 &      The minimum width of the widget. $
 * min_height & unsigned & 0 &     The minimum height of the widget. $
 *
 *
 * default_width & unsigned & 0 &  The default width of the widget. $
 * default_height & unsigned & 0 & The default height of the widget. $
 *
 *
 * max_width & unsigned & 0 &      The maximum width of the widget. $
 * max_height & unsigned & 0 &     The maximum height of the widget. $
 *
 * text_extra_width & unsigned & 0 &
 *     The extra width needed to determine the minimal size for the text. $
 *
 * text_extra_height & unsigned & 0 &
 *     The extra height needed to determine the minimal size for the text. $
 *
 * text_font_family & font_family & "" &
 *     The font family, needed to determine the minimal size for the text. $
 *
 * text_font_size & unsigned & 0 &
 *     The font size, which needs to be used to determine the minimal size for
 *     the text. $
 *
 * text_font_style & font_style & "" &
 *     The font style, which needs to be used to determine the minimal size for
 *     the text. $
 *
 *
 * state & section & &
 *     Every widget has one or more state sections. Note they aren't called
 *     state but state_xxx the exact names are listed per widget. $
 * @end{table}
 * @end{tag}{name="resolution"}
 * @end{parent}{name=generic/widget_definition/}
 */

tresolution_definition_::tresolution_definition_(const config& cfg)
    : window_width(cfg["window_width"])
    , window_height(cfg["window_height"])
    , min_width(cfg["min_width"])
    , min_height(cfg["min_height"])
    , default_width(cfg["default_width"])
    , default_height(cfg["default_height"])
    , max_width(cfg["max_width"])
    , max_height(cfg["max_height"])
    , text_extra_width(cfg["text_extra_width"])
    , text_extra_height(cfg["text_extra_height"])
    , text_font_size(cfg["text_font_size"])
    , text_font_family(font::str_to_family_class(cfg["text_font_family"]))
    , text_font_style(decode_font_style(cfg["text_font_style"]))
    , state()
{
    DBG_GUI_P << "Parsing resolution " << window_width << ", " << window_height
              << '\n';
}

/*WIKI
 * @page = GUIWidgetDefinitionWML
 * @order = 1
 *
 * {{Autogenerated}}
 *
 * = Widget definition =
 *
 * This page describes the definition of all widgets in the toolkit. Every
 * widget has some parts in common, first of all; every definition has the
 * following fields.
 * @begin{parent}{name="generic/"}
 * @begin{tag}{name=widget_definition}{min=0}{max=1}
 * @begin{table}{config}
 *     id & string & &               Unique id for this gui (theme). $
 *     description & t_string & &    Unique translatable name for this gui. $
 *
 *     resolution & section & &      The definitions of the widget in various
 *                                   resolutions. $
 * @end{table}
 * @end{tag}{name=widget_definition}
 * @end{parent}{name="generic/"}
 */
tcontrol_definition::tcontrol_definition(const config& cfg)
    : id(cfg["id"]), description(cfg["description"].t_str()), resolutions()
{
    VALIDATE(!id.empty(), missing_mandatory_wml_key("control", "id"));
    VALIDATE(!description.empty(),
             missing_mandatory_wml_key("control", "description"));

    /*
     * Do this validation here instead of in load_resolutions so the
     * translatable string is not in the header and we don't need to pull in
     * extra header dependencies.
     */
    config::const_child_itors itors = cfg.child_range("resolution");
    VALIDATE(itors.first != itors.second, _("No resolution defined."));
}

} // namespace gui2