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

	FG_String.h - 字符串類的頭文件

	本程序是FishGUI軟件的一部分

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

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

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

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

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

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

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

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

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

/*! \file
 *  \brief FishGUI字符串類的頭文件
 */

#ifndef __FG_STRING_H__
#define __FG_STRING_H__

#include "FG_Common.h"

//##ModelId=409260760166
/*  \brief 字符串類
 *
 *  該類封裝字符串的操作，
 *  現在只實現了動態內存管理（在設置不同長度的字符串時，自動改變緩沖區的長度）的部分，
 *  以后可以添加比較、連接、拷貝等各種字符串操作，運算符重載，以及Unicode支持等
 */
class FG_String
{
public:
    //##ModelId=40926077001D
    /*! \brief 字符串類的缺省構造函數 */
    FG_String() : m_pText(NULL), m_wStrLen(0), m_wBufferLen(0) {}
    
    //##ModelId=40926077001E
    /*! \brief 字符串類的轉換構造函數
     * 
     *  \param Text 要封裝的字符串
     */
    FG_String(const char * Text);

    //##ModelId=409260770031
    /*! \brief 字符串類的構析函數
     *  
     *  負責釋放字符串
     */
    virtual ~FG_String();

    //##ModelId=409260770033
    /*! \brief 設置字符串的內容
     * 
     *  \param Text 要設置的字符串
     */
    void DataSet(const char *Text);
    //##ModelId=409260770045
    /*! \brief 得到字符串的內容
     * 
     *  \return 指向字符串的內容，用戶無需釋放此指針
     */
    char * DataGet(void) const { return m_pText; }
    
    //##ModelId=40926077005A
    /*! \brief 得到字符串的長度
     * 
     *  \return 字符串的長度
     */
    WORD Length(void) const { return m_wStrLen; }

private:
    //##ModelId=4092607603BF
    char * m_pText;             /*!< \brief 字符串類中保存的當前文本 */
    //##ModelId=4092607603D4
    WORD m_wStrLen;             /*!< \brief 當前文本的長度 */
    //##ModelId=4092607603E8
    WORD m_wBufferLen;          /*!< \brief 當前緩沖區的長度的長度，一般比文本的長度長 */
};

#endif

/*! @} */