controls32.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 SCI_GRAPHICS_CONTROLS32_H
#define SCI_GRAPHICS_CONTROLS32_H

#include "sci/graphics/text32.h"

namespace Sci {

class GfxCache;
class GfxScreen;
class GfxText32;

enum MessageBoxStyle {
    kMessageBoxOK    = 0x0,
    kMessageBoxYesNo = 0x4
};

struct TextEditor {
    reg_t bitmap;

    int16 width;

    Common::String text;

    Common::Rect textRect;

    int16 borderColor;

    uint8 foreColor;

    uint8 backColor;

    uint8 skipColor;

    GuiResourceId fontId;

    uint16 cursorCharPosition;

    bool cursorIsDrawn;

    Common::Rect cursorRect;

    uint16 maxLength;
};

struct ScrollWindowEntry {
    reg_t id;

    TextAlign alignment;

    int16 foreColor;

    GuiResourceId fontId;

    Common::String text;
};

class ScreenItem;

class ScrollWindow {
public:
    ScrollWindow(SegManager *segMan, const Common::Rect &gameRect, const Common::Point &position, const reg_t planeObj, const uint8 defaultForeColor, const uint8 defaultBackColor, const GuiResourceId defaultFontId, const TextAlign defaultAlignment, const int16 defaultBorderColor, const uint16 maxNumEntries);
    ~ScrollWindow();

    reg_t add(const Common::String &text, const GuiResourceId fontId, const int16 foreColor, const TextAlign alignment, const bool scrollTo);

    reg_t modify(const reg_t id, const Common::String &text, const GuiResourceId fontId, const int16 foreColor, const TextAlign alignment, const bool scrollTo);

    void show();

    void hide();

    Ratio where() const;

    void go(const Ratio location);

    void home();

    void end();

    void upArrow();

    void downArrow();

    void pageUp();

    void pageDown();

    const reg_t getBitmap() const { return _bitmap; }

private:
    SegManager *_segMan;

    typedef Common::Array<ScrollWindowEntry> EntriesList;

    void fillEntry(ScrollWindowEntry &entry, const Common::String &text, const GuiResourceId fontId, const int16 foreColor, const TextAlign alignment);

    void computeLineIndices();

    void update(const bool doFrameOut);

    GfxText32 _gfxText32;

    EntriesList _entries;

    uint _maxNumEntries;

    Common::Array<int> _startsOfLines;

    Common::String _text;

    Common::String _visibleText;

    int _firstVisibleChar;

    int _topVisibleLine;

    int _lastVisibleChar;

    int _bottomVisibleLine;

    int _numLines;

    int _numVisibleLines;

    reg_t _plane;

    uint8 _foreColor;

    uint8 _backColor;

    int16 _borderColor;

    GuiResourceId _fontId;

    TextAlign _alignment;

    bool _visible;

    Common::Rect _textRect;

    Common::Point _position;

    uint8 _pointSize;

    reg_t _bitmap;

    uint16 _nextEntryId;

    ScreenItem *_screenItem;
};

class GfxControls32 {
public:
    GfxControls32(SegManager *segMan, GfxCache *cache, GfxText32 *text);
    ~GfxControls32();

private:
    SegManager *_segMan;
    GfxCache *_gfxCache;
    GfxText32 *_gfxText32;

#pragma mark -
#pragma mark Text input control
public:
    reg_t kernelEditText(const reg_t controlObject);
    reg_t kernelInputText(const reg_t textObject, const reg_t titleTextObject, const int16 maxTextLength);

private:
    bool _overwriteMode;

    uint32 _nextCursorFlashTick;

    void drawCursor(TextEditor &editor);

    void eraseCursor(TextEditor &editor);

    void flashCursor(TextEditor &editor);

    bool processEditTextEvent(const SciEvent &event, TextEditor &editor, ScreenItem *screenItem, bool &clearTextOnInput);

#pragma mark -
#pragma mark Scrollable window control
public:
    reg_t makeScrollWindow(const Common::Rect &gameRect, const Common::Point &position, const reg_t plane, const uint8 defaultForeColor, const uint8 defaultBackColor, const GuiResourceId defaultFontId, const TextAlign defaultAlignment, const int16 defaultBorderColor, const uint16 maxNumEntries);

    ScrollWindow *getScrollWindow(const reg_t id);

    void destroyScrollWindow(const reg_t id);

private:
    typedef Common::HashMap<uint16, ScrollWindow *> ScrollWindowMap;

    uint16 _nextScrollWindowId;

    ScrollWindowMap _scrollWindows;

#pragma mark -
#pragma mark Message box
public:
    reg_t kernelMessageBox(const Common::String &message, const Common::String &title, const uint16 style);

private:
    int16 showMessageBox(const Common::U32String &message, const Common::U32String &okLabel, const Common::U32String &altLabel, const int16 okValue, const int16 altValue);
};

} // End of namespace Sci

#endif // SCI_GRAPHICS_CONTROLS32_H