summaryrefslogtreecommitdiffstats
path: root/tdecore/tequivchars.h
blob: 5bd007a3d8fb3832a1c08ed0919e5265824d765f (plain)
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
#ifndef TEQUIVCHARS_H
#define TEQUIVCHARS_H

#include "tdelibs_export.h"

#include <tqstring.h>

/**
 *  Class representing a mapping of each alphanumeric character to its "collating
 *  equivalent" as defined by the Default Unicode Collation Entity Table (DUCET).
 *  The mapping is limited to single-codepoint characters <= U+FFFF.
 */
class TDECORE_EXPORT TEquivChars
{
public:
  /**
      @return copy of @param inputString modified such that each alphanumeric
      character is replaced with it's collating character equivalent. If the
      value @param isRegex is true, the input string is treated as a regular
      expression and the alphabetical characters inside Posix bracket [::]
      expressions are left as-is 
   */
  static const TQString replaceChars( const TQString &inputString, bool isRegex = false );
};

#endif // TEQUIVCHARS_H