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

	FG_RadioButton.h - 收音機按鈕類的頭文件

	本程序是FishGUI軟件的一部分

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

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

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

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

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

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

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

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

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

/*! \file
 *  \brief 收音機按鈕類的頭文件
 */

#ifndef FG_RADIOBUTTON_H_HEADER_INCLUDED_C0A7BA3D
#define FG_RADIOBUTTON_H_HEADER_INCLUDED_C0A7BA3D

#include "FG_TextWidget.h"

//##ModelId=3F37D6D30247
/*! \brief 收音機按鈕類
 *
 *  用圓點選擇的收音機按鈕，一組收音機按鈕只有一個能被選中
 */
class FG_RadioButton : public FG_TextWidget
{
public:
    //##ModelId=3F65E8E302DE
    /*! \brief 收音機按鈕類的構造函數
     *
     *  \param Text 收音機按鈕上顯示的文本
     *  \param Rect 收音機按鈕占據的矩形區域
     *  \param pSameGroup 同組的收音機按鈕，通過鏈表把一組收音機按鈕連接起來
     *  \param wID 收音機按鈕控件的唯一標識
     */
    FG_RadioButton(const char * Text, const FG_Rect & Rect, FG_RadioButton * const pSameGroup = NULL, const WORD wID = 0);

    //##ModelId=3F65E8E302FC
	/*! \brief 收音機按鈕是否被選中
	 *
	 *  \return true    選中\n
     *          false   未選中
     */
	bool IsChecked() const { return m_bChecked; }

    //##ModelId=3F65E8E30306
	/*! \brief 改變收音機按鈕的選擇狀態
	 *
     *  改變選中狀態后，需要重畫本控件
	 *  \param bChecked 選中或取消選中
	 *                  true    選中\n
     *                  false   未選中
	 */
	void SetChecked(bool bChecked) { m_bChecked = bChecked; RequestDraw();}

protected:
    //##ModelId=3F65E8E3031A
    /*! \brief 重畫消息\ref FG_MSG_DRAW的處理函數

     *  \param pAdaptor 指向操作系統適配器的指針
     */
	void OnDraw(FG_OSAdaptor * pAdaptor);

    //##ModelId=3F65E8E3032E
    /*! \brief 鍵盤按下消息（\ref FG_MSG_KEY，\ref FKS_DOWN）的處理函數

     *  \param pMsg 指向鍵盤消息結構的指針
     */
	bool OnKeyDown(FG_Message * pMsg);

    //##ModelId=3F65E8E30342
    /*! \brief 鼠標左鍵按下消息（\ref FG_MSG_MOUSE，\ref FMS_LBUTTONDOWN）的處理函數

     *  \param pMsg 指向鼠標消息結構的指針
     */
	bool OnLButtonDown(FG_Message * pMsg);

    //##ModelId=3F65E8E302CA
    bool m_bChecked;                /*!< \brief 收音機按鈕是否被選中，true代表被選中，false代表未被選中 */

    //##ModelId=3F65EDEC0133
    FG_RadioButton * m_pNext;       /*!< \brief 本組中的下一個收音機按鈕 */

private:
    //##ModelId=3F65EDEC0183
    /*! \brief 把本組的其他收音機按鈕取消選中
     *
     *  取消選中時需要重畫和發送通知消息\ref FRN_UNCHECKED
     */
    void UncheckGroup(void);

    DECLARE_MESSAGE_MAP()
};

#endif /* FG_RADIOBUTTON_H_HEADER_INCLUDED_C0A7BA3D */

/*! @} */