dialogs.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 XEEN_DIALOGS_H
#define XEEN_DIALOGS_H

#include "common/array.h"
#include "common/stack.h"
#include "common/rect.h"
#include "mm/xeen/cutscenes.h"
#include "mm/xeen/sprites.h"
#include "mm/shared/xeen/xsurface.h"

namespace MM {
namespace Xeen {

class XeenEngine;

class UIButton {
public:
    Common::Rect _bounds;
    SpriteResource *_sprites;
    int _value;
    uint _frameNum, _selectedFrame;
    bool _draw;
#ifdef USE_TTS
    uint8 _ttsIndex;
    bool _canVoice;
#endif

    UIButton(const Common::Rect &bounds, int value, uint frameNum, SpriteResource *sprites, bool draw, uint8 ttsIndex, bool ttsCanVoice) :
        _bounds(bounds), _value(value), _frameNum(frameNum), _selectedFrame(frameNum | 1),
        _sprites(sprites), _draw(draw) {
#ifdef USE_TTS
        _ttsIndex = ttsIndex;
        _canVoice = ttsCanVoice;    
#endif
    }

    UIButton() : _value(0), _frameNum(0), _selectedFrame(0), _sprites(nullptr), _draw(false) {
#ifdef USE_TTS
        _ttsIndex = 0;
        _canVoice = false;
#endif
    }

    void setFrame(uint frameNum) {
        _frameNum = frameNum;
        _selectedFrame = frameNum | 1;
    }

    void setFrame(uint frameNum, uint selectedFrame) {
        _frameNum = frameNum;
        _selectedFrame = selectedFrame;
    }
};

class ButtonContainer : public Cutscenes {
private:
    Common::Stack< Common::Array<UIButton> > _savedButtons;
protected:
    Common::Array<UIButton> _buttons;
    Common::StringArray _textStrings;
    Common::Rect _waitBounds;
    int _buttonValue;
#ifdef USE_TTS
    Common::StringArray _buttonTexts;
    int _previousButton;
#endif

    bool checkEvents(XeenEngine *vm);

    bool doScroll(bool rollUp, bool fadeIn) override;

    void loadStrings(const Common::Path &name);

    void loadStrings(const Common::Path &name, int ccMode);

    void setWaitBounds();

#ifdef USE_TTS

    Common::String getNextTextSection(const Common::String &text, uint &index, uint count, const char *separator) const;

    Common::String getNextTextSection(const Common::String &text, uint &index, uint count) const;

    Common::String getNextTextSection(const Common::String &text, uint &index) const;

    Common::String addNextTextToButtons(const Common::String &text, uint &index);

    Common::String addNextTextToButtons(const Common::String &text, uint &index, uint count);

    void setButtonTexts(const Common::String &text);

    void disableButtonVoicing(uint startIndex, uint endIndex);

    void enableButtonVoicing(uint startIndex, uint endIndex);
#endif
public:
    ButtonContainer(XeenEngine *vm) : Cutscenes(vm), _buttonValue(0) {
#ifdef USE_TTS
        _previousButton = -1;
#endif
    }

    void saveButtons();

    void clearButtons();

    void restoreButtons();

    void addButton(const Common::Rect &bounds, int val,
        SpriteResource *sprites = nullptr, uint8 ttsIndex = UINT8_MAX);
    void addButton(const Common::Rect &bounds, int val,
        int frameNum, SpriteResource *sprites = nullptr, uint8 ttsIndex = UINT8_MAX);

    void addPartyButtons(XeenEngine *vm);

    void drawButtons(XSurface *surface);

    void clearEvents() { _buttonValue = 0; }

#ifdef USE_TTS

    void checkHoverOverButton();
#endif
};

class SettingsBaseDialog : public ButtonContainer {
protected:
    virtual void showContents(SpriteResource &title1, bool mode);
public:
    SettingsBaseDialog(XeenEngine *vm) : ButtonContainer(vm) {}

    ~SettingsBaseDialog() override {}
};

} // End of namespace Xeen
} // End of namespace MM

#endif