Crazy Eddie's GUI System 0.8.7
Loading...
Searching...
No Matches
RenderedStringTextComponent.h
1/***********************************************************************
2 created: 25/05/2009
3 author: Paul Turner
4 *************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUIRenderedStringTextComponent_h_
28#define _CEGUIRenderedStringTextComponent_h_
29
30#include "CEGUI/RenderedStringComponent.h"
31#include "CEGUI/ColourRect.h"
32#include "CEGUI/String.h"
33
34// Start of CEGUI namespace section
35namespace CEGUI
36{
39{
40public:
44 RenderedStringTextComponent(const String& text, const String& font_name);
45 RenderedStringTextComponent(const String& text, const Font* font);
46
48 void setText(const String& text);
50 const String& getText() const;
52 void setFont(const Font* font);
54 void setFont(const String& font_name);
56 const Font* getFont() const;
58 void setColours(const ColourRect& cr);
60 void setColours(const Colour& c);
62 const ColourRect& getColours() const;
63
64 // implementation of abstract base interface
65 void draw(const Window* ref_wnd, GeometryBuffer& buffer,
66 const Vector2f& position, const ColourRect* mod_colours,
67 const Rectf* clip_rect, const float vertical_space,
68 const float space_extra) const;
69 Sizef getPixelSize(const Window* ref_wnd) const;
70 bool canSplit() const;
72 float split_point, bool first_component);
74 size_t getSpaceCount() const;
75 void setSelection(const Window* ref_wnd,
76 const float start, const float end);
77
78protected:
79 const Font* getEffectiveFont(const Window* window) const;
80
81 static size_t getNextTokenLength(const String& text, size_t start_idx);
82
86 const Font* d_font;
90 size_t d_selectionStart, d_selectionLength;
91};
92
93} // End of CEGUI namespace section
94
95#endif // end of guard _CEGUIRenderedStringTextComponent_h_
Class that holds details of colours for the four corners of a rectangle.
Definition ColourRect.h:45
Class representing colour values within the system.
Definition Colour.h:46
Class that encapsulates a typeface.
Definition Font.h:62
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition GeometryBuffer.h:44
Base class representing a part of a rendered string. The 'part' represented may be a text string,...
Definition RenderedStringComponent.h:49
String component that draws an image.
Definition RenderedStringTextComponent.h:39
const ColourRect & getColours() const
return the ColourRect object used when drawing this component.
void setSelection(const Window *ref_wnd, const float start, const float end)
mark some region appropriate given /a start and /a end as selected.
size_t getSpaceCount() const
return the total number of spacing characters in the string.
void setFont(const Font *font)
set the font to use when rendering the text.
RenderedStringTextComponent * split(const Window *ref_wnd, float split_point, bool first_component)
split the component as close to split_point as possible, returning a new RenderedStringComponent of t...
size_t d_selectionStart
last set selection
Definition RenderedStringTextComponent.h:90
void draw(const Window *ref_wnd, GeometryBuffer &buffer, const Vector2f &position, const ColourRect *mod_colours, const Rectf *clip_rect, const float vertical_space, const float space_extra) const
draw the component.
void setColours(const ColourRect &cr)
Set the colour values used when rendering this component.
const Font * d_font
Font to use for text rendering, 0 for system default.
Definition RenderedStringTextComponent.h:86
void setColours(const Colour &c)
Set the colour values used when rendering this component.
Sizef getPixelSize(const Window *ref_wnd) const
return the pixel size of the rendered component.
const String & getText() const
return the text that will be rendered by this component
const Font * getFont() const
return the font set to be used. If 0 the default font will be used.
RenderedStringTextComponent * clone() const
clone this component.
ColourRect d_colours
ColourRect object describing the colours to use when rendering.
Definition RenderedStringTextComponent.h:88
void setFont(const String &font_name)
set the font to use when rendering the text.
void setText(const String &text)
Set the text to be rendered by this component.
bool canSplit() const
return whether the component can be split
String d_text
pointer to the image drawn by the component.
Definition RenderedStringTextComponent.h:84
String class used within the GUI system.
Definition String.h:64
An abstract base class providing common functionality and specifying the required interface for deriv...
Definition Window.h:151
Main namespace for Crazy Eddie's GUI Library.
Definition arch_overview.dox:1