/***************************************************************************
 *   Copyright (C) 2008 by Douglas Boffey                                  *
 *                                                                         *
 *       DougABoffey@netscape.net                                          *
 *   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 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed with The Mana Experiment                  *
 *   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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef _AETHYRA_TEXT_H
#define _AETHYRA_TEXT_H

#include "graphics.h"
#include "guichanfwd.h"

#include <list>

class TextManager;

class Text
{
        friend class TextManager;
    public:
        /**
         * Constructor creates a text object to display on the screen
         */
        Text(const std::string &text, int x, int y,
             gcn::Graphics::Alignment alignment, gcn::Font *font,
             gcn::Color colour);

        /**
         * Allows the originator of the text to specify the ideal coordinates
         */
        void
        adviseXY(int x, int y);

        /**
         * Remove the text from the screen
         */
        virtual ~Text();

        /**
         * Draws the text
         */
        virtual void
        draw(Graphics *graphics, int xOff, int yOff);

    protected:

        int mX; /**< Actual x-value of left of text written */
        int mY; /**< Actual y-value of top of text written */
        int mWidth; /**< The width of the text */
        int mHeight; /**< The height of the text */
        int mXOffset; /**< The offset of mX from the desired x */
        static int mInstances; /**< Instances of text */
        gcn::Font *mFont; /**< The font used */
        std::string mText; /**< The text to display */
        gcn::Color mColour; /**< The colour of the text */
};

class FlashText : public Text
{
    public:
        FlashText(const std::string &text, int x, int y,
                  gcn::Graphics::Alignment alignment, gcn::Font *font,
                  gcn::Color colour);

        /**
         * Remove the text from the screen
         */
        virtual ~FlashText();

        /**
         * Flash the text for so many refreshes
         */
        void flash(int time) {mTime = time; }

        /**
         * Draws the text
         */
        virtual void
        draw(Graphics *graphics, int xOff, int yOff);

    private:
        int mTime; /**< Time left for flashing */
};
#endif