Classes
class	wxAppBar< W >
	Dockable application bar template. More...

class	wxAppBarFrame
	Dockable application bar frame. More...

class	wxAppBarDialog
	Dockable application bar dialog. More...

class	wxCoInitializer
	Create an object of this class on stack to initialize/cleanup the COM automatically. More...

class	wxCryptoSession
	Cryptographics Session Base Class. More...

class	wxCryptoSessionRSAAES
	RSA AES Cryptographics Session. More...

class	wxCryptoHash
	Cryptographics Hash Base. More...

class	wxCryptoHashSHA1
	SHA-1 Cryptographics Hash. More...

class	wxCryptoKey
	Cryptographics Key Base. More...

class	wxPersistentAuiManager
	Supports saving/restoring wxAuiManager state. More...

class	wxPersistentTLWEx
	Supports saving/restoring wxTopLevelWindow state. More...

class	wxHexValidatorBase
	Base class for hexadecimal validator. More...

class	wxHexValidator< T >
	Validator for hexadecimal entries. More...

class	wxHostNameValidator
	Validator for host name. More...

class	wxFQDNValidator
	Validator for FQDN. More...

class	wxFQDNListValidator
	Validator for FQDN lists. More...

Macros
#define	wxABT_AUTOHIDETIMERID 1
	Application bar auto-hide timer ID.

#define	wxABT_AUTOHIDETIME 300
	Application bar auto-hide timer timeout.

#define	wxABT_AUTOHIDETIMERINTERVAL 3000
	Application bar auto-hide timer interval.

#define	WM_AB_NOTIFY 0x6f00
	Posted to notify application bar about system changes.

#define	wxABF_ALLOWFLOAT (1 << 0)
	Dockable application bar flags.

#define	wxABF_ALLOWDOCKTOP (1 << 1)
	Is docking on top of the screen allowed?

#define	wxABF_ALLOWDOCKBOTTOM (1 << 2)
	Is docking on bottom of the screen allowed?

#define	wxABF_ALLOWDOCKLEFT (1 << 3)
	Is docking left of the screen allowed?

#define	wxABF_ALLOWDOCKRIGHT (1 << 4)
	Is docking right of the screen allowed?

#define	wxABF_ALLOWDOCKANY (wxABF_ALLOWDOCKTOP \| wxABF_ALLOWDOCKBOTTOM \| wxABF_ALLOWDOCKLEFT \| wxABF_ALLOWDOCKRIGHT)
	Is docking at any edge of the screen allowed?

#define	wxABF_ALLOWDOCKHORIZONTAL (wxABF_ALLOWDOCKTOP \| wxABF_ALLOWDOCKBOTTOM)
	Is docking on top or bottom of the screen allowed?

#define	wxABF_ALLOWDOCKVERTICAL (wxABF_ALLOWDOCKLEFT \| wxABF_ALLOWDOCKRIGHT)
	Is docking left or right of the screen allowed?

#define	wxABF_ALLOWANY (wxABF_ALLOWFLOAT \| wxABF_ALLOWDOCKANY)
	Is floating and docking at any edge of the screen allowed?

#define	wxABF_ALWAYSONTOP (1 << 5)
	Is application bar always on top?

#define	wxABF_ALWAYSONTOPTASKBAR (1 << 6)
	Does application bar follow always on top state of the system taskbar?

#define	wxABF_AUTOHIDE (1 << 7)
	Is application bar setup for auto-hide?

#define	wxABF_AUTOHIDETASKBAR (1 << 8)
	Does application bar follow auto-hide state of the system taskbar?

#define	wxABF_ALLOWSIZING (1 << 9)
	Is application bar's sizing allowed?

#define	wxABF_HIDETASKBARTABWHENFLOATING (1 << 10)
	Should application bar's tab on the system taskbar hide when floating?

#define	wxABF_HIDETASKBARTABWHENDOCKED (1 << 11)
	Should application bar's tab on the system taskbar hide when docked?

#define	wxABF_ALWAYSHIDETASKBARTAB (wxABF_HIDETASKBARTABWHENFLOATING \| wxABF_HIDETASKBARTABWHENDOCKED)
	Should application bar's tab on the system taskbar hide always?

#define	wxABF_FULLSCREENAPPOPEN (1 << 12)
	Is full-screen application open?

#define	wxABF_AUTOHIDDEN (1 << 13)
	Is application bar auto-hidden right now?

#define	wxEXTEND_VERSION 0x01050300
	wxExtend Version

#define	wxEXTEND_VERSION_MAJ 1
	wxExtend Major Version

#define	wxEXTEND_VERSION_MIN 5
	wxExtend Minor Version

#define	wxEXTEND_VERSION_REV 3
	wxExtend Revision

#define	wxEXTEND_VERSION_BUILD 0
	wxExtend Build

#define	wxEXTEND_VERSION_STR "1.5.3"
	wxExtend Displayable Version

#define	wxEXTEND_BUILD_YEAR_STR "2022"
	wxExtend Build Year

#define	wxExtendVersion "15"
	wxExtend API Version

#define	_WINSOCKAPI_

#define	WXWIDGETS_CODE_ANALYSIS_WARNINGS ALL_CODE_ANALYSIS_WARNINGS 26812 26814

#define	WXEXTEND_API
	Public function calling convention.

#define	wxVERIFY(cond) (cond)
	Test if condition is true. When not true, raise debug assertion with the given message.

#define	wxPERSIST_AUIMGR_KIND "AuiManager"
	`wxPersistentAuiManager` kind for persistent storage

#define	wxPERSIST_AUIMGR_PERSPECTIVE "perspective"
	Name of the persistent storage variable for saving Aui manager state.

Enumerations
enum class	wxAppBarState { UNKNOWN = -2 , wxAppBarState::FLOAT = -1 , wxAppBarState::LEFT = ABE_LEFT , wxAppBarState::TOP = ABE_TOP , wxAppBarState::RIGHT = ABE_RIGHT , wxAppBarState::BOTTOM = ABE_BOTTOM }
	Dockable application bar states. More...

enum class	wxHexDecodeMode { wxHexDecodeMode::Strict , wxHexDecodeMode::SkipWS , wxHexDecodeMode::Relaxed }
	Elements of this enum specify the possible behaviours of wxHexDecode() when an invalid character is encountered. More...

enum	wxHexValidatorStyle { wxNUM_VAL_HEX_LOWERCASE = 0x1000 }
	Bit masks used for hexadecimal validator styles.

Functions
bool	wxAppBarIsDocked (wxAppBarState state)
	Returns if the application bar state represents docked state.

bool	wxAppBarIsDockedVert (wxAppBarState state)
	Returns if the application bar state represents vertically docked state.

bool	wxAppBarIsDockedHoriz (wxAppBarState state)
	Returns if the application bar state represents horizontally docked state.

WXHWND	wxAppBarGetZWnd (wxAppBarState state, int flags)
	Returns the window above which to Z-order the application bar.

UINT_PTR	wxAppBarGetTaskBarState ()
	Returns the current taskbar state.

bool WXEXTEND_API	wxAuiManagerUpdatePerspectiveCaptions (wxAuiManager &mgr, wxString &perspective)
	Updates perspective captions with matching captions from panes.

bool	wxGetDoWndAnimation ()
	Returns whether windows animation is enabled.

bool	wxModifyStyleEx (WXHWND hWnd, DWORD dwRemove, DWORD dwAdd, UINT nFlags=0)
	Modifies window extended style.

bool	wxInitializeLocale (wxLocale &locale, wxLanguage *language=NULL)
	Inizializes wxWidgets localization scheme.

bool WXEXTEND_API	wxCryptoVerifySignature (const wxCryptoHash &hash, _In_reads_bytes_(signature_size) const void *signature_data, size_t signature_size, const wxCryptoKey &key)
	Verifies if the hash matches signature and the public key.

bool	wxCryptoVerifySignature (const wxCryptoHash &hash, const wxMemoryBuffer &signature, const wxCryptoKey &key)
	Verifies if the hash matches signature and the public key.

constexpr size_t	wxHexEncodedSize (size_t len) noexcept
	Return the size needed for the buffer containing the encoded representation of a buffer of given length.

size_t WXEXTEND_API	wxHexEncode (char dst, size_t dstLen, const void src, size_t srcLen)
	Raw hex encoding function which encodes the contents of a buffer of the specified length into the buffer of the specified size.

wxString	wxHexEncode (const void *src, size_t srcLen)
	Hex encoding function which encodes the contents of a buffer of the specified length into the wxString.

wxString	wxHexEncode (const wxMemoryBuffer &buf)
	Hex encoding function which encodes the contents of a buffer into the wxString.

constexpr size_t	wxHexDecodedSize (size_t len) noexcept
	Return the buffer size necessary for decoding a hex string of the given length.

size_t WXEXTEND_API	wxHexDecode (void dst, size_t dstLen, const char src, size_t srcLen=wxNO_LEN, wxHexDecodeMode mode=wxHexDecodeMode::Strict, size_t *posErr=NULL)
	Raw decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the provided buffer of the given size.

size_t	wxHexDecode (void dst, size_t dstLen, const wxString &src, wxHexDecodeMode mode=wxHexDecodeMode::Strict, size_t posErr=NULL)
	Decoding function which decodes the contents of the string into the provided buffer of the given size.

wxMemoryBuffer WXEXTEND_API	wxHexDecode (const char src, size_t srcLen=wxNO_LEN, wxHexDecodeMode mode=wxHexDecodeMode::Strict, size_t posErr=NULL)
	Decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the buffer.

wxMemoryBuffer	wxHexDecode (const wxString &src, wxHexDecodeMode mode=wxHexDecodeMode::Strict, size_t *posErr=NULL)
	Decoding function which decodes the contents of the string into the buffer.

wxPersistentObject *	wxCreatePersistentObject (wxAuiManager *mgr)
	wxAuiManager's instantiation of wxCreatePersistentObject template

bool	wxURLIsProtected (char chr)
	Test if given character should be protected for URL encoding.

size_t	wxURLEncodedSize (size_t len)
	Return the size needed for the buffer containing the encoded representation of a string of given length.

size_t WXEXTEND_API	wxURLEncode (char dst, size_t dstLen, const char src, size_t srcLen)
	Raw URL encoding function which encodes the contents of a string of the specified length into the buffer of the specified size.

wxString	wxURLEncode (const char *src, size_t srcLen)
	URL encoding function which encodes the contents of a string of the specified length into the wxString.

wxString	wxURLEncode (const wxString &str)
	URL encoding function which encodes the contents of a string into the wxString.

wxString	wxURLEncode (const wxMemoryBuffer &buf)
	URL encoding function which encodes the contents of a buffer into the wxString.

size_t	wxURLDecodedSize (size_t len)
	Return the buffer size necessary for decoding a URL string of the given length.

size_t WXEXTEND_API	wxURLDecode (char dst, size_t dstLen, const char src, size_t srcLen=wxNO_LEN)
	Raw decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the provided buffer of the given size.

size_t	wxURLDecode (char *dst, size_t dstLen, const wxString &src)
	Decoding function which decodes the contents of the string into the provided buffer of the given size.

wxMemoryBuffer WXEXTEND_API	wxURLDecode (const char *src, size_t srcLen=wxNO_LEN)
	Decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the buffer.

wxMemoryBuffer	wxURLDecode (const wxString &src)
	Decoding function which decodes the contents of the string into the buffer.

wxString	wxXmlEscapeText (const wxString &str)
	Escapes text string for XML insertion.

wxString	wxXmlEscapeAttr (const wxString &str)
	Escapes attribute value string for XML insertion.

bool WXEXTEND_API	wxXmlHashNode (wxCryptoHash &hash, const wxXmlNode *node)
	Calculates hash of the node and all its children.

Detailed Description

Macro Definition Documentation

◆ WM_AB_NOTIFY

#define WM_AB_NOTIFY 0x6f00

Posted to notify application bar about system changes.

Parameters

[in]	wParam	Event identifier. One of the following values ABN_FULLSCREENAPP Notifies an appbar when a full-screen application is opening or closing. `lParam` is boolean flag specifying whether a full-screen application is opening or closing. This parameter is TRUE if the application is opening or FALSE if it is closing. ABN_POSCHANGED Notifies an appbar when an event has occurred that may affect the appbar's size and position. Events include changes in the taskbar's size, position, and visibility state, as well as the addition, removal, or resizing of another appbar on the same side of the screen. `lParam` is not used. ABN_STATECHANGE Notifies an appbar that the taskbar's autohide or always-on-top state has changed—that is, the user has selected or cleared the "Always on top" or "Auto hide" check box on the taskbar's property sheet. `lParam` is not used.
[in]	lParam	Event specific. See `wParam` for details.

◆ wxABF_ALLOWFLOAT

#define wxABF_ALLOWFLOAT (1 << 0)

Dockable application bar flags.

Is floating application bar allowed?

◆ wxVERIFY

#define wxVERIFY ( cond ) (cond)

Test if condition is true. When not true, raise debug assertion with the given message.

Test if condition is true. When not true, raise debug assertion.

Enumeration Type Documentation

◆ wxAppBarState

enum class wxAppBarState

strong

Dockable application bar states.

Enumerator
FLOAT	Application bar is floating on the desktop (normal window)
LEFT	Application bar is docked at the left edge of the desktop.
TOP	Application bar is docked at the top edge of the desktop.
RIGHT	Application bar is docked at the right edge of the desktop.
BOTTOM	Application bar is docked at the bottom edge of the desktop.

◆ wxHexDecodeMode

enum class wxHexDecodeMode

strong

Elements of this enum specify the possible behaviours of wxHexDecode() when an invalid character is encountered.

Enumerator
Strict	Normal behaviour: stop at any invalid characters.
SkipWS	Skip whitespace characters.
Relaxed	The most lenient behaviour: simply ignore all invalid characters.

Function Documentation

◆ wxAppBarGetTaskBarState()

UINT_PTR wxAppBarGetTaskBarState ( )

inline

Returns the current taskbar state.

Returns: The taskbar state

See also: SHAppBarMessage function

◆ wxAppBarGetZWnd()

WXHWND wxAppBarGetZWnd	(	wxAppBarState	state,
		int	flags )

inline

Returns the window above which to Z-order the application bar.

Parameters

[in]	state	The state of the application bar
[in]	flags	The flags of the application bar

Returns: The handle of the window

◆ wxAppBarIsDocked()

bool wxAppBarIsDocked ( wxAppBarState state )

inline

Returns if the application bar state represents docked state.

Parameters

[in] state The state of the application bar

Returns

true if the application bar state represents docked state
false otherwise

◆ wxAppBarIsDockedHoriz()

bool wxAppBarIsDockedHoriz ( wxAppBarState state )

inline

Returns if the application bar state represents horizontally docked state.

Parameters

[in] state The state of the application bar

Returns

true if the application bar state represents horizontally docked state
false otherwise

◆ wxAppBarIsDockedVert()

bool wxAppBarIsDockedVert ( wxAppBarState state )

inline

Returns if the application bar state represents vertically docked state.

Parameters

[in] state The state of the application bar

Returns

true if the application bar state represents vertically docked state
false otherwise

◆ wxAuiManagerUpdatePerspectiveCaptions()

bool WXEXTEND_API wxAuiManagerUpdatePerspectiveCaptions	(	wxAuiManager &	mgr,
		wxString &	perspective )

Updates perspective captions with matching captions from panes.

Parameters

[in]	mgr	wxAUI manager
[in,out]	perspective	Perspective string to update captions in

Returns

true when update succeeded
false otherwise

◆ wxCryptoVerifySignature() [1/2]

bool WXEXTEND_API wxCryptoVerifySignature	(	const wxCryptoHash &	hash,
		_In_reads_bytes_(signature_size) const void *	signature_data,
		size_t	signature_size,
		const wxCryptoKey &	key )

Verifies if the hash matches signature and the public key.

Parameters

[in]	hash	Hash
[in]	signature_data	Pointer to signature data
[in]	signature_size	Signature data size in bytes
[in]	key	Public key

Returns

true if verification succeeded and the hash matches
false otherwise

◆ wxCryptoVerifySignature() [2/2]

bool wxCryptoVerifySignature	(	const wxCryptoHash &	hash,
		const wxMemoryBuffer &	signature,
		const wxCryptoKey &	key )

inline

Verifies if the hash matches signature and the public key.

Parameters

[in]	hash	Hash
[in]	signature	Signature data
[in]	key	Public key

Returns

true if verification succeeded and the hash matches
false otherwise

◆ wxGetDoWndAnimation()

bool wxGetDoWndAnimation ( )

inline

Returns whether windows animation is enabled.

Returns

true when window animation is enabled
false otherwise

◆ wxHexDecode() [1/4]

wxMemoryBuffer WXEXTEND_API wxHexDecode	(	const char *	src,
		size_t	srcLen = wxNO_LEN,
		wxHexDecodeMode	mode = wxHexDecodeMode::Strict,
		size_t *	posErr = NULL )

Decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the buffer.

The function normally stops at any character invalid inside a hex-encoded string (i.e. not numeric nor 'A-Z' nor 'a-z') but can be made to skip the whitespace or all invalid characters using its mode argument

Parameters

[in]	src	Source buffer to decode
[in]	srcLen	Length of `src` buffer (in characters) or wxNO_LEN for zero terminated strings
[in]	mode	Desired behaviour on invalid characters (one of `wxHexDecodeMode` constants)
[out]	posErr	Error offset in source buffer (in characters)

Returns: Destination buffer with decoded data or an empty buffer if an error occured during decoding

◆ wxHexDecode() [2/4]

wxMemoryBuffer wxHexDecode	(	const wxString &	src,
		wxHexDecodeMode	mode = wxHexDecodeMode::Strict,
		size_t *	posErr = NULL )

inline

Decoding function which decodes the contents of the string into the buffer.

The function normally stops at any character invalid inside a hex-encoded string (i.e. not numeric nor 'A-Z' nor 'a-z') but can be made to skip the whitespace or all invalid characters using its mode argument

Parameters

[in]	src	Source string to decode
[in]	mode	Desired behaviour on invalid characters (one of `wxHexDecodeMode` constants)
[out]	posErr	Error offset in source buffer (in characters)

Returns: Destination buffer with decoded data or an empty buffer if an error occured during decoding

◆ wxHexDecode() [3/4]

size_t WXEXTEND_API wxHexDecode	(	void *	dst,
		size_t	dstLen,
		const char *	src,
		size_t	srcLen = wxNO_LEN,
		wxHexDecodeMode	mode = wxHexDecodeMode::Strict,
		size_t *	posErr = NULL )

Raw decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the provided buffer of the given size.

The function normally stops at any character invalid inside a hex-encoded string (i.e. not numeric nor 'A-Z' nor 'a-z') but can be made to skip the whitespace or all invalid characters using its mode argument

Parameters

[out]	dst	Destination buffer to receive decoded data
[in]	dstLen	Length of `dst` buffer (in bytes)
[in]	src	Source buffer to decode
[in]	srcLen	Length of `src` buffer (in characters) or wxNO_LEN for zero terminated strings
[in]	mode	Desired behaviour on invalid characters (one of `wxHexDecodeMode` constants)
[out]	posErr	Error offset in source buffer (in characters)

Returns: The length of the decoded data or wxCONV_FAILED if an error occurs such as the buffer is too small or the encoded string is invalid; in the latter case the posErr is filled with the position where the decoding stopped if it is not NULL

◆ wxHexDecode() [4/4]

size_t wxHexDecode	(	void *	dst,
		size_t	dstLen,
		const wxString &	src,
		wxHexDecodeMode	mode = wxHexDecodeMode::Strict,
		size_t *	posErr = NULL )

inline

Decoding function which decodes the contents of the string into the provided buffer of the given size.

The function normally stops at any character invalid inside a hex-encoded string (i.e. not numeric nor 'A-Z' nor 'a-z') but can be made to skip the whitespace or all invalid characters using its mode argument

Parameters

[out]	dst	Destination buffer to receive decoded data
[in]	dstLen	Length of `dst` buffer (in bytes)
[in]	src	Source string to decode
[in]	mode	Desired behaviour on invalid characters (one of `wxHexDecodeMode` constants)
[out]	posErr	Error offset in source buffer (in characters)

Returns: The length of the decoded data or wxCONV_FAILED if an error occurs such as the buffer is too small or the encoded string is invalid; in the latter case the posErr is filled with the position where the decoding stopped if it is not NULL

◆ wxHexDecodedSize()

constexpr size_t wxHexDecodedSize ( size_t len )

inlineconstexprnoexcept

Return the buffer size necessary for decoding a hex string of the given length.

Parameters

[in] len Length of the hex encoded string

Returns: Maximum decoded representation size (in bytes)

◆ wxHexEncode() [1/3]

size_t WXEXTEND_API wxHexEncode	(	char *	dst,
		size_t	dstLen,
		const void *	src,
		size_t	srcLen )

Raw hex encoding function which encodes the contents of a buffer of the specified length into the buffer of the specified size.

Parameters

[out]	dst	Destination buffer to receive Hex encoded data
[in]	dstLen	Length of `dst` buffer (in characters)
[in]	src	Source buffer to encode
[in]	srcLen	Length of `src` buffer (in bytes)

Returns: The length of the encoded data or wxCONV_FAILED if the buffer is not large enough; to determine the needed size you can either allocate a buffer of wxHexEncodedSize(srcLen) size or call the function with NULL buffer in which case the required size will be returned

◆ wxHexEncode() [2/3]

wxString wxHexEncode	(	const void *	src,
		size_t	srcLen )

inline

Hex encoding function which encodes the contents of a buffer of the specified length into the wxString.

Parameters

[in]	src	Source buffer to encode
[in]	srcLen	Length of `src` buffer (in bytes)

Returns: The hex encoded string

◆ wxHexEncode() [3/3]

wxString wxHexEncode ( const wxMemoryBuffer & buf )

inline

Hex encoding function which encodes the contents of a buffer into the wxString.

Parameters

[in] buf Source buffer to encode

Returns: The hex encoded string

◆ wxHexEncodedSize()

constexpr size_t wxHexEncodedSize ( size_t len )

inlineconstexprnoexcept

Return the size needed for the buffer containing the encoded representation of a buffer of given length.

Parameters

[in] len Length of the buffer

Returns: Maximum encoded representation size (in characters)

◆ wxInitializeLocale()

bool wxInitializeLocale	(	wxLocale &	locale,
		wxLanguage *	language = NULL )

inline

Inizializes wxWidgets localization scheme.

The language identifier is read from Language configuration string ("ll_CC" form expected). The path to folder containing localization catalogue PO files is read from LocalizationRepositoryPath configuration string.

Parameters

[in,out]	locale	Locale to initialize
[out]	language	Translation language

Returns

true when initialization succeeded
false otherwise

◆ wxModifyStyleEx()

bool wxModifyStyleEx	(	WXHWND	hWnd,
		DWORD	dwRemove,
		DWORD	dwAdd,
		UINT	nFlags = 0 )

inline

Modifies window extended style.

Parameters

[in]	hWnd	Handle of the window to modify.
[in]	dwRemove	Set of extended styles to remove.
[in]	dwAdd	Set of extended styles to add.
[in]	nFlags	Additional SWP_ flags to pass to SetWindowPos(). If zero, SetWindowPos() is not called.

Returns

true when the window extended style was modified
false if the window extended style was not neccessary

◆ wxURLDecode() [1/4]

size_t WXEXTEND_API wxURLDecode	(	char *	dst,
		size_t	dstLen,
		const char *	src,
		size_t	srcLen = wxNO_LEN )

Raw decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the provided buffer of the given size.

Parameters

[out]	dst	Destination buffer to receive decoded data
[in]	dstLen	Length of `dst` buffer (in bytes)
[in]	src	Source buffer to decode
[in]	srcLen	Length of `src` buffer (in characters) or wxNO_LEN for zero terminated strings

Returns: The length of the decoded data or wxCONV_FAILED if the buffer is not large enough; to determine the needed size you can either allocate a buffer of wxURLDecodedSize(srcLen) size or call the function with NULL string in which case the required size will be returned

◆ wxURLDecode() [2/4]

size_t wxURLDecode	(	char *	dst,
		size_t	dstLen,
		const wxString &	src )

inline

Decoding function which decodes the contents of the string into the provided buffer of the given size.

Parameters

[out]	dst	Destination buffer to receive decoded data
[in]	dstLen	Length of `dst` buffer (in bytes)
[in]	src	Source string to decode

Returns: The length of the decoded data or wxCONV_FAILED if the buffer is not large enough; to determine the needed size you can either allocate a buffer of wxURLDecodedSize(srcLen) size or call the function with NULL string in which case the required size will be returned

◆ wxURLDecode() [3/4]

wxMemoryBuffer WXEXTEND_API wxURLDecode	(	const char *	src,
		size_t	srcLen = wxNO_LEN )

Decoding function which decodes the contents of the string of specified length (or zero terminated by default) into the buffer.

Parameters

[in]	src	Source buffer to decode
[in]	srcLen	Length of `src` buffer (in characters) or wxNO_LEN for zero terminated strings

Returns: Destination buffer with decoded data or an empty buffer if an error occured during decoding

◆ wxURLDecode() [4/4]

wxMemoryBuffer wxURLDecode ( const wxString & src )

inline

Decoding function which decodes the contents of the string into the buffer.

Parameters

[in] src Source string to decode

Returns: Destination buffer with decoded data or an empty buffer if an error occured during decoding

◆ wxURLDecodedSize()

size_t wxURLDecodedSize ( size_t len )

inline

Return the buffer size necessary for decoding a URL string of the given length.

Parameters

[in] len Length of the URL encoded string

Returns: Maximum decoded representation size (in bytes)

◆ wxURLEncode() [1/4]

size_t WXEXTEND_API wxURLEncode	(	char *	dst,
		size_t	dstLen,
		const char *	src,
		size_t	srcLen )

Raw URL encoding function which encodes the contents of a string of the specified length into the buffer of the specified size.

Parameters

[out]	dst	Destination buffer to receive URL encoded data
[in]	dstLen	Length of `dst` buffer (in characters)
[in]	src	Source string to encode
[in]	srcLen	Length of `src` string (in bytes)

Returns: The length of the encoded data or wxCONV_FAILED if the buffer is not large enough; to determine the needed size you can either allocate a buffer of wxURLEncodedSize(srcLen) size or call the function with NULL string in which case the required size will be returned

◆ wxURLEncode() [2/4]

wxString wxURLEncode	(	const char *	src,
		size_t	srcLen )

inline

URL encoding function which encodes the contents of a string of the specified length into the wxString.

Parameters

[in]	src	Source string to encode
[in]	srcLen	Length of `src` string (in bytes)

Returns: The URL encoded string

◆ wxURLEncode() [3/4]

wxString wxURLEncode ( const wxMemoryBuffer & buf )

inline

URL encoding function which encodes the contents of a buffer into the wxString.

Parameters

[in] buf Source buffer to encode

Returns: The URL encoded string

◆ wxURLEncode() [4/4]

wxString wxURLEncode ( const wxString & str )

inline

URL encoding function which encodes the contents of a string into the wxString.

Parameters

[in] str Source string to encode

Returns: The URL encoded string

◆ wxURLEncodedSize()

size_t wxURLEncodedSize ( size_t len )

inline

Return the size needed for the buffer containing the encoded representation of a string of given length.

Parameters

[in] len Length of string (in bytes)

Returns: Maximum encoded representation size (in characters)

◆ wxURLIsProtected()

bool wxURLIsProtected ( char chr )

inline

Test if given character should be protected for URL encoding.

Parameters

[in] chr ASCII character

Returns

true if character should be protected
false otherwise

◆ wxXmlEscapeAttr()

wxString wxXmlEscapeAttr ( const wxString & str )

inline

Escapes attribute value string for XML insertion.

Parameters

[in] str Attribute value

Returns: Escaped string

◆ wxXmlEscapeText()

wxString wxXmlEscapeText ( const wxString & str )

inline

Escapes text string for XML insertion.

Parameters

[in] str Text string

Returns: Escaped string

◆ wxXmlHashNode()

bool WXEXTEND_API wxXmlHashNode	(	wxCryptoHash &	hash,
		const wxXmlNode *	node )

Calculates hash of the node and all its children.

Parameters

[in]	hash	Handle of a hash object
[in]	node	Root node

Classes

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ WM_AB_NOTIFY

◆ wxABF_ALLOWFLOAT

◆ wxVERIFY

Enumeration Type Documentation

◆ wxAppBarState

◆ wxHexDecodeMode

Function Documentation

◆ wxAppBarGetTaskBarState()

◆ wxAppBarGetZWnd()

◆ wxAppBarIsDocked()

◆ wxAppBarIsDockedHoriz()

◆ wxAppBarIsDockedVert()

◆ wxAuiManagerUpdatePerspectiveCaptions()

◆ wxCryptoVerifySignature() [1/2]

◆ wxCryptoVerifySignature() [2/2]

◆ wxGetDoWndAnimation()

◆ wxHexDecode() [1/4]

◆ wxHexDecode() [2/4]

◆ wxHexDecode() [3/4]

◆ wxHexDecode() [4/4]

◆ wxHexDecodedSize()

◆ wxHexEncode() [1/3]

◆ wxHexEncode() [2/3]

◆ wxHexEncode() [3/3]

◆ wxHexEncodedSize()

◆ wxInitializeLocale()

◆ wxModifyStyleEx()

◆ wxURLDecode() [1/4]

◆ wxURLDecode() [2/4]

◆ wxURLDecode() [3/4]

◆ wxURLDecode() [4/4]

◆ wxURLDecodedSize()

◆ wxURLEncode() [1/4]

◆ wxURLEncode() [2/4]

◆ wxURLEncode() [3/4]

◆ wxURLEncode() [4/4]

◆ wxURLEncodedSize()

◆ wxURLIsProtected()

◆ wxXmlEscapeAttr()

◆ wxXmlEscapeText()

◆ wxXmlHashNode()