ParaScriptingGUI.h

//-----------------------------------------------------------------------------
// Copyright (C) 2004 - 2007 ParaEngine Tech Studio, All Rights Reserved.
// Date:    2005.4
// Description: API for GUI objects
//-----------------------------------------------------------------------------
#pragma once
#include "ParaScriptingCommon.h"
#include "ParaScriptingGlobal.h"
#include "2dengine/GUIBase.h"
#if defined (USE_FLASH_MANAGER) && defined(USE_DIRECTX_RENDERER)
#include "ParaScriptingFlashPlayer.h"
#endif
#ifdef USE_DIRECTX_RENDERER
#include "ParaScriptingBrowserManager.h"
#include "ParaScriptingHTMLBrowser.h"
#endif
#include "ParaScriptingPainter.h"
#include "ParaScriptingGraphics.h"

namespace ParaScripting
{
    using namespace std;
    using namespace luabind;
    using namespace ParaEngine;

    class PE_CORE_DECL ParaUIObject
    {
    public:
        CGUIBase::WeakPtr_type m_pObj;

        ParaUIObject();
        ParaUIObject(CGUIBase * obj);

        bool IsValid() const;
        void AddChild(ParaUIObject pChild);

        ParaAttributeObject GetAttributeObject();
        void GetAttributeObject_(ParaAttributeObject& output);

        void AddTextItem(const char*text);
        void AttachToRoot();

        void SetName(const char *szName);
        string GetName()const;

        ParaUIObject GetChild(const char *name);

        ParaUIObject GetChildAt(int index);

        int GetChildCount();

        int GetID() const;

        void SetID(int nID);

        ParaUIObject GetChildByID(int nChildID);

        ParaUIObject GetChildByName(const char* name);


        void SetEnabled(bool bEnabled);
        bool GetEnabled() const;

        void SetUseTextShadow(bool bUseTextShadow);
        bool GetUseTextShadow() const;

        void SetTextScale(float fScale);
        float GetTextScale();

        void SetHighlightStyle(const char* style);
        const char* GetHighlightStyle()const;
        
        string GetColor()const;

        void SetColor(const char *strColor);

        void SetZDepth(float fDepth);

        float GetZDepth();

        void SetAutoSize(bool bAutosize);
        bool GetAutoSize() const;

        void GetTextLineSize(int* width, int* height);

        void SetVisible(bool bVisible);
        bool GetVisible() const;


        bool GetScrollable() const;

        string GetType() const;
        //ParaUIResource GetResource();

        void SetReceiveDrag(bool bReceiveDrag);
        bool GetReceiveDrag()const;

        ParaUIObject GetParent()const;
        void SetParent(ParaUIObject parent);

        object GetField(const char*  sFieldname, const object& output);

        void SetField(const char*  sFieldname, const object& input);

        void CallField(const char*  sFieldname);
        
        void SetDefault(bool bDefaultButton);

        void SetLifeTime(int nSeconds);
        int GetLifeTime()const;

        string GetText() const;
        void SetText3(const char * strText, const char * strColor, const char * strFontAssetName);
        void SetText1(const object& strText);
        void SetText(const char* strText);
        
        void SetTextAutoTranslate(const char* strText, const char* sConverter);

        void SetPasswordChar(string PasswordChar);
        string GetPasswordChar() const;

        void SetTopLevel(bool value);
        void SetBGImage1(const object&  szBackground);
        void SetBGImageStr(const char * szBackground);
        void SetBGImage5(const char * TextFilename,int left,int top,int width,int height);
        void SetBGImage(ParaAssetObject pTextureEntity);
        void SetBGImageAndRect(ParaAssetObject pTextureEntity,int left,int top,int width,int height);
        // internally used
        void SetBGImage_(TextureEntity* pTextureEntity,RECT *rect);
        // internally used
        void SetBGImage2(const char * TextFilename,RECT *rect);

        string GetBGImage()const;

        void SetBtnImage2(const char * TextFilename, RECT *rect);
        void SetBtnImage1(const object&  szButton);
        string GetBtnImage()const;

        void SetNineElementBG(const char * TextFilename, int left, int top, int toRight, int toBottom);

        int GetFirstVisibleCharIndex();

        int GetCaretPosition();

        void SetCaretPosition(int nCharacterPos);

        int GetTextSize();

        void GetPriorWordPos( int nCP, int PriorIn, int &Prior );

        void GetNextWordPos( int nCP, int NextIn, int &Next);

        void CPtoXY( int nCP, bool bTrail, int XIn, int YIn, int &X, int &Y);

        void XYtoCP( int nX, int nY, int CPIn,int nTrailIn, int & CP,int &nTrail);

        void SetPageSize(int pagesize);

        void SetStep(int nDelta);

        int GetStep();

        void SetTrackRange(int nBegin,int nEnd);

        void GetTrackRange(int &nBegin, int &nEnd);

        int GetAnimationStyle() const;

        void SetAnimationStyle(int nStyle);

        void SetScrollable(bool bScrollable);

        void GetAbsPosition(float &x,float &y,float& width, float& height, float &z)const;


        void SetPosition(const char * pos);

        string GetPosition()const;

        void Reposition(const char* alignment, int left,int top, int width, int height);


        int GetValue()const;
        void SetValue(int value);
        void OnClick(const object&  strScriptName);
        string GetOnClick()const;

        void OnSize(const object&  strScriptName);
        string GetOnSize()const;

        void OnDestroy(const object&  strScriptName);
        string GetOnDestroy()const;
        
        void OnActivate(const object&  strScriptName);
        string GetOnActivate()const;

        void OnDoubleClick(const object&  strScriptName);
        string GetOnDoubleClick()const;
        void OnKeyDown(const object&  strScriptName);
        string GetOnKeyDown()const;

        void OnKeyUp(const object& strScriptName);
        string GetOnKeyUp()const;

        void OnDragBegin(const object&  strScriptName);
        string GetOnDragBegin()const;

        void OnDragEnd(const object&  strScriptName);
        string GetOnDragEnd()const;

        void OnDragOver(const object&  strScriptName);
        string GetOnDragOver()const;
        void OnMouseMove(const object&  strScriptName);
        string GetOnMouseMove()const;
        void OnMouseHover(const object&  strScriptName);
        string GetOnMouseHover()const;
        void OnMouseEnter(const object&  strScriptName);
        string GetOnMouseEnter()const;
        void OnMouseLeave(const object&  strScriptName);
        string GetOnMouseLeave()const;
        void OnMouseDown(const object&  strScriptName);
        string GetOnMouseDown()const;
        void OnMouseUp(const object&  strScriptName);
        string GetOnMouseUp()const;
        void OnMouseWheel(const object&  strScriptName);
        string GetOnMouseWheel()const;
        void OnFrameMove(const object&  strScriptName);
        string GetOnFrameMove()const;
        void OnTouch(const object&  strScriptName);
        string GetOnTouch()const;
        void OnDraw(const object&  strScriptName);
        string GetOnDraw()const;
        void OnInputMethod(const object&  strScriptName);
        string GetOnInputMethod()const;

        void                SetCursor(const object&  szCursorFile);
        std::string GetCursor() const;
        void                SetCursorEx(const char* szCursorFile, int nHotSpotX, int nHotSpotY);

        void OnChange(const object&  strScriptName);
        string GetOnChange()const;
        void OnSelect(const object&  strScriptName);
        string GetOnSelect()const;
        void OnModify(const object&  strScriptName);
        string GetOnModify()const;
        void SetCanDrag(bool bCanDrag);
        bool GetCanDrag() const;

        void SetFontString(const char* font);
        void SetFontString1(const object& font);
        void SetFontString3(const char *fontname,DWORD fontsize,bool isbold);


        string ToScript()const;
        string GetFontString()const;
        //make this object get keyboard focus, if it can get keyboard focus
        void Focus();
        //make this object lost keyboard focus, if it has focus
        void LostFocus();
        bool GetReadOnly()const;
        void SetReadOnly(bool readonly);
        int GetX()const;
        int GetY()const;
        float GetDepth()const;
        void SetDepth(float depth);
        void SetX(int x);
        void SetY(int y);
        void SetWidth(int width);
        void SetHeight(int height);
        int Width()const;
        int Height()const;
        void SetSize(int width, int height);

        void SetRotation(float fRot);

        float GetRotation() const;

        void SetRotOriginOffset(float x, float y);

        void GetRotOriginOffset(float *x, float * y) const;

        void SetScaling(float x, float y);
        
        void GetScaling(float *x, float * y) const;

        void SetScalingX(float x);
        float GetScalingX() const;
        void SetScalingY(float y);
        float GetScalingY() const;

        void SetTranslation(float x, float  y);

        void GetTranslation(float *x, float * y) const;

        void SetTranslationX(float x);
        float GetTranslationX() const;
        void SetTranslationY(float y);
        float GetTranslationY() const;

        void SetColorMask(const char *strColor);
        string GetColorMask()const;

        void ApplyAnim();
        
        
        void SetSpacing( int nSpacing );

        int GetSpacing() const;

        //for scrollbar and short-cut for container 
        int GetScrollbarWidth()const;
        void SetScrollbarWidth(int width);

        //for scrollbar
        bool GetFixedThumb()const;
        void SetFixedThumb(bool bFixed);

        int GetThumbSize()const;
        void SetThumbSize(int size);

        void SetBindingObj(ParaUIObject obj);//set linked object of a scrollbar

        void SetFastRender(bool fastrender);
        bool GetFastRender()const;
        
        bool GetWordbreak()const;
        void SetWordbreak(bool wordbreak);

        int GetItemHeight()const;
        void SetItemHeight(int itemheight);

        bool GetMultipleSelect()const;
        void SetMultipleSelect(bool multiple);
        void AttachTo3D(const ParaObject obj);
        void AttachTo3D_(const char* s3DObjectName);

        string GetToolTip()const;
        void SetToolTip(const object& tooltip);

        void RemoveAll();

        void RemoveItem(int index);

        void SetPopUp(int popup);
        int GetPopUp()const;


        ParaUIFont CreateFont(const char *name,const char *fontname);
        ParaUITexture CreateTexture(const char *name,const char *texturename);
        ParaUIFont GetFont(const char *name);
        ParaUIFont GetFont_(int nIndex);

        void DoAutoSize();

        ParaUITexture GetTexture(const object& name);

        
        void BringToFront();

        void BringToBack();

        int GetZOrder()const;

        void SetZOrder(int nOrder);

        bool IsModified()const;
        void SetActiveLayer(const char *layer);

        bool HasLayer(const char *layer);

        void SetCurrentState(const char *statename);

        void CloneState(const char* statename);
        void ActivateScript(const char* scripttype);
        
        void InvalidateRect();

        void UpdateRect();

    protected:
        string GenGetImage(int index)const;
        string GenGetFont(int index)const;
    private:
        void GetEventScript(DWORD type, string& out)const;
        void SetEventScript(DWORD type, const char * strScriptName);

    };
    class PE_CORE_DECL ParaUI
    {
    public:
        static void PlaySound(const char * strSoundAssetName, bool bLoop);

        static void StopSound(const char * strSoundAssetName);

        static void Destroy(const char * strObjectName);
        static void Destroy1(int nID);

        static void DestroyUIObject(ParaUIObject& obj);

        static void PostDestroy(const char * strObjectName);
    
        static ParaUIObject GetUIObject_any(const object& NameOrID);
        static ParaUIObject GetUIObject(const char* Name);
        
        static ParaUIObject GetUIObjectAtPoint(int x,int y);

        static void GetMousePosition(float &x,float &y);

        static void SetMousePosition(float x,float y);

        /* check if a given key is currently in pressed state. Please note that there may be time delays since the scripting interface is called at regularly interval.
        * e.g. ParaUI.IsKeyPressed(DIK_SCANCODE.DIK_LCONTROL) or ParaUI.IsKeyPressed(DIK_SCANCODE.DIK_LSHIFT) or ParaUI.IsKeyPressed(DIK_SCANCODE.DIK_LMENU)
        * @param nDikScanCode: DirectInput keyboard scan codes.
        */
        static bool IsKeyPressed(int nDikScanCode);

        /* check if a given mouse button is currently in pressed state. 
        * @param nButton: 0 is left, 1 is right, 2 is middle. 
        this is just traditional mouse key mapping.
        enum MOUSE_KEY_STD{
            LEFT_BUTTON = 0,
            RIGHT_BUTTON = 1,
            MIDDLE_BUTTON = 2
        };
        */
        static bool IsMousePressed(int nButton);

        static ParaUIObject CreateUIObject(const char* strType, const char * strObjectName,const char * alignment, int x, int y, int width, int height);

        static ParaUIObject GetTopLevelControl();

        
        static ParaUIObject GetDefaultObject(const char *strType);
        static void SetCursorFont(const char *fontname,const char * strColor,DWORD transparency);
        static void SetCursorTexture(const char *texturename, const char * strColor,DWORD transparency );
        static void SetCursorText(const char *strText);
        static void SetCursorFromFile(const char *szCursor, int XHotSpot, int YHotSpot);
        static void SetCursorFromFile_(const char *szCursor);
        /*
        * get the current cursor file name. 
        * @return: the cursor file is returned.
        */
        static const char* GetCursorFile();
        
        static void SetUseSystemCursor(bool bUseSystem);

        static bool GetUseSystemCursor();

        static string ToScript();

        static bool SaveLayout(const char *filename);

        static void SetDesignTime(bool bDesign);
        
        static void ShowCursor(bool bShow);

        static void LockMouse(bool bLock);

        static bool IsMouseLocked();

        static void ResetUI();

        static void SetIMEOpenStatus(bool bOpen);

        static bool GetIMEOpenStatus();
        

        static void SetUIScale(float fScalingX, float fScalingY);

        static void SetMinimumScreenSize(int nWidth, int nHeight, bool bAutoUIScaling);


        static void AddDragReceiver(const char* sName);


        static void SetToolTipBehavior(const char* behavior);
        
        static bool SetHighlightParam(const char* szEffectName, const char* szParamName, const char* szParamValue);

#ifdef USE_DIRECTX_RENDERER
#ifdef USE_FLASH_MANAGER

        static ParaFlashPlayer GetFlashPlayer(const char* sFileName);

        static ParaFlashPlayer CreateFlashPlayer(const char* sFileName);

        static ParaFlashPlayer GetFlashPlayer1(int nIndex);
#endif
#endif
    };
}