wg_renderedstring.h

// wg_renderedstring.h
//
// CRenderedString interface
// CRenderedString uses the FreeType 2 library
//
//
// Copyright (c) 2002-2004 Rob Wiskow
// rob-dev@boxedchaos.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//


#ifndef _WG_RENDEREDSTRING_H_
#define _WG_RENDEREDSTRING_H_

#include "wg_fontengine.h"
#include <vector>
#include "wg_rect.h"
#include "wg_color.h"
#include "SDL.h"
#include "std_ex.h"


namespace wGui
{

#ifdef WIN32
#pragma warning(push)
#pragma warning(disable: 4512)
#endif // WIN32


class CRenderedString
{
public:
     enum EVAlign
     {
          VALIGN_NORMAL,  
          VALIGN_CENTER,  
          VALIGN_TOP,  
          VALIGN_BOTTOM  
     };

     enum EHAlign
     {
          HALIGN_LEFT,  
          HALIGN_CENTER,  
          HALIGN_RIGHT  
     };

     CRenderedString(CFontEngine* pFontEngine, const std::wstring& sString, EVAlign eVertAlign = VALIGN_NORMAL, EHAlign eHorzAlign = HALIGN_LEFT);

     void Draw(SDL_Surface* pSurface, const CRect& BoundingRect, const CPoint& OriginPoint, const CRGBColor& FontColor = DEFAULT_LINE_COLOR) const;

     void GetMetrics(CPoint* pBoundedDimensions = 0, CPoint* pOriginOffset = 0, std::vector<CRect>* pCharacterRects = 0) const;

     unsigned int GetLength(void) const { return stdex::safe_static_cast<unsigned int>(m_sString.size()); }

     unsigned int GetMaxFontHeight(void);

     unsigned int GetMaxFontWidth(void);

     void SetMaskChar(wchar_t MaskChar) { m_MaskChar = MaskChar; }

     wchar_t GetMaskChar(void) const { return m_MaskChar; }


protected:
     CFontEngine* m_pFontEngine;  
     std::wstring m_sString;  
     wchar_t m_MaskChar;  


private:
     EVAlign m_eVertAlign;  
     EHAlign m_eHorzAlign;  
     mutable CPoint m_CachedBoundedDimensions;  
     mutable CPoint m_OriginOffset;  
     mutable std::vector<CRect> m_CachedCharacterRects;  
     mutable bool m_bCachedMetricsValid;  
     int m_MaxFontHeight; 
     int m_MaxFontWidth; 
};

#ifdef WIN32
#pragma warning(pop)
#endif // WIN32

}

#endif  // _WG_RENDEREDSTRING_H_

---