scalpel_user_interface.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 SHERLOCK_SCALPEL_UI_H
#define SHERLOCK_SCALPEL_UI_H

#include "common/scummsys.h"
#include "sherlock/user_interface.h"

namespace Sherlock {

class Inventory;
class Talk;

namespace Scalpel {

extern const int MENU_POINTS[12][4];

extern const int INVENTORY_POINTS[8][3];

enum {
    MAINBUTTON_LOOK = 0,
    MAINBUTTON_MOVE,
    MAINBUTTON_TALK,
    MAINBUTTON_PICKUP,
    MAINBUTTON_OPEN,
    MAINBUTTON_CLOSE,
    MAINBUTTON_INVENTORY,
    MAINBUTTON_USE,
    MAINBUTTON_GIVE,
    MAINBUTTON_JOURNAL,
    MAINBUTTON_FILES,
    MAINBUTTON_SETUP,
    MAINBUTTON_LOADGAME,
    MAINBUTTON_SAVEGAME
};

class Settings;

class ScalpelUserInterface: public UserInterface {
    friend class Settings;
    friend class Sherlock::Talk;
private:
    char _keyPress;
    int _lookHelp;
    int _help, _oldHelp;
    int _key, _oldKey;
    int _temp, _oldTemp; // button number (0-11)
    int _oldLook;
    bool _keyboardInput;
    bool _pause;
    int _cNum;
    Common::String _cAnimStr;
    Common::String _descStr;
    int _find;
private:
    void depressButton(int num);

    void pushButton(int num);

    void toggleButton(uint16 num);

    void lookScreen(const Common::Point &pt);

    void lookInv();

    void doEnvControl();

    void doInvControl();

    void doLookControl();

    void doMainControl();

    void doMiscControl(int allowed);

    void doPickControl();

    void doTalkControl();

    void journalControl();

    void checkUseAction(const UseType *use, const Common::String &invName, FixedTextActionId fixedTextActionId,
        int objNum, bool giveMode);

    void printObjectDesc(const Common::String &str, bool firstTime);
public:
    ImageFile *_controlPanel;
        ImageFile *_controls;
    int _oldUse;

    byte _hotkeyLook;
    byte _hotkeyMove;
    byte _hotkeyTalk;
    byte _hotkeyPickUp;
    byte _hotkeyOpen;
    byte _hotkeyClose;
    byte _hotkeyInventory;
    byte _hotkeyUse;
    byte _hotkeyGive;
    byte _hotkeyJournal; // not used for 3DO
    byte _hotkeyFiles; // not used for 3DO
    byte _hotkeySetUp; // SetUp-button is in the spot of Journal for 3DO
    byte _hotkeyLoadGame; // 3DO
    byte _hotkeySaveGame; // 3DO

    byte _hotkeysIndexed[14];

public:
    ScalpelUserInterface(SherlockEngine *vm);
    ~ScalpelUserInterface() override;

    void whileMenuCounter();

    void restoreButton(int num);

    void examine();

    Common::Point getTopLeftButtonPoint(int num) const;
    Common::Rect getButtonRect(int buttonNr) const;
    int infoLineHeight() const;
    int infoLineYOffset() const;

public:
    void reset() override;

    void handleInput() override;

    void drawInterface(int bufferNum = 3) override;

    void summonWindow(const Surface &bgSurface, bool slideUp = true) override;

    void summonWindow(bool slideUp = true, int height = CONTROLS_Y) override;

    void banishWindow(bool slideUp = true) override;

    void clearInfo() override;

    void clearWindow() override;

    virtual void printObjectDesc();
};

} // End of namespace Scalpel

} // End of namespace Sherlock

#endif