/usr/include/CEGUI/WindowRendererSets/Falagard/FalStaticText.h is in libcegui-mk2-dev 0.7.6-3.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | /***********************************************************************
filename: FalStaticText.h
created: Tue Jul 5 2005
author: Paul D Turner <paul@cegui.org.uk>
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2006 Paul D Turner & The CEGUI Development Team
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
***************************************************************************/
#ifndef _FalStaticText_h_
#define _FalStaticText_h_
#include "FalModule.h"
#include "FalStatic.h"
#include "FalStaticTextProperties.h"
#include "../../falagard/CEGUIFalEnums.h"
#include "../../CEGUIColourRect.h"
#include <vector>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
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
*/
class FALAGARDBASE_API FalagardStaticText : public FalagardStatic
{
public:
static const utf8 TypeName[]; //!< type name for this widget.
/*************************************************************************
Child Widget name suffix constants
*************************************************************************/
static const String VertScrollbarNameSuffix; //!< Widget name suffix for the vertical scrollbar component.
static const String HorzScrollbarNameSuffix; //!< Widget name suffix for the horizontal scrollbar component.
/************************************************************************
Constructor / Destructor
*************************************************************************/
/*!
\brief
Constructor
*/
FalagardStaticText(const String& type);
//! Destructor.
~FalagardStaticText();
/************************************************************************
Scrolled text implementation
*************************************************************************/
/*!
\brief
Return a ColourRect object containing the colours used when rendering this widget.
*/
ColourRect getTextColours(void) const {return d_textCols;}
/*!
\brief
Return the current horizontal formatting option set for this widget.
*/
HorizontalTextFormatting getHorizontalFormatting(void) const {return d_horzFormatting;}
/*!
\brief
Return the current vertical formatting option set for this widget.
*/
VerticalTextFormatting getVerticalFormatting(void) const {return d_vertFormatting;}
/*!
\brief
Sets the colours to be applied when rendering the text.
*/
void setTextColours(const ColourRect& colours);
/*!
\brief
Set the vertical formatting required for the text.
*/
void setVerticalFormatting(VerticalTextFormatting v_fmt);
/*!
\brief
Set the horizontal formatting required for the text.
*/
void setHorizontalFormatting(HorizontalTextFormatting h_fmt);
/*!
\brief
Return whether the vertical scroll bar is set to be shown if needed.
*/
bool isVerticalScrollbarEnabled(void) const {return d_enableVertScrollbar;}
/*!
\brief
Return whether the horizontal scroll bar is set to be shown if needed.
*/
bool isHorizontalScrollbarEnabled(void) const {return d_enableHorzScrollbar;}
/*!
\brief
Set whether the vertical scroll bar will be shown if needed.
*/
void setVerticalScrollbarEnabled(bool setting);
/*!
\brief
Set whether the horizontal scroll bar will be shown if needed.
*/
void setHorizontalScrollbarEnabled(bool setting);
//! return the current horizontal formatted text extent in pixels.
float getHorizontalTextExtent() const;
//! return the current vertical formatted text extent in pixels.
float getVerticalTextExtent() const;
void render(void);
protected:
//! update string formatting (gets area size to use from looknfeel)
void updateFormatting() const;
//! update string formatting using given area size.
void updateFormatting(const Size& sz) const;
// overridden from FalagardStatic base class
void onLookNFeelAssigned();
void onLookNFeelUnassigned();
// text field with scrollbars methods
void renderScrolledText(void);
void configureScrollbars(void);
Scrollbar* getVertScrollbar(void) const;
Scrollbar* getHorzScrollbar(void) const;
Rect getTextRenderArea(void) const;
Size getDocumentSize(const Rect& renderArea) const;
void setupStringFormatter() const;
// overridden event handlers
bool onTextChanged(const EventArgs& e);
bool onSized(const EventArgs& e);
bool onFontChanged(const EventArgs& e);
bool onMouseWheel(const EventArgs& e);
// event subscribers
bool handleScrollbarChange(const EventArgs& e);
// properties
static FalagardStaticTextProperties::TextColours d_textColoursProperty;
static FalagardStaticTextProperties::VertFormatting d_vertFormattingProperty;
static FalagardStaticTextProperties::HorzFormatting d_horzFormattingProperty;
static FalagardStaticTextProperties::VertScrollbar d_vertScrollbarProperty;
static FalagardStaticTextProperties::HorzScrollbar d_horzScrollbarProperty;
static FalagardStaticTextProperties::HorzExtent d_horzExtentProperty;
static FalagardStaticTextProperties::VertExtent d_vertExtentProperty;
// implementation data
//! Horizontal formatting to be applied to the text.
HorizontalTextFormatting d_horzFormatting;
//! Vertical formatting to be applied to the text.
VerticalTextFormatting d_vertFormatting;
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.
//! Class that renders RenderedString with some formatting.
mutable FormattedRenderedString* d_formattedRenderedString;
typedef std::vector<Event::Connection> ConnectionList;
ConnectionList d_connections;
//! true when string formatting is up to date.
mutable bool d_formatValid;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _FalStaticText_h_
|