/*--------------------------------------------------------------------------

	FG_Win32Adaptor.h - Win32的適配器類的頭文件

	本程序是FishGUI軟件的一部分

	版權所有 (C) 2003,2004 王詠武
	http://www.contextfree.net/wangyw/

----------------------------------------------------------------------------

	作者對 FishGUI 軟件及其所有源代碼授權如下：

	允許任何個人、組織、機構、企業無償獲得、修改、使用、重新發布 FishGUI 軟
	件及其源代碼，或按照有償或者無償的方式發行基于 FishGUI 源代碼的全部或部
	分內容開發的軟件產品，——但行使以上權利時，須遵守以下約定：

	1、重新發布 FishGUI 軟件及其源代碼時，不得隱去軟件及其源代碼中原有的版
	   權信息和開發者標識。

	2、發行基于 FishGUI 源代碼的全部或部分內容開發的軟件產品時，必須在產品
	   的顯著位置標明以下字樣：

	   【本產品的一部分功能是基于王詠武在 FishGUI 軟件中的工作完成的】

	3、在正式出版物中引用 FishGUI 的文檔、源代碼或注釋內容的，應注明軟件的
	   原作者為王詠武。

--------------------------------------------------------------------------*/
/*! \addtogroup OSAdaptor
 *  @{ 
 */

/*! \file
 *  \brief Win32的適配器類的頭文件
 */

#ifndef FG_WIN32ADAPTOR_H_HEADER_INCLUDED_C0B1A8C2
#define FG_WIN32ADAPTOR_H_HEADER_INCLUDED_C0B1A8C2

#include "windows.h"
#include "FG_OSAdaptor.h"
class FG_Win32DrawInterface;

//##ModelId=3F49CC120210
/*! \brief Win32的適配器類
 *
 *  該類封裝Win32操作系統的程序啟動和運行過程
 */
class FG_Win32Adaptor : public FG_OSAdaptor
{
public:
    //##ModelId=3F4E099D01F1
    /*! \brief 程序初始化
     *
     *  調用Win32函數注冊窗口類，創建窗口，刷新窗口\n
     *  發送\ref FG_MSG_STARTUP消息
     *  \return 初始化是否成功\n
     *          true    成功\n
     *          false   失敗
     */
    bool InitInstance();

    //##ModelId=3F4E09F802BB
    /*! \brief 程序退出
     *
     *  發送\ref FG_MSG_HALT消息，釋放對象
     *  \return 退出是否成功\n
     *          true    成功\n
     *          false   失敗
     */
    bool ExitInstance();

    //##ModelId=3F4E09F8031F
    /*! \brief 程序運行過程，執行消息循環
     *
     *  執行Win32的消息循環
     *  \return 退出是否成功\n
     *          true    成功\n
     *          false   失敗
     */
    bool Execute();

    //##ModelId=3F6EAFFE01EA
    /*! \brief 設置當前應用程序的實例句柄
     *
     *  \param hInst 當前應用程序的實例句柄
     */
    void SetInst(HINSTANCE hInst) { m_hInst = hInst; }

    //##ModelId=3F6EAFFE024E
    /*! \brief 設置前一個應用程序的實例句柄
     *
     *  \param hPrevInst 前一個應用程序的實例句柄
     */
    void SetPrevInst(HINSTANCE hPrevInst) { m_hPrevInst = hPrevInst; }

    //##ModelId=3F6EAFFE02B2
    /*! \brief 設置窗口的顯示方式
     *
     *  \param nCmdShow 窗口的顯示方式
     */
    void SetCmdShow(int nCmdShow) { m_nCmdShow = nCmdShow; }

    //##ModelId=40925CB0009F
    /*! \brief 設置位圖文件所在目錄的絕對路徑
     *
     *  \param pPath FishGUI主目錄的絕對路徑，通過GetModuleFileName函數調用得到
     *  \param len 字符串pPath的長度，字符串不保證有0結束符
     */
    void SetBmpPath(char * pPath, int len);

    //##ModelId=40925CB000E5
    /*! \brief 繪制位圖
     *
     *  Win32適配器類覆蓋該函數，把位圖名組合成位圖文件的絕對路徑名，然后代理調用\ref FG_OSDrawInterface::DrawBitmap
     *  \param pBmpName 要繪制的位圖名
     *  \param x1 位圖左上角的橫坐標
     *  \param y1 位圖左上角的縱坐標
     */
    virtual void DrawBitmap(const char * pBmpName, const short x1, const short y1);

protected:
    friend class FG_OSAdaptor;

    //##ModelId=3F4EB7140009
    /*! \brief Win32適配器類的缺省構造函數 */
    FG_Win32Adaptor() : m_hInst(0), m_hPrevInst(0), m_nCmdShow() {}

    //##ModelId=3F6EAFFE00F0
                                            /*!< \brief 當前應用程序的實例句柄 */
    HINSTANCE m_hInst, m_hPrevInst;         /*!< \brief 前一個應用程序的實例句柄 */

    //##ModelId=3F6EAFFE0172
    int m_nCmdShow;                         /*!< \brief 窗口的顯示方式 */

    //##ModelId=40925CAF03E7
    char m_BmpPath[MAX_PATH + 1];           /*!< \brief 位圖文件所在目錄的絕對路徑 */

    //##ModelId=3F6EAFFE0335
    /*! \brief Win32窗口函數
     *
     *  必須靜態函數，該函數接收系統消息，然后通過觀查者模式發送給框架層
     *  \param hWnd 窗口句柄
     *  \param uMessage 消息類型
     *  \param wParam 消息參數
     *  \param lParam 消息參數
     *  \return long 消息處理結果
     */
    static long FAR WINAPI WndProc(HWND hWnd, UINT uMessage, UINT wParam, LONG lParam);
};

#endif /* FG_WIN32ADAPTOR_H_HEADER_INCLUDED_C0B1A8C2 */

/*! @} */