axmol/cocos2dx/include/CCLabel.h

/****************************************************************************
Copyright (c) 2010 cocos2d-x.org

http://www.cocos2d-x.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/
#ifndef __CCLABEL_H__
#define __CCLABEL_H__
#include "CCSprite.h"
#include "CCTexture2D.h"

namespace cocos2d{

	/** @brief CCLabel is a subclass of CCTextureNode that knows how to render text labels
	*
	* All features from CCTextureNode are valid in CCLabel
	*
	* CCLabel objects are slow. Consider using CCLabelAtlas or CCBitmapFontAtlas instead.
	*/
	class CCX_DLL CCLabel : public CCSprite, public CCLabelProtocol
	{
	public:
		CCLabel()
			:m_sFontName("")
		{}
		virtual ~CCLabel(){ m_sFontName.clear(); }
		char * description();
		/** creates a CCLabel from a fontname, alignment, dimension and font size */
		static CCLabel * labelWithString(const char *label, CGSize dimensions, UITextAlignment alignment, const char *fontName, float fontSize);
		/** creates a CCLabel from a fontname and font size */
		static CCLabel * labelWithString(const char *label, const char *fontName, float fontSize);
		/** initializes the CCLabel with a font name, alignment, dimension and font size */
		bool initWithString(const char *label, CGSize dimensions, UITextAlignment alignment, const char *fontName, float fontSize);
		/** initializes the CCLabel with a font name and font size */
		bool initWithString(const char *label, const char *fontName, float fontSize);

		/** changes the string to render
		* @warning Changing the string is as expensive as creating a new CCLabel. To obtain better performance use CCLabelAtlas
		*/
		virtual void setString(const char *label);

		virtual CCLabelProtocol* convertToLabelProtocol() { return (CCLabelProtocol*)this; }
	protected:
		CGSize m_tDimensions;
		UITextAlignment m_eAlignment;
		std::string m_sFontName;
		float m_fFontSize;
	};

} //namespace cocos2d
#endif //__CCLABEL_H__