Version: 3.0.4
wxUniChar Class Reference

#include <wx/unichar.h>

Detailed Description

This class represents a single Unicode character.

It can be converted to and from char or wchar_t and implements commonly used character operations.

Library:  wxBase
Category:  Data Structures

Public Types

typedef wxUint32 value_type
 A type capable of holding any Unicode code point. More...
 

Public Member Functions

 wxUniChar ()
 Default ctor. More...
 
 wxUniChar (int c)
 
 wxUniChar (unsigned int c)
 
 wxUniChar (long int c)
 
 wxUniChar (unsigned long int c)
 
 wxUniChar (short int c)
 
 wxUniChar (unsigned short int c)
 
 wxUniChar (wxLongLong_t c)
 
 wxUniChar (wxULongLong_t c)
 
 wxUniChar (const wxUniCharRef &c)
 
value_type GetValue () const
 Returns Unicode code point value of the character. More...
 
bool IsAscii () const
 Returns true if the character is an ASCII character (i.e. if its value is less than 128). More...
 
bool GetAsChar (char *c) const
 Returns true if the character is representable as a single byte in the current locale encoding. More...
 
 wxUniChar (char c)
 Create a character from the 8-bit character value c using the current locale encoding. More...
 
 wxUniChar (unsigned char c)
 Create a character from the 8-bit character value c using the current locale encoding. More...
 
 operator char () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator unsigned char () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator wchar_t () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator int () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator unsigned int () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator long int () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator unsigned long int () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator short int () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator unsigned short int () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator wxLongLong_t () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
 operator wxULongLong_t () const
 Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions. More...
 
wxUniCharoperator= (const wxUniChar &c)
 Assignment operators. More...
 
wxUniCharoperator= (const wxUniCharRef &c)
 Assignment operators. More...
 
wxUniCharoperator= (char c)
 Assignment operators. More...
 
wxUniCharoperator= (unsigned char c)
 Assignment operators. More...
 
wxUniCharoperator= (wchar_t c)
 Assignment operators. More...
 
wxUniCharoperator= (int c)
 Assignment operators. More...
 
wxUniCharoperator= (unsigned int c)
 Assignment operators. More...
 
wxUniCharoperator= (long int c)
 Assignment operators. More...
 
wxUniCharoperator= (unsigned long int c)
 Assignment operators. More...
 
wxUniCharoperator= (short int c)
 Assignment operators. More...
 
wxUniCharoperator= (unsigned short int c)
 Assignment operators. More...
 
wxUniCharoperator= (wxLongLong_t c)
 Assignment operators. More...
 
wxUniCharoperator= (wxULongLong_t c)
 Assignment operators. More...
 

Member Typedef Documentation

A type capable of holding any Unicode code point.

We do not use wchar_t as it cannot do the job on Win32, where wchar_t is a 16-bit type (wchar_t* is encoded using UTF-16 on Win32).

Constructor & Destructor Documentation

wxUniChar::wxUniChar ( )

Default ctor.

wxUniChar::wxUniChar ( char  c)

Create a character from the 8-bit character value c using the current locale encoding.

wxUniChar::wxUniChar ( unsigned char  c)

Create a character from the 8-bit character value c using the current locale encoding.

wxUniChar::wxUniChar ( int  c)
wxUniChar::wxUniChar ( unsigned int  c)
wxUniChar::wxUniChar ( long int  c)
wxUniChar::wxUniChar ( unsigned long int  c)
wxUniChar::wxUniChar ( short int  c)
wxUniChar::wxUniChar ( unsigned short int  c)
wxUniChar::wxUniChar ( wxLongLong_t  c)
wxUniChar::wxUniChar ( wxULongLong_t  c)
wxUniChar::wxUniChar ( const wxUniCharRef c)

Member Function Documentation

bool wxUniChar::GetAsChar ( char *  c) const

Returns true if the character is representable as a single byte in the current locale encoding.

This function only returns true if the character can be converted in exactly one byte, e.g. it only returns true for 7 bit ASCII characters when the encoding used is UTF-8.

It is mostly useful to test if the character can be passed to functions taking a char and is used by wxWidgets itself for this purpose.

Parameters
cAn output pointer to the value of this Unicode character as a char. Must be non-NULL.
Returns
true if the object is an 8 bit char and c was filled with its value as char or false otherwise (c won't be modified then).
See also
IsAscii()
Since
2.9.1
value_type wxUniChar::GetValue ( ) const

Returns Unicode code point value of the character.

bool wxUniChar::IsAscii ( ) const

Returns true if the character is an ASCII character (i.e. if its value is less than 128).

wxUniChar::operator char ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator int ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator long int ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator short int ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator unsigned char ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator unsigned int ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator unsigned long int ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator unsigned short int ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator wchar_t ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator wxLongLong_t ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar::operator wxULongLong_t ( ) const

Conversions to char and wchar_t types: all of those are needed to be able to pass wxUniChars to various standard narrow and wide character functions.

wxUniChar& wxUniChar::operator= ( const wxUniChar c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( const wxUniCharRef c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( char  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( unsigned char  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( wchar_t  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( int  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( unsigned int  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( long int  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( unsigned long int  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( short int  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( unsigned short int  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( wxLongLong_t  c)

Assignment operators.

wxUniChar& wxUniChar::operator= ( wxULongLong_t  c)

Assignment operators.