Mercurial > fife-parpg

comparison ext/guichan-0.8.1/include/guichan/font.hpp @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /* _______ __ __ __ ______ __ __ _______ __ __
2 * / _____/\ / /\ / /\ / /\ / ____/\ / /\ / /\ / ___ /\ / |\/ /\
3 * / /\____\// / // / // / // /\___\// /_// / // /\_/ / // , |/ / /
4 * / / /__ / / // / // / // / / / ___ / // ___ / // /| ' / /
5 * / /_// /\ / /_// / // / // /_/_ / / // / // /\_/ / // / | / /
6 * /______/ //______/ //_/ //_____/\ /_/ //_/ //_/ //_/ //_/ /|_/ /
7 * \______\/ \______\/ \_\/ \_____\/ \_\/ \_\/ \_\/ \_\/ \_\/ \_\/
8 *
9 * Copyright (c) 2004 - 2008 Olof Naessén and Per Larsson
10 *
11 *
12 * Per Larsson a.k.a finalman
13 * Olof Naessén a.k.a jansem/yakslem
14 *
15 * Visit: http://guichan.sourceforge.net
16 *
17 * License: (BSD)
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
20 * are met:
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in
25 * the documentation and/or other materials provided with the
26 * distribution.
27 * 3. Neither the name of Guichan nor the names of its contributors may
28 * be used to endorse or promote products derived from this software
29 * without specific prior written permission.
30 *
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
37 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
38 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
39 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
40 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
41 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 #ifndef GCN_FONT_HPP
45 #define GCN_FONT_HPP
46
47 #include <string>
48 #include "guichan/platform.hpp"
49
50 namespace gcn
51 {
52 class Graphics;
53
54 /**
55 * Interface for a font.
56 *
57 * @see ImageFont
58 */
59 class GCN_CORE_DECLSPEC Font
60 {
61 public:
62
63 /**
64 * Destructor.
65 */
66 virtual ~Font(){ }
67
68 /**
69 * Gets the width of a string. The width of a string is not necesserily
70 * the sum of all the widths of it's glyphs.
71 *
72 * @param text The string to return the width of.
73 * @return The width of a string.
74 */
75 virtual int getWidth(const std::string& text) const = 0;
76
77 /**
78 * Gets the height of the glyphs in the font.
79 *
80 * @return The height of the glyphs int the font.
81 */
82 virtual int getHeight() const = 0;
83
84 /**
85 * Gets a string index in a string providing an x coordinate.
86 * Used to retrive a string index (for a character in a
87 * string) at a certain x position. It is especially useful
88 * when a mouse clicks in a TextField and you want to know which
89 * character was clicked.
90 *
91 * @return A string index in a string providing an x coordinate.
92 */
93 virtual int getStringIndexAt(const std::string& text, int x) const;
94
95 /**
96 * Draws a string.
97 *
98 * NOTE: You normally won't use this function to draw text since
99 * Graphics contains better functions for drawing text.
100 *
101 * @param graphics A Graphics object to use for drawing.
102 * @param text The string to draw.
103 * @param x The x coordinate where to draw the string.
104 * @param y The y coordinate where to draw the string.
105 */
106 virtual void drawString(Graphics* graphics, const std::string& text,
107 int x, int y) = 0;
108 };
109 }
110
111 #endif // end GCN_FONT_HPP