PixmapFont.h

/***********************************************************************
    filename:   CEGUIPixmapFont.h
    created:    14/6/2006
    author:     Andrew Zabolotny
*************************************************************************/
/***************************************************************************
 *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
 *
 *   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 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 _CEGUIPixmapFont_h_
#define _CEGUIPixmapFont_h_

#include "CEGUI/Font.h"

// Start of CEGUI namespace section
namespace CEGUI
{

class PixmapFont : public Font
{
public:
    PixmapFont(const String& font_name, const String& imageset_filename,
               const String& resource_group = "",
               const AutoScaledMode auto_scaled = ASM_Disabled,
               const Sizef& native_res = Sizef(640.0f, 480.0f));

    ~PixmapFont();

    void defineMapping(const utf32 codepoint, const String& image_name, 
                       const float horz_advance);
    void defineMapping(const String& value);
    const String& getImageNamePrefix() const;

    void setImageNamePrefix(const String& name_prefix);

protected:
    void reinit();
    void addPixmapFontProperties();

    // override of functions in Font base class.
    void updateFont ();
    void writeXMLToStream_impl (XMLSerializer& xml_stream) const;

    String d_imageNamePrefix;
    float d_origHorzScaling;
    bool d_imagesetOwner;
};

} // End of  CEGUI namespace section

#endif  // end of guard _CEGUIPixmapFont_h_