CascadeFont.h

Go to the documentation of this file.

//
// CascadeFont.h - header file for class CascadeFont
//
// Copyright (c) 2003, Roku, LLC.  All rights reserved.
//

#ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADEFONT_H
#define _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADEFONT_H

#include <cascade/CascadeObject.h>
#include <cascade/graphics/CascadeDims.h>
#include <cascade/util/CascadeString.h>

class CascadeFont : public CascadeObject
{
public:
    enum WeightFlags {
        kNormal = 0,                
        kBold = (1 << 0),           
        kItalic = (1 << 1)          
    };

    enum {
        kMaxFaceName = 48,                  
        kMaxFaceNameLen = kMaxFaceName - 1  
    };
    
public:
    class Attributes    // Use this class to specify the font you want.
    {
    public:
        char            m_faceName[kMaxFaceName];
        WeightFlags     m_weightFlags;
        u16             m_nPointSize;
    public: // constructing, copying and comparing
        Attributes();
        Attributes(const char * pFaceName, const WeightFlags & weightFlags, u16 nPointSize);
        Attributes(const Attributes & that);
        Attributes & operator = (const Attributes & that);
        bool operator == (const Attributes & that) const;
        inline bool operator != (const Attributes & that) const { return (*this == that) ? false : true; }
    };
    
    
public:
    class Metrics
    {
    public:
        u16 m_nCharWidth;
        u16 m_nCharHeight;
        u16 m_nAscent;
        u16 m_nDescent;
    };
    
public:
        CascadeFont();
    CascadeFont(const CascadeFont & font);
    virtual ~CascadeFont();
public:
    bool operator == (const CascadeFont & that) const;
    bool operator != (const CascadeFont & that) const;
public:
    void GetAttributes(Attributes & attributesToSet);
    bool SetAttributes(const Attributes & attributes);
    typedef bool (EnumProc)(const Attributes & attributes, void * pClientData);
    bool EnumFonts(EnumProc * pEnumProc, void * pClientData);
    CascadeDims GetTextExtent(const CascadeString & string);
    void GetFontMetrics(Metrics & metricsToSet);

    enum TruncationType
    {
        kTruncateRight = 0,
        kTruncateLeft = 1,
        kTruncateCenter = 2
    };

    bool TruncateText(const CascadeString & text, const CascadeString & ellipsis, const CascadeDims & dims,  CascadeString & truncatedTextToSet, TruncationType truncationType = kTruncateRight);
        
private:

#ifndef DOXY_SKIP
    friend class CascadeBitmap;
    friend class CascadeScreen;
#endif

    void * m_pFontInternal;
};

#endif // #ifndef _ROKU_INCLUDE_CASCADE_GRAPHICS_CASCADEFONT_H

//  LOG
//  20-Jan-03   dwoodward       created
//  20-Jan-03   dwoodward       1.0 STATUS: ~20% complete - need to consult w/ Patrick
//  05-May-03   dwoodward   doxygenated
//      11-May-03       pellis          added TruncateText, doxygenated.
//  18-Aug-03   mjkobb      Added TextTruncateLocation enum and truncation
//                          parameter to TruncateText
//  09-Nov-04   dwoodward   added operator == and operator !=

---