Methods' Summary |
getName |
Unique ASCII name to identify a module. This name is used
to get its localized name for menus, dialogs etc. The behavior
is undefined for TransliterationType::CASCADE
modules.
|
getType |
Return the attribute(s) associated with this transliterator
object, as defined in TransliterationType. The
value is determined by the transliteration modules. For example,
for UPPERCASE_LOWERCASE, a ONE_TO_ONE is returned, for
IGNORE_CASE, IGNORE is returned.
|
loadModule |
Load instance of predefined module - old style method.
|
loadModuleNew |
Load a sequence of instances of predefined modules - supersedes
method XTransliteration::loadModule().
|
loadModuleByImplName |
Load instance of UNO registered module.
|
loadModulesByImplNames |
Load a sequence of instances of transliteration modules.
Output of one module is feeded as input to the next module in
the sequence. The object created by this call has
TransliterationType CASCADE and IGNORE types.
|
getAvailableModules |
List the available transliteration modules for a given locale.
It can be filtered based on its type.
|
transliterate |
Transliterate a substring. This method can be called if the
object doesn't have TransliterationType IGNORE
attribute.
|
folding |
[ DEPRECATED ]
|
equals |
Match two substrings and find if they are equivalent as per this
transliteration.
|
transliterateRange |
Transliterate one set of characters to another.
|
compareSubstring |
Compare 2 substrings as per this transliteration. It translates both
substrings before comparing them.
|
compareString |
Compare 2 strings as per this transliteration. It translates both
strings before comparing them.
|
Methods' Details |
getName
- Description
- Unique ASCII name to identify a module. This name is used
to get its localized name for menus, dialogs etc. The behavior
is undefined for TransliterationType::CASCADE
modules.
|
|
getType
- Description
- Return the attribute(s) associated with this transliterator
object, as defined in TransliterationType. The
value is determined by the transliteration modules. For example,
for UPPERCASE_LOWERCASE, a ONE_TO_ONE is returned, for
IGNORE_CASE, IGNORE is returned.
|
|
loadModule
- Description
- Load instance of predefined module - old style method.
|
|
loadModuleNew
|
loadModuleByImplName
void |
loadModuleByImplName( |
[in] string |
aImplName, |
| [in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- Load instance of UNO registered module.
Each transliteration module is registered under a different
service name. The convention for the service name is
com.sun.star.i18n.Transliteration.l10n.{implName}. The
{implName} is a unique name used to identify a module. The
implName is used to get a localized name for the transliteration
module. The implName is used in locale data to list the
available transliteration modules for the locale. There are some
transliteration modules that are always available. The names of
those modules are listed as enum
TransliterationModules names. For modules not
listed there it is possible to load them directly by their
implName.
- Parameter aImplName
- The module's {implName} under which it is registered with
com.sun.star.i18n.Transliteration.l10n.{implName}.
|
|
loadModulesByImplNames
void |
loadModulesByImplNames( |
[in] sequence< string > |
aImplNameList, |
| [in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- Load a sequence of instances of transliteration modules.
Output of one module is feeded as input to the next module in
the sequence. The object created by this call has
TransliterationType CASCADE and IGNORE types.
- Parameter aImplNameList
- Only IGNORE type modules can be specified.
|
|
getAvailableModules
sequence< string > |
getAvailableModules( |
[in] ::com::sun::star::lang::Locale |
aLocale, |
| [in] short |
nType ); |
- Description
- List the available transliteration modules for a given locale.
It can be filtered based on its type.
- Parameter nType
- A bitmask field of values defined in
TransliterationType
|
|
transliterate
string |
transliterate( |
[in] string |
aInStr, |
| [in] long |
nStartPos, |
| [in] long |
nCount, |
| [out] sequence< long > |
rOffset ); |
- Description
- Transliterate a substring. This method can be called if the
object doesn't have TransliterationType IGNORE
attribute.
- Parameter aStr
- The input string.
- Parameter nStartPos
- Start position within aStr from where transliteration starts.
- Parameter nCount
- Number of codepoints to be transliterated.
- Parameter rOffset
- To find the grapheme of input string corresponding to the
grapheme of output string, rOffset provides the offset array
whose index is the offset of output string, the element
containing the position within the input string before
transliteration.
|
|
folding
string |
folding( |
[in] string |
aInStr, |
| [in] long |
nStartPos, |
| [in] long |
nCount, |
| [out] sequence< long > |
rOffset ); |
- Usage Restrictions
- deprecated
- Deprecation Info
- For internal use, this method is supported to get the
"transliteration", which equals() is based on.
|
|
equals
boolean |
equals( |
[in] string |
aStr1, |
| [in] long |
nPos1, |
| [in] long |
nCount1, |
| [out] long |
rMatch1, |
| [in] string |
aStr2, |
| [in] long |
nPos2, |
| [in] long |
nCount2, |
| [out] long |
rMatch2 ); |
- Description
- Match two substrings and find if they are equivalent as per this
transliteration.
This method can be called if the object has
TransliterationType IGNORE attribute.
Returns the number of matched code points in any case, even if
strings are not equal, for example:
equals( "a", 0, 1, nMatch1, "aaa", 0, 3, nMatch2 )
returns false and nMatch:=1 and nMatch2:=1
equals( "aab", 0, 3, nMatch1, "aaa", 0, 3, nMatch2 )
returns false and nMatch:=2 and nMatch2:=2
- Parameter aStr1
- First string to match.
- Parameter nPos1
- Start position within aStr1.
- Parameter nCount1
- Number of code points to use of aStr1.
- Parameter rMatch1
- Returns number of matched code points in aStr1.
- Parameter aStr2
- Second string to match.
- Parameter nPos2
- Start position within aStr2.
- Parameter nCount2
- Number of code points to use of aStr2.
- Parameter rMatch2
- Returns number of matched code points in aStr2.
- Returns
- true if the substrings are equal per this
transliteration
false else.
|
|
transliterateRange
sequence< string > |
transliterateRange( |
[in] string |
aStr1, |
| [in] string |
aStr2 ); |
- Description
- Transliterate one set of characters to another.
This method is intended for getting corresponding ranges and
can be called if the object has TransliterationType
IGNORE attribute.
For example: generic CASE_IGNORE transliterateRange( "a", "i" )
returns {"A","I","a","i"}, transliterateRange( "a", "a" )
returns {"A","A","a","a"}.
Use this transliteration to create regular expresssions like
[a-i] --> [A-Ia-i].
- Returns
- String sequence containing corresponding transliterated
pairs of characters to represent a range.
|
|
compareSubstring
long |
compareSubstring( |
[in] string |
aStr1, |
| [in] long |
nOff1, |
| [in] long |
nLen1, |
| [in] string |
aStr2, |
| [in] long |
nOff2, |
| [in] long |
nLen2 ); |
- Description
- Compare 2 substrings as per this transliteration. It translates both
substrings before comparing them.
- Parameter aStr1
- First string.
- Parameter nOff1
- Offset (from 0) of the first substring.
- Parameter nLen1
- Length (from offset) of the first substring.
- Parameter aStr2
- Second string.
- Parameter nOff2
- Offset (from 0) of the second substring.
- Parameter nLen2
- Length (from offset) of the second substring.
- Returns
- 1 if the first substring is greater than the second substring
0 if the first substring is equal to the second substring
-1 if the first substring is less than the second substring
|
|
compareString
long |
compareString( |
[in] string |
aStr1, |
| [in] string |
aStr2 ); |
- Description
- Compare 2 strings as per this transliteration. It translates both
strings before comparing them.
- Returns
- 1 if the first string is greater than the second string
0 if the first string is equal to the second string
-1 if the first string is less than the second string
|
|
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.