psmousebinds.h

Go to the documentation of this file.

/*
 * psmousebinds.h - Author: Andrew Robberts
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.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 (version 2 of the License)
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef PAWS_MOUSE_BINDS_HEADER
#define PAWS_MOUSE_BINDS_HEADER

#include <csutil/ref.h>
#include <csutil/list.h>
#include <csutil/parray.h>
#include <csutil/array.h>
#include <iutil/event.h>
#include <csutil/parray.h>

#include <iutil/vfs.h>
#include <iutil/document.h>

struct iObjectRegistry;
struct iEvent;

// structure to hold each action and mouse actions that is associated with it
struct psMouseBind
{
    csString          action;
    csMouseEventData  event;
};

// structure to hold boolean mouse settings
struct psMouseOnOff
{
    csString option;
    bool     value;
};

// structure to hold integer mouse settings
struct psMouseInt
{
    csString option;
    int value;
};

class psMouseBinds
{
public:
    psMouseBinds() {}

    bool LoadFromFile(iObjectRegistry* object_reg, const csString &filename);


    bool SaveToFile(iObjectRegistry* object_reg, const csString &filename);


    void Bind(const csString &action, csMouseEventData &event);

    void Bind(const csString &action, csString &event, csString &ctrl);
    void Bind(const csString &action, int button, int modifier);


    void SetOnOff(const csString &option, csString &value);
    void SetOnOff(const csString &option, bool value);


    void SetInt(const csString &option, csString &value);
    void SetInt(const csString &option, int value);


    bool GetBind(const csString &action, csMouseEventData &event);
    bool GetBind(const csString &action, csString &button);

    bool CheckBind(const csString &action, int button, int modifiers);

    bool GetOnOff(const csString &option, csString &value);
    bool GetOnOff(const csString &option, bool &value);


    bool GetInt(const csString &option, csString &value);
    bool GetInt(const csString &option, int &value);


    void Unbind(const csString &action);


    void RemoveOnOff(const csString &option);


    void RemoveInt(const csString &option);


    void UnbindAll();

    static csString MouseButtonToString(uint button, uint32 modifiers);
    static bool StringToMouseButton(const csString &str, uint &button, uint32 &modifiers);

protected:

    psMouseBind* FindAction(const csString &action);


    psMouseOnOff* FindOnOff(const csString &option);


    psMouseInt* FindInt(const csString &option);

    csPDelArray<psMouseBind> binds;
    csPDelArray<psMouseOnOff> boolOptions;
    csPDelArray<psMouseInt> intOptions;
};

#endif