Adobe.com
Contents Suites Classes Class Index Member Index

ai::GlobalUnicodeString Class Reference

#include <IAIGlobalUnicodeString.hpp>

List of all members.

Public Member Functions

template<std::size_t N>
constexpr GlobalUnicodeString (const char(&str)[N], AICharacterEncoding encoding) AINOEXCEPT
 Constructor : Create with a literal string ai::GlobalUnicodeString gStr ("my global string", kAIRomanCharacterEncoding); ai::GlobalUnicodeString gStr2 ("My UTF8 string", kAIUTF8CharacterEncoding);.
mSize mEncoding (encoding)
constexpr GlobalUnicodeString (const ai::LiteralString &str, AICharacterEncoding encoding) AINOEXCEPT
 Constructor: Create with an ai::LiteralString constexpr ai::LiteralString str ("a literal string"); ai::GlobalUnicodeString gStr4(str, kAIRomanCharacterEncoding);.
 GlobalUnicodeString (const ZRef key)
 Constructor: Create with a ZRef ai::GlobalUnicodeString gStr3 (ZREF("$$$/MyZstringKey=String Value"));.
 GlobalUnicodeString (ai::UnicodeString str)
 Constructor: Create with an ai::UnicodeString.
const ai::UnicodeStringGet () const
 Returns the reference to global ai::UnicodeString stored for this GlobalUnicodeString.
void Set (ai::UnicodeString newStr)
 Changes the value of the associated global string.
 operator const ai::UnicodeString & () const
 Returns the reference to global ai::UnicodeString stored for this GlobalUnicodeString.

Public Attributes

mSize N

Constructor & Destructor Documentation

template<std::size_t N>
constexpr ai::GlobalUnicodeString::GlobalUnicodeString ( const char(&)  str[N],
AICharacterEncoding  encoding 
) [inline]

Constructor : Create with a literal string ai::GlobalUnicodeString gStr ("my global string", kAIRomanCharacterEncoding); ai::GlobalUnicodeString gStr2 ("My UTF8 string", kAIUTF8CharacterEncoding);.

constexpr ai::GlobalUnicodeString::GlobalUnicodeString ( const ai::LiteralString str,
AICharacterEncoding  encoding 
) [inline]

Constructor: Create with an ai::LiteralString constexpr ai::LiteralString str ("a literal string"); ai::GlobalUnicodeString gStr4(str, kAIRomanCharacterEncoding);.

ai::GlobalUnicodeString::GlobalUnicodeString ( const ZRef  key  )  [inline]

Constructor: Create with a ZRef ai::GlobalUnicodeString gStr3 (ZREF("$$$/MyZstringKey=String Value"));.

ai::GlobalUnicodeString::GlobalUnicodeString ( ai::UnicodeString  str  ) 

Constructor: Create with an ai::UnicodeString.

Note:
: Use this constructor only in function which gets called after Startup Plugin as function static object. Do not Create ai::GlobalUnicodeString object with this constructor at global scope.

References AIGlobalUnicodeStringSuite::AddString, and ai::Ensures().


Member Function Documentation

const ai::UnicodeString & ai::GlobalUnicodeString::Get (  )  const

Returns the reference to global ai::UnicodeString stored for this GlobalUnicodeString.

References AIGlobalUnicodeStringSuite::AddString, ai::Ensures(), and ZREF().

Referenced by operator const ai::UnicodeString &().

mSize ai::GlobalUnicodeString::mEncoding ( encoding   )  [inline]
Type Constraints
ai::GlobalUnicodeString::operator const ai::UnicodeString & (  )  const [inline]

Returns the reference to global ai::UnicodeString stored for this GlobalUnicodeString.

References Get().

void ai::GlobalUnicodeString::Set ( ai::UnicodeString  newStr  ) 

Changes the value of the associated global string.

References AIGlobalUnicodeStringSuite::AddString, ai::Ensures(), and ai::UnicodeString::swap().


Member Data Documentation


The documentation for this class was generated from the following files:


Contents Suites Classes Class Index Member Index
Adobe Solutions Network
 
Copyright © 2014 Adobe Systems Incorporated. All rights reserved.
Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks