qd_interface_button.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


#ifndef QDENGINE_QDCORE_QD_INTERFACE_BUTTON_H
#define QDENGINE_QDCORE_QD_INTERFACE_BUTTON_H

#include "qdengine/qdcore/qd_interface_element.h"
#include "qdengine/qdcore/qd_interface_element_state.h"


namespace QDEngine {

class qdInterfaceButton : public qdInterfaceElement {
public:
    qdInterfaceButton();
    qdInterfaceButton(const qdInterfaceButton &bt);
    ~qdInterfaceButton();

    qdInterfaceButton &operator = (const qdInterfaceButton &bt);

    qdInterfaceElement::element_type get_element_type() const {
        return qdInterfaceElement::EL_BUTTON;
    }

    int num_states() const {
        return _states.size();
    }

    bool activate_state(int state_num);
    bool activate_state(const char *state_name);

    int option_value() const {
        return _cur_state;
    }
    bool set_option_value(int value);

    const qdInterfaceElementState *get_state(int state_num) const {
        assert(state_num >= 0 && state_num < (int)_states.size());
#ifndef _QD_INTERFACE_BUTTON_PTR_CONTAINER
        return &_states[state_num];
#else
        return &*_states[state_num];
#endif
    }
    qdInterfaceElementState *get_state(int state_num) {
        assert(state_num >= 0 && state_num < (int)_states.size());
#ifndef _QD_INTERFACE_BUTTON_PTR_CONTAINER
        return &_states[state_num];
#else
        return &*_states[state_num];
#endif
    }


    bool add_state(const qdInterfaceElementState &st);


    bool insert_state(int insert_before, const qdInterfaceElementState &st);

    bool erase_state(int state_num);


    bool modify_state(int state_num, const qdInterfaceElementState &st) {
        assert(state_num >= 0 && state_num < (int)_states.size());
#ifdef _QD_INTERFACE_BUTTON_PTR_CONTAINER
        *_states[state_num] = st;
        _states[state_num]->set_owner(this);
#else
        _states[state_num] = st;
        _states[state_num].set_owner(this);
#endif
        return true;
    }


    bool change_state(bool direction = true);

    bool mouse_handler(int x, int y, mouseDispatcher::mouseEvent ev);
    bool keyboard_handler(Common::KeyCode vkey);


    bool init(bool is_game_active = true);

    bool quant(float dt);

    bool hit_test(int x, int y) const;

    const qdInterfaceEvent *find_event(qdInterfaceEvent::event_t type) const;
    bool has_event(qdInterfaceEvent::event_t type, const char *ev_data = NULL) const;

protected:

    bool save_script_body(Common::WriteStream &fh, int indent = 0) const;
    bool load_script_body(const xml::tag *p);

private:

#ifdef _QD_INTERFACE_BUTTON_PTR_CONTAINER
    typedef Std::vector<qdInterfaceElementState *> state_container_t;
#else
    typedef Std::vector<qdInterfaceElementState> state_container_t;
#endif

    state_container_t _states;

    int _cur_state;

};

} // namespace QDEngine

#endif // QDENGINE_QDCORE_QD_INTERFACE_BUTTON_H