|
| FalagardStaticText (const String &type) |
| Constructor.
|
|
| ~FalagardStaticText () |
| Destructor.
|
|
ColourRect | getTextColours (void) const |
| Return a ColourRect object containing the colours used when rendering this widget.
|
|
HorizontalTextFormatting | getHorizontalFormatting (void) const |
| Return the current horizontal formatting option set for this widget.
|
|
VerticalTextFormatting | getVerticalFormatting (void) const |
| Return the current vertical formatting option set for this widget.
|
|
void | setTextColours (const ColourRect &colours) |
| Sets the colours to be applied when rendering the text.
|
|
void | setVerticalFormatting (VerticalTextFormatting v_fmt) |
| Set the vertical formatting required for the text.
|
|
void | setHorizontalFormatting (HorizontalTextFormatting h_fmt) |
| Set the horizontal formatting required for the text.
|
|
bool | isVerticalScrollbarEnabled (void) const |
| Return whether the vertical scroll bar is set to be shown if needed.
|
|
bool | isHorizontalScrollbarEnabled (void) const |
| Return whether the horizontal scroll bar is set to be shown if needed.
|
|
void | setVerticalScrollbarEnabled (bool setting) |
| Set whether the vertical scroll bar will be shown if needed.
|
|
void | setHorizontalScrollbarEnabled (bool setting) |
| Set whether the horizontal scroll bar will be shown if needed.
|
|
float | getHorizontalTextExtent () const |
| return the current horizontal formatted text extent in pixels.
|
|
float | getVerticalTextExtent () const |
| return the current vertical formatted text extent in pixels.
|
|
bool | handleFontRenderSizeChange (const Font *const font) |
| Perform any updates needed because the given font's render size has changed.
|
|
void | render (void) |
| Populate render cache.
|
|
float | getHorizontalScrollPosition () const |
| Get the current position of the horizontal scrollbar within the text.
|
|
float | getVerticalScrollPosition () const |
| Get the current position of the vertical scrollbar within the text.
|
|
float | getUnitIntervalHorizontalScrollPosition () const |
| return the current horizontal scrollbar position as a value in the interval [0, 1].
|
|
float | getUnitIntervalVerticalScrollPosition () const |
| return the current vertical scrollbar position as a value in the interval [0, 1].
|
|
void | setHorizontalScrollPosition (float position) |
| Set the current position of the horizontal scrollbar within the text.
|
|
void | setVerticalScrollPosition (float position) |
| Set the current position of the vertical scrollbar within the text.
|
|
void | setUnitIntervalHorizontalScrollPosition (float position) |
| set the current horizontal scrollbar position as a value in the interval [0, 1].
|
|
void | setUnitIntervalVerticalScrollPosition (float position) |
| set the current vertical scrollbar position as a value in the interval [0, 1].
|
|
void | invalidateFormatting () |
| Invalidate string formatting and scrollbars visibility.
|
|
| FalagardStatic (const String &type) |
| type name for this widget.
|
|
bool | isFrameEnabled (void) const |
| Return whether the frame for this static widget is enabled or disabled.
|
|
bool | isBackgroundEnabled (void) const |
| Return whether the background for this static widget is enabled to disabled.
|
|
void | setFrameEnabled (bool setting) |
| Enable or disable rendering of the frame for this static widget.
|
|
void | setBackgroundEnabled (bool setting) |
| Enable or disable rendering of the background for this static widget.
|
|
| WindowRenderer (const String &name, const String &class_name="Window") |
| Constructor.
|
|
virtual | ~WindowRenderer () |
| Destructor.
|
|
const String & | getName () const |
| Returns the factory type name of this window renderer.
|
|
Window * | getWindow () const |
| Get the window this windowrenderer is attached to.
|
|
const String & | getClass () const |
| Get the "minimum" Window class this renderer requires.
|
|
const WidgetLookFeel & | getLookNFeel () const |
| Get the Look'N'Feel assigned to our window.
|
|
virtual Rectf | getUnclippedInnerRect () const |
| Get unclipped inner rectangle that our window should return from its member function with the same name.
|
|
virtual void | performChildWindowLayout () |
| Method called to perform extended laying out of the window's attached child windows.
|
|
virtual void | getRenderingContext (RenderingContext &ctx) const |
| update the RenderingContext as needed for our window. This is normally invoked via our window's member function with the same name.
|
|
virtual void | update (float) |
| perform any time based updates for this WindowRenderer.
|
|
|
void | updateFormatting () const |
| Update string formatting and scrollbars visibility.
|
|
void | updateFormatting (const Sizef &) const |
|
void | onLookNFeelAssigned () |
| Handler called when a Look'N'Feel is assigned to our window.
|
|
void | onLookNFeelUnassigned () |
| Handler called when a Look'N'Feel is removed/unassigned from our window.
|
|
void | renderScrolledText (void) |
|
void | configureScrollbars () const |
|
void | configureScrollbars (void) |
|
Scrollbar * | getVertScrollbar () const |
|
Scrollbar * | getHorzScrollbar () const |
|
Rectf | getTextRenderArea () const |
|
Sizef | getDocumentSize () const |
|
Sizef | getDocumentSize (const Rectf &renderArea) const |
|
void | setupStringFormatter () const |
|
bool | onTextChanged (const EventArgs &e) |
|
bool | onSized (const EventArgs &e) |
|
bool | onFontChanged (const EventArgs &e) |
|
bool | onMouseWheel (const EventArgs &e) |
|
bool | handleScrollbarChange (const EventArgs &e) |
|
void | registerProperty (Property *property, const bool ban_from_xml) |
| Register a property class that will be properly managed by this window renderer.
|
|
void | registerProperty (Property *property) |
| Register a property class that will be properly managed by this window renderer.
|
|
virtual void | onAttach () |
| Handler called when this windowrenderer is attached to a window.
|
|
virtual void | onDetach () |
| Handler called when this windowrenderer is detached from its window.
|
|
|
HorizontalTextFormatting | d_horzFormatting |
| Horizontal formatting to be applied to the text.
|
|
VerticalTextFormatting | d_vertFormatting |
| Vertical formatting to be applied to the text.
|
|
ColourRect | d_textCols |
| Colours used when rendering the text.
|
|
bool | d_enableVertScrollbar |
| true if vertical scroll bar is enabled.
|
|
bool | d_enableHorzScrollbar |
| true if horizontal scroll bar is enabled.
|
|
FormattedRenderedString * | d_formattedRenderedString |
| Class that renders RenderedString with some formatting.
|
|
ConnectionList | d_connections |
|
bool | d_formatValid |
| True when string formatting and scrollbars visibility are up to date.
|
|
bool | d_frameEnabled |
| True when the frame is enabled.
|
|
bool | d_backgroundEnabled |
| true when the background is enabled.
|
|
Window * | d_window |
| Pointer to the window this windowrenderer is assigned to.
|
|
const String | d_name |
| Name of the factory type used to create this window renderer.
|
|
const String | d_class |
| Name of the widget class that is the "minimum" requirement.
|
|
PropertyList | d_properties |
| The list of properties that this windowrenderer will be handling.
|
|
StaticText class for the FalagardBase module.
This class requires LookNFeel to be assigned. The LookNFeel should provide the following:
States:
- Enabled - basic rendering for enabled state.
- Disabled - basic rendering for disabled state.
- EnabledFrame - frame rendering for enabled state
- DisabledFrame - frame rendering for disabled state.
- WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
- WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
- NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
- NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.
Named Areas (missing areas will default to 'WithFrameTextRenderArea'): WithFrameTextRenderArea WithFrameTextRenderAreaHScroll WithFrameTextRenderAreaVScroll WithFrameTextRenderAreaHVScroll NoFrameTextRenderArea NoFrameTextRenderAreaHScroll NoFrameTextRenderAreaVScroll NoFrameTextRenderAreaHVScroll