/usr/include/CEGUI/WindowRendererSets/Falagard/FalMultiLineEditbox.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 | /***********************************************************************
filename: FalMultiLineEditbox.h
created: Thu Jul 7 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 _FalMultiLineEditbox_h_
#define _FalMultiLineEditbox_h_
#include "FalModule.h"
#include "../../elements/CEGUIMultiLineEditbox.h"
#include "FalMultiLineEditboxProperties.h"
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
MultiLineEditbox class for the FalagardBase module.
This class requires LookNFeel to be assigned. The LookNFeel should provide the following:
States:
- Enabled - Rendering for when the editbox is in enabled and is in read-write mode.
- ReadOnly - Rendering for when the editbox is in enabled and is in read-only mode.
- Disabled - Rendering for when the editbox is disabled.
NamedAreas:
TextArea - area where text, selection, and carat imagery will appear.
TextAreaHScroll - TextArea when only horizontal scrollbar is visible.
TextAreaVScroll - TextArea when only vertical scrollbar is visible.
TextAreaHVScroll - TextArea when both horizontal and vertical scrollbar is visible.
PropertyDefinitions (optional, defaults will be black):
- NormalTextColour - property that accesses a colour value to be used to render normal unselected text.
- SelectedTextColour - property that accesses a colour value to be used to render selected text.
- ActiveSelectionColour - property that accesses a colour value to be used to render active selection highlight.
- InactiveSelectionColour - property that accesses a colour value to be used to render inactive selection highlight.
Imagery Sections:
- Carat
Child Widgets:
Scrollbar based widget with name suffix "__auto_vscrollbar__"
Scrollbar based widget with name suffix "__auto_hscrollbar__"
*/
class FALAGARDBASE_API FalagardMultiLineEditbox : public MultiLineEditboxWindowRenderer
{
public:
static const utf8 TypeName[]; //! type name for this widget.
//! Name of property to use to obtain unselected text rendering colour.
static const String UnselectedTextColourPropertyName;
//! Name of property to use to obtain selected text rendering colour.
static const String SelectedTextColourPropertyName;
//! Name of property to use to obtain active selection rendering colour.
static const String ActiveSelectionColourPropertyName;
//! Name of property to use to obtain inactive selection rendering colour.
static const String InactiveSelectionColourPropertyName;
//! The default timeout (in seconds) used when blinking the caret.
static const float DefaultCaretBlinkTimeout;
/*!
\brief
Constructor
*/
FalagardMultiLineEditbox(const String& type);
// overridden from base classes.
Rect getTextRenderArea(void) const;
void render();
void update(float elapsed);
//! return whether the blinking caret is enabled.
bool isCaretBlinkEnabled() const;
//! return the caret blink timeout period (only used if blink is enabled).
float getCaretBlinkTimeout() const;
//! set whether the blinking caret is enabled.
void setCaretBlinkEnabled(bool enable);
//! set the caret blink timeout period (only used if blink is enabled).
void setCaretBlinkTimeout(float seconds);
protected:
/*!
\brief
Perform rendering of the widget control frame and other 'static' areas. This
method should not render the actual text. Note that the text will be rendered
to layer 4 and the selection brush to layer 3, other layers can be used for
rendering imagery behind and infront of the text & selection..
\return
Nothing.
*/
void cacheEditboxBaseImagery();
/*!
\brief
Render the carat.
\return
Nothing
*/
void cacheCaratImagery(const Rect& textArea);
/*!
\brief
Render text lines.
*/
void cacheTextLines(const Rect& dest_area);
/*!
\brief
return the colour to be used for rendering Editbox text oustside of the
selected region.
\return
colour value describing the colour to be used.
*/
colour getUnselectedTextColour() const;
/*!
\brief
return the colour to be used for rendering the selection highlight
when the editbox is active.
\return
colour value describing the colour to be used.
*/
colour getActiveSelectionColour() const;
/*!
\brief
return the colour to be used for rendering the selection highlight
when the editbox is inactive.
\return
colour value describing the colour to be used.
*/
colour getInactiveSelectionColour() const;
/*!
\brief
return the colour to be used for rendering Editbox text falling within
the selected region.
\return
colour value describing the colour to be used.
*/
colour getSelectedTextColour() const;
/*!
\brief
Return a colour object fetched from the named property if it exists,
else a default colour (black).
\param propertyName
String object holding the name of the property to be accessed if it
exists.
*/
colour getOptionalPropertyColour(const String& propertyName) const;
// properties
static FalagardMultiLineEditboxProperties::BlinkCaret d_blinkCaretProperty;
static FalagardMultiLineEditboxProperties::BlinkCaretTimeout d_blinkCaretTimeoutProperty;
//! true if the caret imagery should blink.
bool d_blinkCaret;
//! time-out in seconds used for blinking the caret.
float d_caretBlinkTimeout;
//! current time elapsed since last caret blink state change.
float d_caretBlinkElapsed;
//! true if caret should be shown.
bool d_showCaret;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _FalMultiLineEditbox_h_
|