keyboardconfig.h

Go to the documentation of this file.

/*
 *  Custom keyboard shortcuts configuration
 *  Copyright (C) 2007  Joshua Langley <joshlangley@optusnet.com.au>
 *  Copyright (C) 2008-2009  The Mana Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  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
 *  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/>.
 */
 
#pragma once
 
#include <cstdint>
#include <string>
 
#include <SDL.h>
 
struct KeyFunction
{
    const char* configField;    
    int defaultValue;           
    SDL_Keycode value;          
};
 
class Setup_Keyboard;
 
class KeyboardConfig
{
    public:
        void init();
 
        void retrieve();
 
        void store();
 
        void makeDefault();
 
        bool hasConflicts();
 
        void callbackNewKey();
 
        int getKeyValue(int index) const
        { return mKey[index].value; }
 
        int getNewKeyIndex() const
        { return mNewKeyIndex; }
 
        bool isEnabled() const
        { return mEnabled; }
 
        const std::string &getKeyCaption(int index) const;
 
        int getKeyIndex(SDL_Keycode keyValue) const;
 
        std::string_view getKeyName(std::string_view configName) const;
 
        int getKeyEmoteOffset(SDL_Keycode keyValue) const;
 
        void setEnabled(bool flag)
        { mEnabled = flag; }
 
        void setNewKeyIndex(int value)
        { mNewKeyIndex = value; }
 
        void setNewKey(SDL_Keycode value)
        { mKey[mNewKeyIndex].value = value; }
 
        void setSetupKeyboard(Setup_Keyboard *setupKey)
        { mSetupKey = setupKey; }
 
        bool isKeyActive(int index) const;
 
        void refreshActiveKeys();
 
        std::string getBindError() const
        { return mBindError; }
 
        enum KeyAction
        {
            KEY_NO_VALUE = -1,
            KEY_MOVE_UP,
            KEY_MOVE_DOWN,
            KEY_MOVE_LEFT,
            KEY_MOVE_RIGHT,
            KEY_ATTACK,
            KEY_TARGET_ATTACK,
            KEY_EMOTE,
            KEY_TALK,
            KEY_TARGET,
            KEY_TARGET_CLOSEST,
            KEY_TARGET_NPC,
            KEY_TARGET_PLAYER,
            KEY_PICKUP,
            KEY_HIDE_WINDOWS,
            KEY_SIT,
            KEY_SCREENSHOT,
            KEY_TRADE,
            KEY_SHORTCUT_1,
            KEY_SHORTCUT_2,
            KEY_SHORTCUT_3,
            KEY_SHORTCUT_4,
            KEY_SHORTCUT_5,
            KEY_SHORTCUT_6,
            KEY_SHORTCUT_7,
            KEY_SHORTCUT_8,
            KEY_SHORTCUT_9,
            KEY_SHORTCUT_10,
            KEY_SHORTCUT_11,
            KEY_SHORTCUT_12,
            KEY_WINDOW_HELP,
            KEY_WINDOW_STATUS,
            KEY_WINDOW_INVENTORY,
            KEY_WINDOW_EQUIPMENT,
            KEY_WINDOW_SKILL,
            KEY_WINDOW_QUESTS,
            KEY_WINDOW_MINIMAP,
            KEY_WINDOW_CHAT,
            KEY_WINDOW_SHORTCUT,
            KEY_WINDOW_SETUP,
            KEY_WINDOW_DEBUG,
            KEY_WINDOW_SOCIAL,
            KEY_WINDOW_EMOTE_SHORTCUT,
            KEY_WINDOW_OUTFIT,
            KEY_WEAR_OUTFIT,
            KEY_COPY_OUTFIT,
            KEY_EMOTE_1,
            KEY_EMOTE_2,
            KEY_EMOTE_3,
            KEY_EMOTE_4,
            KEY_EMOTE_5,
            KEY_EMOTE_6,
            KEY_EMOTE_7,
            KEY_EMOTE_8,
            KEY_EMOTE_9,
            KEY_EMOTE_10,
            KEY_EMOTE_11,
            KEY_EMOTE_12,
            KEY_TOGGLE_CHAT,
            KEY_SCROLL_CHAT_UP,
            KEY_SCROLL_CHAT_DOWN,
            KEY_PREV_CHAT_TAB,
            KEY_NEXT_CHAT_TAB,
            KEY_OK,
            KEY_QUIT,
            KEY_IGNORE_INPUT_1,
            KEY_IGNORE_INPUT_2,
            KEY_TOTAL
        };
 
    private:
        int mNewKeyIndex;              
        bool mEnabled;                 
        Setup_Keyboard *mSetupKey;     
        KeyFunction mKey[KEY_TOTAL];   
        const uint8_t *mActiveKeys;    
        std::string mBindError;
};
 
extern KeyboardConfig keyboard;