scummvm/engines/grim/textobject.h

/* Residual - A 3D game interpreter
 *
 * Residual 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 library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.

 * This library 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
 * Lesser General Public License for more details.

 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 *
 * $URL$
 * $Id$
 *
 */

#ifndef GRIM_TEXTOBJECT_H
#define GRIM_TEXTOBJECT_H

#include "engines/grim/gfx_base.h"

namespace Grim {

class SaveGame;
class Font;

struct TextObjectDefaults {
	Color *fgColor;
	int x, y;
	int width, height;
	int justify;
	bool disabled;
	Font *font;
};

#define TEXT_NULL   ' '

class TextObject : public Object {
public:
	TextObject(bool blastDraw, bool isSpeech = false);
	TextObject();
	~TextObject();
	void createBitmap();
	void destroyBitmap();
	void setDefaults(TextObjectDefaults *defaults);
	void setText(const char *text);
	void setX(int x) { _x = x; }
	void setY(int y) { _y = y; }
	void subBaseOffsetY();
	int getBaseOffsetY();
	void setWidth(int width) { _width = width; }
	void setHeight(int height) { _height = height; }
	void setFGColor(Color *fgColor) { _fgColor = fgColor; }
	void setFont(Font *font) { _font = font; }
	void setJustify(int justify) { _justify = justify; }
	void setDisabled(bool disabled) { _disabled = disabled; }
	int getBitmapWidth();
	int getBitmapHeight();
	int getTextCharPosition(int pos);

	const char *getName() const { return _textID; }
	void draw();

	void saveState(SaveGame *state) const;
	bool restoreState(SaveGame *state);

	enum Justify {
		NONE,
		CENTER,
		LJUSTIFY,
		RJUSTIFY
	};

protected:
	bool _created;
	Color *_fgColor;
	int _x, _y;
	int _width, _height;
	int _justify, _numberLines;
	bool _disabled;
	bool _blastDraw;
	bool _isSpeech;
	Font *_font;
	char _textID[256];
	uint8 *_textBitmap;
	int *_bitmapWidthPtr;
	GfxBase::TextObjectHandle **_textObjectHandle;

	friend class GrimEngine;
};

} // end of namespace Grim

#endif