Crazy Eddie's GUI System 0.8.7
RenderedStringImageComponent.h
1/***********************************************************************
2 created: 24/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 _CEGUIRenderedStringImageComponent_h_
28#define _CEGUIRenderedStringImageComponent_h_
29
30#include "CEGUI/RenderedStringComponent.h"
31#include "CEGUI/ColourRect.h"
32#include "CEGUI/String.h"
33
34#if defined(_MSC_VER)
35# pragma warning(push)
36# pragma warning(disable : 4251)
37#endif
38
39// Start of CEGUI namespace section
40namespace CEGUI
41{
44{
45public:
50
52 void setImage(const String& name);
54 void setImage(const Image* image);
56 const Image* getImage() const;
58 void setColours(const ColourRect& cr);
60 void setColours(const Colour& c);
62 const ColourRect& getColours() const;
64 void setSize(const Sizef& sz);
66 const Sizef& getSize() const;
67
68 // implementation of abstract base interface
69 void draw(const Window* ref_wnd, GeometryBuffer& buffer,
70 const Vector2f& position, const ColourRect* mod_colours,
71 const Rectf* clip_rect, const float vertical_space,
72 const float space_extra) const;
73 Sizef getPixelSize(const Window* ref_wnd) const;
74 bool canSplit() const;
76 float split_point,
77 bool first_component);
79 size_t getSpaceCount() const;
80 void setSelection(const Window* ref_wnd,
81 const float start, const float end);
82protected:
84 const Image* d_image;
89 // whether the image is marked as selected.
90 bool d_selected;
91};
92
93} // End of CEGUI namespace section
94
95#if defined(_MSC_VER)
96# pragma warning(pop)
97#endif
98
99#endif // end of guard _CEGUIRenderedStringImageComponent_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
Abstract class defining the interface for objects that buffer geometry for later rendering.
Definition: GeometryBuffer.h:44
Interface for Image.
Definition: Image.h:161
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: RenderedStringImageComponent.h:44
Sizef getPixelSize(const Window *ref_wnd) const
return the pixel size of the rendered component.
ColourRect d_colours
ColourRect object describing the colours to use when rendering.
Definition: RenderedStringImageComponent.h:86
void setImage(const String &name)
Set the image to be drawn by this component.
void setColours(const Colour &c)
Set the colour values used when rendering this component.
const Image * d_image
pointer to the image drawn by the component.
Definition: RenderedStringImageComponent.h:84
const ColourRect & getColours() const
return the ColourRect object used when drawing this component.
void setColours(const ColourRect &cr)
Set the colour values used when rendering this component.
size_t getSpaceCount() const
return the total number of spacing characters in the string.
void setSelection(const Window *ref_wnd, const float start, const float end)
mark some region appropriate given /a start and /a end as selected.
const Image * getImage() const
return the current set image that will be drawn by this component
void setImage(const Image *image)
Set the image to be drawn by this component.
void setSize(const Sizef &sz)
set the size for rendering the image (0s mean 'normal' size)
RenderedStringImageComponent * clone() const
clone this component.
bool canSplit() const
return whether the component can be split
RenderedStringImageComponent * 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...
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.
Sizef d_size
target size to render the image at (0s mean natural size)
Definition: RenderedStringImageComponent.h:88
const Sizef & getSize() const
return the size for rendering the image (0s mean 'normal' size)
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