guielement.h

Go to the documentation of this file.

/********************************************************************************/
/*                                                                              */
/*  Netrinjo-Engine - a library for game-development                            */
/*  Copyright (C) 1999-2006 by Tobias Nadler and Georg Schnattinger             */
/*                                                                              */
/*  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA   */
/*                                                                              */
/********************************************************************************/

#ifndef GUIELEMENT_H
#define GUIELEMENT_H

#include "SDL/SDL.h"
#include "uiobject.h"

class TiXmlElement;

class DECLSPEC GuiElement : public UiObject
{
public:
    DECLSPEC GuiElement( const SDL_Rect &r, GuiElement *p, const char *name );
    DECLSPEC GuiElement( TiXmlElement *el, GuiElement *p );
    virtual DECLSPEC ~GuiElement();

    virtual const char *getClassName()  { return "GuiElement"; }
    virtual bool isGuiElement() const   { return true; }

    DECLSPEC void resizeTo( Uint32 w, Uint32 h );
    DECLSPEC void resizeBy( Sint32 dw, Sint32 dh );
    DECLSPEC void moveTo( Sint32 x, Sint32 y );
    DECLSPEC void moveRelCenterTo( Sint32 x, Sint32 y );
    DECLSPEC void moveBy( Sint32 x, Sint32 y );
    DECLSPEC void getWndSize( Uint32 &w, Uint32 &h ) const;
    DECLSPEC SDL_Rect getRelWindow() const;
    DECLSPEC void setRelWindow( const SDL_Rect &r );
    DECLSPEC SDL_Rect getAbsWindow();
    DECLSPEC void setAbsWindow( const SDL_Rect &r );
    DECLSPEC SDL_Rect getClientWindow() const;
    DECLSPEC SDL_Rect getDrawWindow();
    DECLSPEC void getRelCenterPoint( Sint32 &x, Sint32 &y );
    DECLSPEC void getAbsCenterPoint( Sint32 &x, Sint32 &y );
    DECLSPEC void getClientCenterPoint( Sint32 &x, Sint32 &y );
    DECLSPEC SDL_Rect getClip();
    /*
    Gets the rect of apperance on the surface where it is drawed.
    \returns the window's blitting rect
    * /
    DECLSPEC SDL_Rect getDrawWindow();*/
    DECLSPEC GuiElement *getParent() const;
    DECLSPEC GuiElement *getToplevel();
    DECLSPEC void setVisible( bool b );
    DECLSPEC bool isVisible() const;
    DECLSPEC void setEnabled( bool b );
    DECLSPEC bool isEnabled() const;
    DECLSPEC void setRedraw();
    bool getRedraw()    {return bRedraw;}
    virtual bool hasSurface() const { return false; }

    static GuiElement *create(TiXmlElement *el, GuiElement *parent = NULL);
    static GuiElement *createWithoutChildren(TiXmlElement *el, GuiElement *parent = NULL);
    
    // just for usage via BasicSlot
    static void newelement(void *presult, BasicObject *o, void *xmldata)
    {
        GuiElement *r = new GuiElement((TiXmlElement*)xmldata, (GuiElement*)o);
        *(GuiElement**)presult = r;
    }
    static void togglevisibility(void *sender, BasicObject *aim, void *)
    {
        ((GuiElement *)aim)->setVisible( !((GuiElement *)aim)->isVisible() );
    }

protected:
    virtual DECLSPEC Uint32 onMouseOver();
    virtual DECLSPEC Uint32 onMouseOut();
    virtual Uint32 onMouseMove(Uint32 x, Uint32 y)  { return 0; }
    virtual Uint32 onResize()       { return 0; }
    virtual DECLSPEC Uint32 onFrame(SdlSurface * dest);
    virtual DECLSPEC void onInit();
    virtual DECLSPEC void onDestroy();
    virtual DECLSPEC Uint32 onThemeChanged( UiTheme *t );
    virtual DECLSPEC void onEnabledChanged( bool enabled );

    virtual void incRequireOnFrame()    {if(geParent) geParent->incRequireOnFrame();}
    virtual void decRequireOnFrame()    {if(geParent) geParent->decRequireOnFrame();}
    void setDrawRectDirty();

private:
    void setWndDirty();
    GuiElement *elementFromPos( Sint32 x, Sint32 y );

    // the relative window rect
    SDL_Rect wnd;
    bool bVisible, bEnabled;
// Optimization
    bool bClipdirty, bAbsdirty, bDrawdirty;
    SDL_Rect clip;
    SDL_Rect abswnd;
    SDL_Rect drawwnd;

    GuiElement *geParent;

    // whether repainting is necessary, see setRedraw()
    bool bRedraw;

    friend class GuiManager;
};

#endif

---