path: root/src/gui/textfield.h

/*
 *  The Mana World
 *  Copyright 2004 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World 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
 *  any later version.
 *
 *  The Mana World 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 The Mana World; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  $Id: textfield.h 4045 2008-04-07 15:23:07Z b_lindeijer $
 */

#ifndef __TMW_TEXTFIELD_H__
#define __TMW_TEXTFIELD_H__

#include <guichan/widgets/textfield.hpp>

#include "../guichanfwd.h"

class ImageRect;

class TextField;

class TextFieldListener
{
    public:
        virtual void listen(const TextField *value) = 0;
};

/**
 * A text field.
 *
 * \ingroup GUI
 */
class TextField : public gcn::TextField {
    public:
        /**
         * Constructor, initializes the text field with the given string.
         */
        TextField(const std::string& text = "");

        /**
         * Destructor.
         */
        ~TextField();

        /**
         * Draws the text field.
         */
        virtual void draw(gcn::Graphics *graphics);

        /**
         * Draws the background and border.
         */
        void drawFrame(gcn::Graphics *graphics);

        /**
         * Determine whether the field should be numeric or not
         */
        void setNumeric(bool numeric);

        /**
         * Set the range on the field if it is numeric
         */
        void setRange(int min, int max) {mMinimum = min; mMaximum = max; }

        /**
         * Restrict keyboard input if numeric
         */
        void keyPressed(gcn::KeyEvent &keyEvent);

        /**
         * Set the minimum value for a range
         */
        void setMinimum(int min) {mMinimum = min; }

        /**
         * Set the maximum value for a range
         */
        void setMaximum(int max) {mMaximum = max; }

        /**
         * Return the value for a numeric field
         */
        int getValue() const;

        /**
         * Add a listener
         */
        void addListener(TextFieldListener *listener) {mListener = listener; }

    private:
        static int instances;
        static ImageRect skin;
        bool mNumeric;
        int mMinimum;
        int mMaximum;
        TextFieldListener *mListener;
};

#endif