CUI_Frame.h

Go to the documentation of this file.

#ifndef CUI_FRAME_H
#define CUI_FRAME_H

#include <list>
#include <stdio.h>

#include "UI_Lib.h"
#include "UI_types.h"
#include "IUI_Border.h"
#include "IUI_Renderer.h"
#include "IUI_Font.h"
#include "CUI_CoordSys.h"


#define UI_INACTIVE             0x0001

#define UI_DISABLED             0x0002

#define UI_HOVER                0x0004

#define UI_CLICKED              0x0008

#define UI_SELECTED             0x0010

#define UI_VERTICAL             0x0020

#define UI_SQUEEZE              0x0040

#define UI_INVERT               0x0080

class CUI_UI;


class GLGUI_ENTRY CUI_Frame
{
public: 
        CUI_Frame( CUI_UI *ui = NULL, float x = 0, float y = 0, float x2 = 1, float y2 = 1,
                                CUI_Frame *parent = NULL, IUI_Shader *shader = NULL,
                                IUI_Shader *cursor = NULL, CUI_CoordSys *coordsys = NULL );

        virtual ~CUI_Frame();

        virtual bool SetUI( CUI_UI *ui )
        { m_ui = ui; return false; }


        virtual bool AddChild( CUI_Frame *frame, bool back = false );


        virtual bool DeleteChild( CUI_Frame *frame );


        virtual bool SetParent( CUI_Frame *frame );

        virtual CUI_Frame *GetParent( void );

        virtual bool SetCursor( IUI_Shader *cursor );

        virtual bool SetShader( IUI_Shader *shader );

        virtual bool SetCoordSys( CUI_CoordSys *coordsys );

        virtual CUI_CoordSys *GetCoordSys( void ) { return m_coordsys; }

        virtual bool SetBorder( IUI_Border *border ) { return false; }

        virtual IUI_Border *GetBorder( void ) { return NULL; }

        virtual bool SetFont( IUI_Font *font ) { return false; }

        virtual IUI_Font *GetFont( void ) { return NULL; }


        virtual bool Move( float x, float y, float x2, float y2 );


        virtual bool Move( float x, float y );


        virtual void GetRect( v4_f rect );


        virtual bool Convert( float &x, float &y );


        virtual bool ConvertFromGlobal( float &x, float &y );

        virtual bool Save( char *filename );
        virtual bool Save( FILE *file );


        virtual bool SetToRange( IUI_Renderer *renderer );

        virtual bool Render( double dtime, IUI_Renderer *renderer );

        virtual bool RenderStart( double dtime, IUI_Renderer *renderer );

        virtual bool RenderBackground( double dtime, IUI_Renderer *renderer );

        virtual bool RenderChildren( double dtime, IUI_Renderer *renderer );


        virtual bool Animate( double dtime, IUI_Renderer *renderer );


        virtual CUI_Frame* TestHit( float x, float y );

        virtual bool BringToFront( void );

        virtual IUI_Shader* GetShader( void );

        virtual IUI_Shader* GetCursor( void );

        virtual bool SetFrameID( unsigned long id )
        { m_frameID = id; return false; }

        virtual unsigned long GetFrameID( void )
        { return m_frameID; }

        virtual bool SetFlag( unsigned long flag, bool set );
        virtual bool GetFlag( unsigned long flag );

        virtual bool Activate( bool active = true );
        virtual bool Enable( bool enable = true );

        virtual bool AddClickableToList( void *voidlist );

        virtual bool IsClickable( ) { return false; }


        virtual bool Click( int &id, int &numparam, void **param ) { return false; }

        virtual bool IsDraggable( ) {return false; }


        virtual bool Drag( float x, float y, float dx, float dy, int &id, int &numparam, void **param ) { return false; }


        virtual void DeleteParam( void *param ) { assert( 1 ); };
        

        virtual bool ProcessKey( unsigned long key ) { return false; }

        typedef bool (*callbackfunc)(int id, int numparam, void *param);


        virtual bool SetFrameCallback( callbackfunc func )
        { m_callbackFunc = func; return false; }


        virtual bool CallbackFunc( int id, int numparam, void *param );


        virtual bool IsControl( )
        { return false; }

        virtual bool SetText( const char *text )
        { return false; }

        virtual bool SetToolTipText( char *text );

        virtual bool SetToolTipFrame( CUI_Frame *frame )
        { m_toolTipFrame = frame; return false; }


        virtual CUI_Frame *GetToolTipFrame( )
        { return m_toolTipFrame; }

        virtual char *GetToolTipText()
        { return m_toolTipText; }
        

        virtual bool ResetCounter( bool count )
        { m_counter = 0; m_count = count; return false; }

        virtual double GetCounter( )
        { return m_counter; }

        typedef enum animation_t {UI_NONE, UI_FADELINE, UI_FADESIN};

        virtual bool SetAnimation( animation_t anim )
        { m_animation = anim; return false; }

        virtual animation_t GetAnimation( )
        { return m_animation; }


        virtual void SetOwnedByUI( )
        { m_ownedByUI = true; }

        virtual bool IsOwnedByUI( )
        { return m_ownedByUI; }

protected:

        CUI_UI *m_ui;


        unsigned long m_frameID;


        callbackfunc m_callbackFunc;

        IUI_Shader *m_cursor;
        IUI_Shader *m_shader;
        CUI_CoordSys *m_coordsys;

        CUI_Frame* m_parent;
        std::list<CUI_Frame *> m_frames;

        float m_x;
        float m_y;
        float m_x2;
        float m_y2;

        unsigned int m_flags;

        char *m_toolTipText;

        CUI_Frame *m_toolTipFrame;

        double m_counter;

        bool m_count;

        animation_t m_animation;

        float m_oldFade;

        bool m_ownedByUI;
};

GLGUI_ENTRY typedef std::list<CUI_Frame*> FRAMELIST;

#endif

---