/usr/include/cegui-0.8.4/CEGUI/BasicRenderedStringParser.h is in libcegui-mk2-dev 0.8.4+dfsg-4ubuntu1.
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 | /***********************************************************************
created: 28/05/2009
author: Paul Turner
*************************************************************************/
/***************************************************************************
* Copyright (C) 2004 - 2009 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 _CEGUIBasicRenderedStringParser_h_
#define _CEGUIBasicRenderedStringParser_h_
#include "CEGUI/RenderedStringParser.h"
#include "CEGUI/Rect.h"
#include "CEGUI/ColourRect.h"
#include "CEGUI/String.h"
#include "CEGUI/falagard/Enums.h"
#include <map>
#if defined(_MSC_VER)
# pragma warning(push)
# pragma warning(disable : 4251)
#endif
// Start of CEGUI namespace section
namespace CEGUI
{
/*!
\brief
Basic RenderedStringParser class that offers support for the following tags:
- 'colour' value is a CEGUI colour property value.
- 'font' value is the name of a font.
- 'image' value is a CEGUI image property value.
- 'window' value is the name of a window.
- 'vert-alignment' value is either top, bottom, centre or stretch.
- 'padding' value is a CEGUI Rect property value.
- 'top-padding' value is a float.
- 'bottom-padding' value is a float.
- 'left-padding' value is a float.
- 'right-padding' value is a float.
- 'image-size' value is a CEGUI size property value.
- 'image-width' value is a float.
- 'image-height' value is a float.
- 'aspect-lock' value is a boolean (NB: this currently has no effect).
*/
class CEGUIEXPORT BasicRenderedStringParser : public RenderedStringParser
{
public:
// Strings for supported tags
static const String ColourTagName;
static const String FontTagName;
static const String ImageTagName;
static const String WindowTagName;
static const String VertAlignmentTagName;
static const String PaddingTagName;
static const String TopPaddingTagName;
static const String BottomPaddingTagName;
static const String LeftPaddingTagName;
static const String RightPaddingTagName;
static const String AspectLockTagName;
static const String ImageSizeTagName;
static const String ImageWidthTagName;
static const String ImageHeightTagName;
static const String TopAlignedValueName;
static const String BottomAlignedValueName;
static const String CentreAlignedValueName;
static const String StretchAlignedValueName;
//! Constructor.
BasicRenderedStringParser();
/*!
\brief
Initialising constructor.
\param initial_font
Reference to a String holding the name of the initial font to be used.
\param initial_colours
Reference to a ColourRect describing the initial colours to be used.
*/
BasicRenderedStringParser(const String& initial_font,
const ColourRect& initial_colours);
//! Destructor.
virtual ~BasicRenderedStringParser();
/*!
\brief
set the initial font name to be used on subsequent calls to parse.
\param font_name
String object holding the name of the font.
*/
void setInitialFontName(const String& font_name);
/*!
\brief
Set the initial colours to be used on subsequent calls to parse.
\param colours
ColourRect object holding the colours.
*/
void setInitialColours(const ColourRect& colours);
/*!
\brief
Return the name of the initial font used in each parse.
*/
const String& getInitialFontName() const;
/*!
\brief
Return a ColourRect describing the initial colours used in each parse.
*/
const ColourRect& getInitialColours() const;
// implement required interface from RenderedStringParser
RenderedString parse(const String& input_string,
const Font* initial_font,
const ColourRect* initial_colours);
protected:
//! append the text string \a text to the RenderedString \a rs.
virtual void appendRenderedText(RenderedString& rs, const String& text) const;
//! Process the control string \a ctrl_str.
virtual void processControlString(RenderedString& rs, const String& ctrl_str);
//! initialise the default state
virtual void initialiseDefaultState();
//! initialise tag handlers
void initialiseTagHandlers();
//! handlers for the various tags supported
void handleColour(RenderedString& rs, const String& value);
void handleFont(RenderedString& rs, const String& value);
void handleImage(RenderedString& rs, const String& value);
void handleWindow(RenderedString& rs, const String& value);
void handleVertAlignment(RenderedString& rs, const String& value);
void handlePadding(RenderedString& rs, const String& value);
void handleTopPadding(RenderedString& rs, const String& value);
void handleBottomPadding(RenderedString& rs, const String& value);
void handleLeftPadding(RenderedString& rs, const String& value);
void handleRightPadding(RenderedString& rs, const String& value);
void handleAspectLock(RenderedString& rs, const String& value);
void handleImageSize(RenderedString& rs, const String& value);
void handleImageWidth(RenderedString& rs, const String& value);
void handleImageHeight(RenderedString& rs, const String& value);
//! initial font name
String d_initialFontName;
//! initial colours
ColourRect d_initialColours;
//! active padding values.
Rectf d_padding;
//! active colour values.
ColourRect d_colours;
//! active font.
String d_fontName;
//! active vertical alignment
VerticalFormatting d_vertAlignment;
//! active image size
Sizef d_imageSize;
//! active 'aspect lock' state
bool d_aspectLock;
//! true if handlers have been registered
bool d_initialised;
//! definition of type used for handler functions
typedef void (BasicRenderedStringParser::*TagHandler)(RenderedString&,
const String&);
//! definition of type used to despatch tag handler functions
typedef std::map<String, TagHandler, StringFastLessCompare> TagHandlerMap;
//! Collection to map tag names to their handler functions.
TagHandlerMap d_tagHandlers;
};
} // End of CEGUI namespace section
#if defined(_MSC_VER)
# pragma warning(pop)
#endif
#endif // end of guard _CEGUIBasicRenderedStringParser_h_
|