scummvm/graphics/fontman.h

127 lines
3.6 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef GRAPHICS_FONTMAN_H
#define GRAPHICS_FONTMAN_H
#include "common/scummsys.h"
#include "common/singleton.h"
#include "common/str.h"
#include "common/hashmap.h"
#include "common/hash-str.h"
namespace Graphics {
class Font;
class BdfFont;
class FontManager : public Common::Singleton<FontManager> {
public:
enum FontUsage {
kLocalizedFont = 0,
kConsoleFont = 1,
kGUIFont = 2,
kBigGUIFont = 3
};
/**
* Sets the localized font name.
*
* @param name the name of the localized font.
* @return true when the font was present, false otherwise.
*/
bool setLocalizedFont(const Common::String &name);
/**
* Retrieve a font object based on its 'name'.
*
* @param name the name of the font to be retrieved.
* @return a pointer to a font, or 0 if no suitable font was found.
*/
const Font *getFontByName(const Common::String &name) const;
/**
* Associates a font object with an 'name'.
* The FontManager takes ownership of the provided font object
* and will delete it when necesssary.
*
* @param name the name of the font
* @param font the font object
* @return true on success, false on failure
*/
bool assignFontToName(const Common::String &name, const Font *font);
/**
* Associates a BDF font object with an 'usage'. This is useful for platforms
* with a screen DPI much larger than a regular desktop workstation.
*
* @param name the name of the font
* @param font the font object
* @return true on success, false on failure
*/
bool setFont(FontUsage usage, const BdfFont *font);
/**
* Removes binding from name to font
*
* @param name name which should be removed
*/
void removeFontName(const Common::String &name);
/**
* Retrieve a font object based on what it is supposed
* to be used for
*
* @param usage a FontUsage enum value indicating what the font will be used for.
* @return a pointer to a font, or 0 if no suitable font was found.
*/
const Font *getFontByUsage(FontUsage usage) const;
/**
* Get the localized font for the current TranslationManager charset from the
* non localized font name
*
* @param filename the non-localized font file name.
* @return The localized font file name.
*/
Common::String genLocalizedFontFilename(const Common::String &filename) const;
//const Font *getFontBySize(int size???) const;
private:
friend class Common::Singleton<SingletonBaseType>;
FontManager();
~FontManager();
Common::HashMap<Common::String, const Font *> _fontMap;
Common::Array<const Font *> _ownedFonts;
Common::String _localizedFontName;
};
} // End of namespace Graphics
/** Shortcut for accessing the font manager. */
#define FontMan (Graphics::FontManager::instance())
#endif