subtitles.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_SUBTITLES_H
#define XEEN_SUBTITLES_H

#include "common/str-array.h"
#include "xeen/sprites.h"

namespace Xeen {

class Subtitles {
private:
    Common::StringArray _lines;
    int _lineNum;
    SpriteResource *_boxSprites;
    int _lineEnd, _lineSize;
    Common::String _displayLine;
private:
    void loadSubtitles();

    void markTime();

    bool timeElapsed() const;
public:
    Subtitles();

    virtual ~Subtitles();

    void setLine(int line);

    void reset();

    bool active() const;

    bool lineActive() const;

    void show();

    bool wait(uint numFrames, bool interruptable = true);

    bool waitForLineOrSound();
};

} // End of namespace Xeen

#endif /* XEEN_SUBTITLES_H */