GUI.h

/*
* Copyright (C) TES Electronic Solutions GmbH,
* All Rights Reserved.
* Contact: info@guiliani.de
*
* This file is part of the Guiliani HMI framework
* for the development of graphical user interfaces on embedded systems.
*/
 
#ifndef __GUI_H__
#define __GUI_H__
 
#include "GUICompositeObject.h"
 
#include "GUIImageResource.h"
 
class CGUIFakeMouseCursor;
 
// Helper macros
#define GETGUI CGUI::GetInstance()
 
 
class CGUI : public CGUICompositeObject
{
    friend class CGUIObject; 
    friend class CGUIDataPool;
    friend class CGUILocalisationTable;
    friend class CGUIResourceManager;
 
public:
    static inline CGUI& GetInstance() { assert(NULL != ms_pkInstance); return *ms_pkInstance; }
 
    static inline eC_Bool IsCreated() { return (ms_pkInstance != NULL); }
 
    static inline eC_Bool IsRunning() { return ms_bRunning; }
 
    void Quit();
 
    virtual void RequestQuit();
 
    eC_Bool FocusAny();
 
    eC_Bool Run();
 
    eC_Bool RunOnce();
 
    void FourWayFocusNext(FourWayFocus_t eFocusDirection);
 
    virtual void NotifyOfDestruction(const CGUIObject* pDestroyedObject) {}
 
    eC_UInt GetIdleTime() const;
 
    static const eC_String& GetVersionString();
 
    static const eC_UInt GetVersion();
 
    static eC_String GetLicenseString();
 
    static eC_String GetPlatformString();
 
    static void PrintLibraryInformation();
 
    static void SetGuilianiLicenseKey(const eC_Char* pcLicenseKey);
 
    static eC_Bool LoadGuilianiLicenseKey(const eC_String& kFilename);
 
    static eC_Bool IsLicenseActive();
 
    virtual eC_Bool DoPostDraw();
 
    virtual void DoCallAPI(const eC_String& kAPI, const eC_String& kParam) {}
 
    virtual CGUIObject* LoadDialog(const eC_String& kDialogName, eC_Bool& bUseSnapshot, GUIBitmapPlaneID_t& eBitmapPlaneID);
 
    void EnableMouseCursor();
 
    void DisableMouseCursor();
 
    void SetCursorImage(const ImageResource_t& eImage);
 
protected:
    CGUI(const eC_Value& vX, const eC_Value& vY, const eC_Value& vWidth, const eC_Value& vHeight, const ObjectHandle_t &eID = NO_HANDLE);
 
    CGUI(const CGUIRect &kRect, const ObjectHandle_t &eID = NO_HANDLE);
 
    virtual ~CGUI(void);
 
protected:
    volatile static eC_Bool ms_bRunning;
 
    static const eC_Int GUILIANI_VERSION_MAJOR; 
    static const eC_Int GUILIANI_VERSION_MINOR; 
 
private:
    ObjectHandle_t GetNeighborID(const CGUIObject* pkObject, FourWayFocus_t eDirection) const;
 
    void Init();
 
    CGUI();
 
    CGUI(const CGUI& kSource);
 
    CGUI& operator=(const CGUI& kSource);
 
    void CheckDuration();
 
    static void CheckAvailability(const eC_Int& iAmount, const eC_Int& iType);
 
private:
    static CGUI* ms_pkInstance;
 
    eC_UInt m_uiDistance;
 
    CGUIObject *m_kObjectToFocus;
 
    eC_UInt m_uiMinDistance;
 
    ObjectPtrList m_pSameDistanceObjects;
 
    eC_UInt m_uiIdleTime;
 
    eC_Bool m_bEvalExpired;
 
    CGUIFakeMouseCursor* m_pkMouseCursor;
};
#endif