# wx.UniChar¶

This class represents a single Unicode character.

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

## Class Hierarchy¶

Inheritance diagram for class UniChar:

## Methods Summary¶

 __init__ GetAsChar Returns True if the character is representable as a single byte in the current locale encoding. GetValue Returns Unicode code point value of the character. HighSurrogate Returns the high surrogate code unit for the supplementary character. IsAscii Returns True if the character is an ASCII character (i.e. if its value is less than 128). IsBMP Returns True if the character is a BMP character (i.e. if its value is less than 0x10000). IsSupplementary Returns True if the character is a supplementary character (i.e. between 0x10000 and 0x10FFFF). LowSurrogate Returns the low surrogate code unit for the supplementary character.

## Class API¶

class wx.UniChar(object)

Possible constructors:

UniChar(c)

UniChar(c)


This class represents a single Unicode character.

### Methods¶

__init__(self, *args, **kw)

__init__ (self, c)

Parameters

c (long) –

__init__ (self, c)

Parameters

c (long) –

GetAsChar(self, c)

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 int and is used by wxWidgets itself for this purpose.

Parameters

c (int) – An output pointer to the value of this Unicode character as a char . Must be not None.

Return type

bool

Returns

True if the object is an 8 bit int and c was filled with its value as int or False otherwise (c won’t be modified then).

New in version 2.9.1.

GetValue(self)

Returns Unicode code point value of the character.

Return type

value_type

HighSurrogate(self, *args, **kw)

HighSurrogate (self)

Returns the high surrogate code unit for the supplementary character.

Return type

wx.Uint16

New in version 4.1/wxWidgets-3.1.1.

Precondition

IsSupplementary

HighSurrogate (value)

Returns the high surrogate code unit for the supplementary character.

Parameters

value (wx.int) – The Unicode code point of the character.

Return type

wx.Uint16

New in version 4.1/wxWidgets-3.1.1.

Precondition

IsSupplementary

IsAscii(self)

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

Return type

bool

IsBMP(self, *args, **kw)

IsBMP (self)

Returns True if the character is a BMP character (i.e. if its value is less than 0x10000).

Return type

bool

New in version 4.1/wxWidgets-3.1.1.

IsBMP (value)

Returns True if the character is a BMP character (i.e. if its value is less than 0x10000).

Parameters

value (wx.int) – The Unicode code point of the character.

Return type

bool

New in version 4.1/wxWidgets-3.1.1.

IsSupplementary(self, *args, **kw)

IsSupplementary (self)

Returns True if the character is a supplementary character (i.e. between 0x10000 and 0x10FFFF).

Return type

bool

New in version 4.1/wxWidgets-3.1.1.

IsSupplementary (value)

Returns True if the character is a supplementary character (i.e. between 0x10000 and 0x10FFFF).

Parameters

value (wx.int) – The Unicode code point of the character.

Return type

bool

New in version 4.1/wxWidgets-3.1.1.

LowSurrogate(self, *args, **kw)

LowSurrogate (self)

Returns the low surrogate code unit for the supplementary character.

Return type

wx.Uint16

New in version 4.1/wxWidgets-3.1.1.

Precondition

IsSupplementary

LowSurrogate (value)

Returns the low surrogate code unit for the supplementary character.

Parameters

value (wx.int) – The Unicode code point of the character.

Return type

wx.Uint16

New in version 4.1/wxWidgets-3.1.1.

Precondition

IsSupplementary

### Properties¶

Value