Crazy Eddie's GUI System 0.8.7
BidiVisualMapping.h
1/***********************************************************************
2 created: Wed Aug 5 2009
3 author: Paul D Turner <paul@cegui.org.uk>
4*************************************************************************/
5/***************************************************************************
6 * Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
22 * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
23 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
25 * OTHER DEALINGS IN THE SOFTWARE.
26 ***************************************************************************/
27#ifndef _CEGUIBidiVisualMapping_h_
28#define _CEGUIBidiVisualMapping_h_
29
30#include "CEGUI/String.h"
31#include <vector>
32
33#if defined (_MSC_VER)
34# pragma warning(push)
35# pragma warning(disable : 4251)
36#endif
37
38// Start of CEGUI namespace section
39namespace CEGUI
40{
43{
44 BCT_RIGHT_TO_LEFT,
45 BCT_LEFT_TO_RIGHT,
46 BCT_NEUTRAL
47};
48
50class CEGUIEXPORT BidiVisualMapping :
51 public AllocatedObject<BidiVisualMapping>
52{
53public:
55 typedef std::vector<int
56 CEGUI_VECTOR_ALLOC(int)> StrIndexList;
57
60
71 virtual BidiCharType getBidiCharType(const String::value_type char_to_check) const = 0;
72
73
97 virtual bool reorderFromLogicalToVisual(const String& logical,
98 String& visual,
99 StrIndexList& l2v,
100 StrIndexList& v2l) const = 0;
114 bool updateVisual(const String& logical);
115
116
117 const StrIndexList getL2vMapping() const
118 {return d_l2vMapping;}
119 const StrIndexList getV2lMapping() const
120 {return d_v2lMapping;}
121 const String& getTextVisual() const
122 {return d_textVisual;}
123
124protected:
125 StrIndexList d_l2vMapping;
126 StrIndexList d_v2lMapping;
127 String d_textVisual;
128};
129
130} // End of CEGUI namespace section
131
132#if defined (_MSC_VER)
133# pragma warning(pop)
134#endif
135
136#endif // end of guard _CEGUIBidiVisualMapping_h_
Definition: MemoryAllocatedObject.h:110
Abstract class to wrap a Bidi visual mapping of a text string.
Definition: BidiVisualMapping.h:52
std::vector< int CEGUI_VECTOR_ALLOC(int)> StrIndexList
type definition for collection used to hold mapping index lists.
Definition: BidiVisualMapping.h:56
virtual bool reorderFromLogicalToVisual(const String &logical, String &visual, StrIndexList &l2v, StrIndexList &v2l) const =0
Reorder a string from a logical (type order) bidi string to a visual (the way it displayed) string.
virtual BidiCharType getBidiCharType(const String::value_type char_to_check) const =0
Gets the Bidi char type of a char.
bool updateVisual(const String &logical)
Use reorderFromLogicalToVisual to update the internal visual mapping data and visual string represent...
virtual ~BidiVisualMapping()
Destructor.
String class used within the GUI system.
Definition: String.h:64
utf32 value_type
Basic 'code point' type used for String (utf32)
Definition: String.h:69
Main namespace for Crazy Eddie's GUI Library.
Definition: arch_overview.dox:1
BidiCharType
Enumeration of possible character classes, used for bi-directional text.
Definition: BidiVisualMapping.h:43