action.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 COMMON_ACTION_H
#define COMMON_ACTION_H
 
#include "common/scummsys.h"
 
#include "common/array.h"
#include "common/events.h"
#include "common/str.h"
#include "common/ustr.h"
 
namespace Common {
 
struct KeyActionEntry {
    const char *id;
    const KeyState ks;
    const char *defaultHwId;
    const char *description;
};
 
struct Action {
    const char *id;
    U32String description;
 
    Event event;
 
private:
    Array<String> _defaultInputMapping;
    bool _shouldTriggerOnKbdRepeats;
 
public:
    Action(const char *id, const U32String &description);
 
    void setEvent(const Event &evt) {
        event = evt;
    }
 
    void setEvent(const EventType evtType) {
        event = Event();
        event.type = evtType;
    }
 
    void setCustomBackendActionEvent(const CustomEventType evtType) {
        event = Event();
        event.type = EVENT_CUSTOM_BACKEND_ACTION_START;
        event.customType = evtType;
    }
 
    void setCustomBackendActionAxisEvent(const CustomEventType evtType) {
        event = Event();
        event.type = EVENT_CUSTOM_BACKEND_ACTION_AXIS;
        event.customType = evtType;
    }
 
    void setCustomEngineActionEvent(const CustomEventType evtType) {
        event = Event();
        event.type = EVENT_CUSTOM_ENGINE_ACTION_START;
        event.customType = evtType;
    }
 
    void setKeyEvent(const KeyState &ks) {
        event = Event();
        event.type = EVENT_KEYDOWN;
        event.kbd = ks;
    }
 
    void setLeftClickEvent() {
        setEvent(EVENT_LBUTTONDOWN);
    }
 
    void setMiddleClickEvent() {
        setEvent(EVENT_MBUTTONDOWN);
    }
 
    void setRightClickEvent() {
        setEvent(EVENT_RBUTTONDOWN);
    }
 
    void setMouseWheelUpEvent() {
        setEvent(EVENT_WHEELUP);
    }
 
    void setMouseWheelDownEvent() {
        setEvent(EVENT_WHEELDOWN);
    }
 
    void setX1ClickEvent() {
        setEvent(EVENT_X1BUTTONDOWN);
    }
 
    void setX2ClickEvent() {
        setEvent(EVENT_X2BUTTONDOWN);
    }
 
    void allowKbdRepeats() {
        _shouldTriggerOnKbdRepeats = true;
    }
 
    bool shouldTriggerOnKbdRepeats() const { return _shouldTriggerOnKbdRepeats; }
 
    void addDefaultInputMapping(const String &hwId);
 
    const Array<String> &getDefaultInputMapping() const {
        return _defaultInputMapping;
    }
 
};
 
} // End of namespace Common
 
#endif // #ifndef COMMON_ACTION_H