Crazy Eddie's GUI System  0.8.7
RenderedStringWidgetComponent.h
1 /***********************************************************************
2  created: 27/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 _CEGUIRenderedStringWidgetComponent_h_
28 #define _CEGUIRenderedStringWidgetComponent_h_
29 
30 #include "CEGUI/RenderedStringComponent.h"
31 #include "CEGUI/String.h"
32 
33 // Start of CEGUI namespace section
34 namespace CEGUI
35 {
38 {
39 public:
42  RenderedStringWidgetComponent(const String& widget_name);
44 
46  void setWindow(const String& widget_name);
48  void setWindow(Window* widget);
50  const Window* getWindow() const;
51 
52  // implementation of abstract base interface
53  void draw(const Window* ref_wnd, GeometryBuffer& buffer,
54  const Vector2f& position, const ColourRect* mod_colours,
55  const Rectf* clip_rect, const float vertical_space,
56  const float space_extra) const;
57  Sizef getPixelSize(const Window* ref_wnd) const;
58  bool canSplit() const;
60  float split_point,
61  bool first_component);
63  size_t getSpaceCount() const;
64  void setSelection(const Window* ref_wnd,
65  const float start, const float end);
66 
67 protected:
68  Window* getEffectiveWindow(const Window* ref_wnd) const;
69 
73  mutable bool d_windowPtrSynched;
75  mutable Window* d_window;
76  // whether the image is marked as selected.
77  bool d_selected;
78 };
79 
80 } // End of CEGUI namespace section
81 
82 #endif // end of guard _CEGUIRenderedStringWidgetComponent_h_
Class that holds details of colours for the four corners of a rectangle.
Definition: ColourRect.h:45
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 moves a widget to appear as part of the string.
Definition: RenderedStringWidgetComponent.h:38
const Window * getWindow() const
return the window currently controlled by 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.
void setWindow(const String &widget_name)
Set the window to be controlled by this component.
Sizef getPixelSize(const Window *ref_wnd) const
return the pixel size of the rendered component.
bool d_windowPtrSynched
whether d_window is synched.
Definition: RenderedStringWidgetComponent.h:73
Window * d_window
pointer to the window controlled by this component.
Definition: RenderedStringWidgetComponent.h:75
void setWindow(Window *widget)
Set the window to be controlled by this component.
RenderedStringWidgetComponent * 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.
RenderedStringWidgetComponent * clone() const
clone this component.
bool canSplit() const
return whether the component can be split
String d_windowName
Name of window to manipulate.
Definition: RenderedStringWidgetComponent.h:71
size_t getSpaceCount() const
return the total number of spacing characters in the string.
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