27 #ifndef _FalStaticText_h_
28 #define _FalStaticText_h_
30 #include "CEGUI/WindowRendererSets/Core/Module.h"
31 #include "CEGUI/WindowRendererSets/Core/Static.h"
32 #include "CEGUI/falagard/Enums.h"
33 #include "CEGUI/ColourRect.h"
37 # pragma warning(push)
38 # pragma warning(disable : 4251)
285 void renderScrolledText(
void);
287 void configureScrollbars()
const;
294 Rectf getTextRenderArea()
const;
295 Sizef getDocumentSize()
const;
300 void setupStringFormatter()
const;
309 bool handleScrollbarChange(
const EventArgs& e);
323 typedef std::vector<Event::Connection> ConnectionList;
324 ConnectionList d_connections;
334 Scrollbar* getVertScrollbarWithoutUpdate()
const;
335 Scrollbar* getHorzScrollbarWithoutUpdate()
const;
336 Rectf getTextRenderAreaWithoutUpdate()
const;
337 Sizef getDocumentSizeWithoutUpdate()
const;
342 #if defined(_MSC_VER)
343 # pragma warning(pop)
Class that holds details of colours for the four corners of a rectangle.
Definition: ColourRect.h:45
Base class used as the argument to all subscribers Event object.
Definition: EventArgs.h:51
StaticText class for the FalagardBase module.
Definition: StaticText.h:71
void onLookNFeelAssigned()
Handler called when a Look'N'Feel is assigned to our window.
void updateFormatting() const
Update string formatting and scrollbars visibility.
float getHorizontalScrollPosition() const
Get the current position of the horizontal scrollbar within the text.
void invalidateFormatting()
Invalidate string formatting and scrollbars visibility.
VerticalTextFormatting d_vertFormatting
Vertical formatting to be applied to the text.
Definition: StaticText.h:315
float getVerticalScrollPosition() const
Get the current position of the vertical scrollbar within the text.
void setVerticalFormatting(VerticalTextFormatting v_fmt)
Set the vertical formatting required for the text.
void onLookNFeelUnassigned()
Handler called when a Look'N'Feel is removed/unassigned from our window.
ColourRect getTextColours(void) const
Return a ColourRect object containing the colours used when rendering this widget.
Definition: StaticText.h:100
static const String HorzScrollbarName
Widget name for the horizontal scrollbar component.
Definition: StaticText.h:79
void configureScrollbars(void)
~FalagardStaticText()
Destructor.
float getUnitIntervalHorizontalScrollPosition() const
return the current horizontal scrollbar position as a value in the interval [0, 1].
void setVerticalScrollbarEnabled(bool setting)
Set whether the vertical scroll bar will be shown if needed.
bool isVerticalScrollbarEnabled(void) const
Return whether the vertical scroll bar is set to be shown if needed.
Definition: StaticText.h:136
void setUnitIntervalVerticalScrollPosition(float position)
set the current vertical scrollbar position as a value in the interval [0, 1].
FalagardStaticText(const String &type)
Constructor.
void setUnitIntervalHorizontalScrollPosition(float position)
set the current horizontal scrollbar position as a value in the interval [0, 1].
ColourRect d_textCols
Colours used when rendering the text.
Definition: StaticText.h:316
void setHorizontalScrollPosition(float position)
Set the current position of the horizontal scrollbar within the text.
static const String VertScrollbarName
Widget name for the vertical scrollbar component.
Definition: StaticText.h:78
bool handleFontRenderSizeChange(const Font *const font)
Perform any updates needed because the given font's render size has changed.
bool d_enableVertScrollbar
true if vertical scroll bar is enabled.
Definition: StaticText.h:317
float getUnitIntervalVerticalScrollPosition() const
return the current vertical scrollbar position as a value in the interval [0, 1].
VerticalTextFormatting getVerticalFormatting(void) const
Return the current vertical formatting option set for this widget.
Definition: StaticText.h:112
Sizef getDocumentSize(const Rectf &renderArea) const
void render(void)
Populate render cache.
bool isHorizontalScrollbarEnabled(void) const
Return whether the horizontal scroll bar is set to be shown if needed.
Definition: StaticText.h:142
FormattedRenderedString * d_formattedRenderedString
Class that renders RenderedString with some formatting.
Definition: StaticText.h:321
float getVerticalTextExtent() const
return the current vertical formatted text extent in pixels.
void updateFormatting(const Sizef &) const
HorizontalTextFormatting getHorizontalFormatting(void) const
Return the current horizontal formatting option set for this widget.
Definition: StaticText.h:106
void setVerticalScrollPosition(float position)
Set the current position of the vertical scrollbar within the text.
void setHorizontalFormatting(HorizontalTextFormatting h_fmt)
Set the horizontal formatting required for the text.
void setHorizontalScrollbarEnabled(bool setting)
Set whether the horizontal scroll bar will be shown if needed.
bool d_formatValid
True when string formatting and scrollbars visibility are up to date.
Definition: StaticText.h:331
float getHorizontalTextExtent() const
return the current horizontal formatted text extent in pixels.
static const String TypeName
type name for this widget.
Definition: StaticText.h:73
void setTextColours(const ColourRect &colours)
Sets the colours to be applied when rendering the text.
bool d_enableHorzScrollbar
true if horizontal scroll bar is enabled.
Definition: StaticText.h:318
HorizontalTextFormatting d_horzFormatting
Horizontal formatting to be applied to the text.
Definition: StaticText.h:313
Static class for the FalagardBase module.
Definition: Static.h:57
Class that encapsulates a typeface.
Definition: Font.h:62
String class used within the GUI system.
Definition: String.h:64
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
VerticalTextFormatting
Enumeration of possible values to indicate the vertical formatting to be used for a text component.
Definition: Enums.h:85
HorizontalTextFormatting
Enumeration of possible values to indicate the horizontal formatting to be used for a text component.
Definition: Enums.h:96