widget.h

Go to the documentation of this file.

/*      _______   __   __   __   ______   __   __   _______   __   __
 *     / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___  /\ /  |\/ /\
 *    / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
 *   / / /__   / / // / // / // / /    / ___  / // ___  / // /| ' / /
 *  / /_// /\ / /_// / // / // /_/_   / / // / // /\_/ / // / |  / /
 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
 *
 * Copyright (c) 2004, 2005 darkbits                        Js_./
 * Per Larsson a.k.a finalman                          _RqZ{a<^_aa
 * Olof Naess�n a.k.a jansem/yakslem                _asww7!uY`>  )\a//
 *                                                 _Qhm`] _f "'c  1!5m
 * Visit: http://guichan.darkbits.org             )Qk<P ` _: :+' .'  "{[
 *                                               .)j(] .d_/ '-(  P .   S
 * License: (BSD)                                <Td/Z <fP"5(\"??"\a.  .L
 * Redistribution and use in source and          _dV>ws?a-?'      ._/L  #'
 * binary forms, with or without                 )4d[#7r, .   '     )d`)[
 * modification, are permitted provided         _Q-5'5W..j/?'   -?!\)cam'
 * that the following conditions are met:       j<<WP+k/);.        _W=j f
 * 1. Redistributions of source code must       .$%w\/]Q  . ."'  .  mj$
 *    retain the above copyright notice,        ]E.pYY(Q]>.   a     J@\
 *    this list of conditions and the           j(]1u<sE"L,. .   ./^ ]{a
 *    following disclaimer.                     4'_uomm\.  )L);-4     (3=
 * 2. Redistributions in binary form must        )_]X{Z('a_"a7'<a"a,  ]"[
 *    reproduce the above copyright notice,       #}<]m7`Za??4,P-"'7. ).m
 *    this list of conditions and the            ]d2e)Q(<Q(  ?94   b-  LQ/
 *    following disclaimer in the                <B!</]C)d_, '(<' .f. =C+m
 *    documentation and/or other materials      .Z!=J ]e []('-4f _ ) -.)m]'
 *    provided with the distribution.          .w[5]' _[ /.)_-"+?   _/ <W"
 * 3. Neither the name of Guichan nor the      :$we` _! + _/ .        j?
 *    names of its contributors may be used     =3)= _f  (_yQmWW$#(    "
 *    to endorse or promote products derived     -   W,  sQQQQmZQ#Wwa]..
 *    from this software without specific        (js, \[QQW$QWW#?!V"".
 *    prior written permission.                    ]y:.<\..          .
 *                                                 -]n w/ '         [.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT       )/ )/           !
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY         <  (; sac    ,    '
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING,               ]^ .-  %
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF            c <   r
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR            aga<  <La
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE          5%  )P'-3L
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR        _bQf` y`..)a
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,          ,J?4P'.P"_(\?d'.,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES               _Pa,)!f/<[]/  ?"
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT      _2-..:. .r+_,.. .
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     ?a.<%"'  " -'.a_ _,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION)                     ^
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef GCN_WIDGET_HPP
#define GCN_WIDGET_HPP
 
#include <list>
#include <string>
 
#include "guichan/actionlistener.h"
#include "guichan/color.h"
#include "guichan/defaultfont.h"
#include "guichan/font.h"
#include "guichan/graphics.h"
#include "guichan/keyinput.h"
#include "guichan/keylistener.h"
#include "guichan/mouseinput.h"
#include "guichan/mouselistener.h"
#include "guichan/rectangle.h"
#include "guichan/platform.h"
 
namespace gcn
{
    /*
     * Exists for the widget class to compile.
     */
    class FocusHandler;
 
    /*
     * Exists for the widget class to compile.
     */
    class BasicContainer;
 
    class GCN_CORE_DECLSPEC Widget
    {
        friend class BasicContainer;
    public:
        Widget();
 
        virtual ~Widget();
 
        virtual void draw(Graphics* graphics) = 0;
 
        virtual void drawBorder(Graphics*) { }
 
        virtual void logic() { }
 
        virtual BasicContainer* getParent() const;
 
        virtual void setWidth(int width);
 
        virtual int getWidth() const;
 
        virtual void setHeight(int height);
 
        virtual int getHeight() const;
 
        virtual void setSize(int width, int height);
 
        virtual void setX(int x);
 
        virtual int getX() const;
 
        virtual void setY(int y);
 
        virtual int getY() const;
 
        virtual void setPosition(int x, int y);
 
        virtual void setDimension(const Rectangle& dimension);
 
        virtual void setBorderSize(unsigned int borderSize);
 
        virtual unsigned int getBorderSize() const;
 
        virtual const Rectangle& getDimension() const;
 
        virtual void setFocusable(bool focusable);
 
        virtual bool isFocusable() const;
 
        virtual bool hasFocus() const;
 
        virtual void setEnabled(bool enabled);
 
        virtual bool isEnabled() const;
 
        virtual void lostFocus() { setDirty(true); };
 
        virtual void gotFocus() { setDirty(true); };
 
        virtual bool hasMouse() const;
 
        virtual void setVisible(bool visible);
 
        virtual bool isVisible() const;
 
        virtual void setBaseColor(const Color& color);
 
        virtual const Color& getBaseColor() const;
 
        virtual void setForegroundColor(const Color& color);
 
        virtual const Color& getForegroundColor() const;
 
        virtual void setBackgroundColor(const Color& color);
 
        virtual const Color& getBackgroundColor() const;
 
        virtual void setDisabledColor(const Color& color);
 
        virtual const Color& getDisabledColor() const;
 
        virtual void _mouseInputMessage(const MouseInput& mouseInput);
 
        virtual bool _keyInputMessage(const KeyInput& keyInput);
 
        virtual void hotKeyPress() {}
 
        virtual void hotKeyRelease() {}
 
        virtual void _mouseInMessage();
 
        virtual void _mouseOutMessage();
 
        virtual void requestFocus();
 
        virtual void requestMoveToTop();
 
        virtual void requestMoveToBottom();
 
        virtual void _setFocusHandler(FocusHandler* focusHandler);
 
        virtual FocusHandler* _getFocusHandler();
 
        virtual void addActionListener(ActionListener* actionListener);
 
        virtual    void removeActionListener(ActionListener* actionListener);
 
        virtual    void addMouseListener(MouseListener* mouseListener);
 
        virtual    void removeMouseListener(MouseListener* mouseListener);
 
        virtual    void addKeyListener(KeyListener* keyListener);
 
        virtual    void removeKeyListener(KeyListener* keyListener);
 
        virtual    void setEventId(const std::string& eventId);
 
        virtual const std::string& getEventId() const;
 
        virtual    void getAbsolutePosition(int& x, int& y) const;
 
        virtual    void _setParent(BasicContainer* parent);
 
        Font *getFont() const;
 
        static void setGlobalFont(Font* font);
 
        virtual void setFont(Font* font);
 
        virtual void fontChanged() { }
 
        virtual int getHotKey() const { return mHotKey; }
 
        virtual void setHotKey(const int key);
        virtual void setHotKey(const char *key);
 
        static bool widgetExists(const Widget* widget);
 
        virtual bool isTabInEnabled() const;
 
        virtual void setTabInEnabled(bool enabled);
 
        virtual bool isTabOutEnabled() const;
 
        virtual void setTabOutEnabled(bool enabled);
 
        virtual bool isDragged() const;
 
        virtual void requestModalFocus();
 
        virtual void releaseModalFocus();
 
        virtual bool hasModalFocus() const;
 
        virtual void setDirty(bool dirty);
        virtual bool getDirty() const;
 
 
    protected:
        void generateAction();
 
        typedef std::list<MouseListener*> MouseListenerList;
        MouseListenerList mMouseListeners;
        typedef MouseListenerList::iterator MouseListenerIterator;
 
        typedef std::list<KeyListener*> KeyListenerList;
        KeyListenerList mKeyListeners;
        typedef KeyListenerList::iterator KeyListenerIterator;
 
        typedef std::list<ActionListener*> ActionListenerList;
        ActionListenerList mActionListeners;
        typedef ActionListenerList::iterator ActionListenerIterator;
 
        Color mForegroundColor;
        Color mBackgroundColor;
        Color mBaseColor;
        Color mDisabledColor;
        FocusHandler* mFocusHandler;
        BasicContainer* mParent;
        Rectangle mDimension;
        unsigned int mBorderSize;
        std::string mEventId;
        int mClickTimeStamp;
        int mClickCount;
        int mClickButton;
        bool mHasMouse;
        bool mFocusable;
        bool mVisible;
        bool mTabIn;
        bool mTabOut;
        bool mEnabled;
 
        Font* mCurrentFont;
        int mHotKey;
        static DefaultFont mDefaultFont;
        static Font* mGlobalFont;
        static std::list<Widget*> mWidgets;
        bool mDirty;
    };
}
 
#endif // end GCN_WIDGET_HPP
 
/*
 * yakslem  - "I have a really great idea! Why not have an
 *             interesting and funny quote or story at the
 *             end of every source file."
 * finalman - "Yeah - good idea! .... do you know any funny
 *             quotes?"
 * yakslem  - "Well.. I guess not. I just thought it would be
 *             fun to tell funny quotes."
 * finalman - "That's not a very funny quote. But i believe
 *             pointless quotes are funny in their own pointless
 *             way."
 * yakslem  - "...eh...ok..."
 */