gui/widgets/toggle_button.cpp

Go to the documentation of this file.

/* $Id: toggle_button.cpp 52533 2012-01-07 02:35:17Z shadowmaster $ */
/*
   Copyright (C) 2008 - 2012 by Mark de Wever <koraq@xs4all.nl>
   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/widgets/toggle_button.hpp"

#include "foreach.hpp"
#include "gui/auxiliary/log.hpp"
#include "gui/auxiliary/widget_definition/toggle_button.hpp"
#include "gui/auxiliary/window_builder/toggle_button.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/window.hpp"
#include "sound.hpp"

#include <boost/bind.hpp>

#define LOG_SCOPE_HEADER get_control_type() + " [" + id() + "] " + __func__
#define LOG_HEADER LOG_SCOPE_HEADER + ':'

namespace gui2 {

REGISTER_WIDGET(toggle_button)

ttoggle_button::ttoggle_button()
    : tcontrol(COUNT)
    , state_(ENABLED)
    , retval_(0)
    , callback_state_change_()
    , icon_name_()
{
    connect_signal<event::MOUSE_ENTER>(boost::bind(
                &ttoggle_button::signal_handler_mouse_enter, this, _2, _3));
    connect_signal<event::MOUSE_LEAVE>(boost::bind(
                &ttoggle_button::signal_handler_mouse_leave, this, _2, _3));

    connect_signal<event::LEFT_BUTTON_CLICK>(boost::bind(
                &ttoggle_button::signal_handler_left_button_click
                    , this, _2, _3));
    connect_signal<event::LEFT_BUTTON_DOUBLE_CLICK>(boost::bind(
                &ttoggle_button::signal_handler_left_button_double_click
                    , this, _2, _3));
}

void ttoggle_button::set_members(const string_map& data)
{
    // Inherit
    tcontrol::set_members(data);

    string_map::const_iterator itor = data.find("icon");
    if(itor != data.end()) {
        set_icon_name(itor->second);
    }
}

void ttoggle_button::set_active(const bool active)
{
    if(active) {
        if(get_value()) {
            set_state(ENABLED_SELECTED);
        } else {
            set_state(ENABLED);
        }
    } else {
        if(get_value()) {
            set_state(DISABLED_SELECTED);
        } else {
            set_state(DISABLED);
        }
    }
}

void ttoggle_button::update_canvas()
{
    // Inherit.
    tcontrol::update_canvas();

    // set icon in canvases
    std::vector<tcanvas>& canvases = tcontrol::canvas();
    foreach(tcanvas& canvas, canvases) {
        canvas.set_variable("icon", variant(icon_name_));
    }

    set_dirty();
}

void ttoggle_button::set_value(const bool selected)
{
    if(selected == get_value()) {
        return;
    }

    if(selected) {
        set_state(static_cast<tstate>(state_ + ENABLED_SELECTED));
    } else {
        set_state(static_cast<tstate>(state_ - ENABLED_SELECTED));
    }
}

void ttoggle_button::set_retval(const int retval)
{
    if(retval == retval_) {
        return;
    }

    retval_ = retval;
    set_wants_mouse_left_double_click(retval_ != 0);
}

void ttoggle_button::set_state(const tstate state)
{
    if(state != state_) {
        state_ = state;
        set_dirty(true);
    }
}

const std::string& ttoggle_button::get_control_type() const
{
    static const std::string type = "toggle_button";
    return type;
}

void ttoggle_button::signal_handler_mouse_enter(
        const event::tevent event, bool& handled)
{
    DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";

    if(get_value()) {
        set_state(FOCUSSED_SELECTED);
    } else {
        set_state(FOCUSSED);
    }
    handled = true;
}

void ttoggle_button::signal_handler_mouse_leave(
        const event::tevent event, bool& handled)
{
    DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";

    if(get_value()) {
        set_state(ENABLED_SELECTED);
    } else {
        set_state(ENABLED);
    }
    handled = true;
}

void ttoggle_button::signal_handler_left_button_click(
        const event::tevent event, bool& handled)
{
    DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";

    sound::play_UI_sound(settings::sound_toggle_button_click);

    if(get_value()) {
        set_state(ENABLED);
    } else {
        set_state(ENABLED_SELECTED);
    }

    if(callback_state_change_) {
        callback_state_change_(this);
    }
    handled = true;
}

void ttoggle_button::signal_handler_left_button_double_click(
        const event::tevent event, bool& handled)
{
    DBG_GUI_E << LOG_HEADER << ' ' << event << ".\n";

    if(retval_ == 0) {
        return;
    }

    twindow* window = get_window();
    assert(window);

    window->set_retval(retval_);

    handled = true;
}
} // namespace gui2