Crazy Eddie's GUI System  0.8.4
BidiVisualMapping.h
00001 /***********************************************************************
00002     created:    Wed Aug 5 2009
00003     author:     Paul D Turner <paul@cegui.org.uk>
00004 *************************************************************************/
00005 /***************************************************************************
00006  *   Copyright (C) 2004 - 2009 Paul D Turner & The CEGUI Development Team
00007  *
00008  *   Permission is hereby granted, free of charge, to any person obtaining
00009  *   a copy of this software and associated documentation files (the
00010  *   "Software"), to deal in the Software without restriction, including
00011  *   without limitation the rights to use, copy, modify, merge, publish,
00012  *   distribute, sublicense, and/or sell copies of the Software, and to
00013  *   permit persons to whom the Software is furnished to do so, subject to
00014  *   the following conditions:
00015  *
00016  *   The above copyright notice and this permission notice shall be
00017  *   included in all copies or substantial portions of the Software.
00018  *
00019  *   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
00020  *   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
00021  *   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
00022  *   IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
00023  *   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
00024  *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
00025  *   OTHER DEALINGS IN THE SOFTWARE.
00026  ***************************************************************************/
00027 #ifndef _CEGUIBidiVisualMapping_h_
00028 #define _CEGUIBidiVisualMapping_h_
00029 
00030 #include "CEGUI/String.h"
00031 #include <vector>
00032 
00033 #if defined (_MSC_VER)
00034 #   pragma warning(push)
00035 #   pragma warning(disable : 4251)
00036 #endif
00037 
00038 // Start of CEGUI namespace section
00039 namespace CEGUI
00040 {
00042 enum BidiCharType
00043 {
00044     BCT_RIGHT_TO_LEFT,
00045     BCT_LEFT_TO_RIGHT,
00046     BCT_NEUTRAL
00047 };
00048 
00050 class CEGUIEXPORT BidiVisualMapping :
00051     public AllocatedObject<BidiVisualMapping>
00052 {
00053 public:
00055     typedef std::vector<int
00056         CEGUI_VECTOR_ALLOC(int)> StrIndexList;
00057 
00059     virtual ~BidiVisualMapping();
00060 
00071     virtual BidiCharType getBidiCharType(const String::value_type char_to_check) const = 0;
00072 
00073 
00097     virtual bool reorderFromLogicalToVisual(const String& logical,
00098                                             String& visual,
00099                                             StrIndexList& l2v,
00100                                             StrIndexList& v2l) const = 0;
00114     bool updateVisual(const String& logical);
00115 
00116 
00117     const StrIndexList getL2vMapping() const
00118         {return d_l2vMapping;}
00119     const StrIndexList getV2lMapping() const
00120         {return d_v2lMapping;}
00121     const String& getTextVisual() const
00122         {return d_textVisual;}
00123 
00124 protected:
00125     StrIndexList d_l2vMapping;
00126     StrIndexList d_v2lMapping;
00127     String d_textVisual;
00128 };
00129 
00130 } // End of  CEGUI namespace section
00131 
00132 #if defined (_MSC_VER)
00133 #   pragma warning(pop)
00134 #endif
00135 
00136 #endif  // end of guard _CEGUIBidiVisualMapping_h_
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends