DartTolk class

Bindings for the Tolk screen reader library

Constructors

DartTolk(DynamicLibrary dynamicLibrary)
The symbols are looked up in dynamicLibrary.
DartTolk.fromLookup(Pointer<T> lookup<T extends NativeType>(String symbolName))
The symbols are looked up with lookup.

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

btowc(int _Ch) → int
fgetwc(Pointer<FILE> _Stream) → int
fgetws(Pointer<wchar_t> _Buffer, int _BufferCount, Pointer<FILE> _Stream) → Pointer<wchar_t>
fputwc(int _Character, Pointer<FILE> _Stream) → int
fputws(Pointer<wchar_t> _Buffer, Pointer<FILE> _Stream) → int
getwc(Pointer<FILE> _Stream) → int
getwchar() → int
is_wctype(int _C, int _Type) → int
isleadbyte(int _C) → int
iswalnum(int _C) → int
iswalpha(int _C) → int
iswascii(int _C) → int
iswblank(int _C) → int
iswcntrl(int _C) → int
iswctype(int _C, int _Type) → int
iswdigit(int _C) → int
iswgraph(int _C) → int
iswlower(int _C) → int
iswprint(int _C) → int
iswpunct(int _C) → int
iswspace(int _C) → int
iswupper(int _C) → int
iswxdigit(int _C) → int
mbrlen(Pointer<Int8> _Ch, int _SizeInBytes, Pointer<mbstate_t> _State) → int
mbrtowc(Pointer<wchar_t> _DstCh, Pointer<Int8> _SrcCh, int _SizeInBytes, Pointer<mbstate_t> _State) → int
mbsrtowcs(Pointer<wchar_t> _Dest, Pointer<Pointer<Int8>> _PSrc, int _Count, Pointer<mbstate_t> _State) → int
mbsrtowcs_s(Pointer<size_t> _Retval, Pointer<wchar_t> _Dst, int _Size, Pointer<Pointer<Int8>> _PSrc, int _N, Pointer<mbstate_t> _State) → int
memchr(Pointer<Void> _Buf, int _Val, int _MaxCount) → Pointer<Void>
memcmp(Pointer<Void> _Buf1, Pointer<Void> _Buf2, int _Size) → int
memcpy(Pointer<Void> _Dst, Pointer<Void> _Src, int _Size) → Pointer<Void>
memmove(Pointer<Void> _Dst, Pointer<Void> _Src, int _Size) → Pointer<Void>
memset(Pointer<Void> _Dst, int _Val, int _Size) → Pointer<Void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
putwc(int _Character, Pointer<FILE> _Stream) → int
putwchar(int _Character) → int
strchr(Pointer<Int8> _Str, int _Val) → Pointer<Int8>
strrchr(Pointer<Int8> _Str, int _Ch) → Pointer<Int8>
strstr(Pointer<Int8> _Str, Pointer<Int8> _SubStr) → Pointer<Int8>
Tolk_Braille(Pointer<wchar_t> str) → bool
Name: Tolk_Braille Description: Brailles text through the current screen reader driver, if one is set and supports braille output. If none is set or if it encountered an error, tries to detect the currently active screen reader before brailling the given text. Use this function only if you specifically need to braille text through the current screen reader without also speaking it. Not all screen reader drivers may support this functionality. Therefore, use Tolk_Output whenever possible. You should call Tolk_Load once before using this function. Parameters: str: text to braille. Returns: true on success, false otherwise.
Tolk_DetectScreenReader() → Pointer<wchar_t>
Name: Tolk_DetectScreenReader Description: Returns the common name for the currently active screen reader driver, if one is set. If none is set, tries to detect the currently active screen reader before looking up the name. If no screen reader is active, NULL is returned. Note that the drivers hard-code the common name, it is not requested from the screen reader itself. You should call Tolk_Load once before using this function. Parameters: None. Returns: A Unicode string representation of the common name on success, NULL otherwise.
Tolk_HasBraille() → bool
Name: Tolk_HasBraille Description: Tests if the current screen reader driver supports braille output, if one is set. If none is set, tries to detect the currently active screen reader before testing for braille support. You should call Tolk_Load once before using this function. Parameters: None. Returns: true if the current screen reader driver supports braille, false otherwise.
Tolk_HasSpeech() → bool
Name: Tolk_HasSpeech Description: Tests if the current screen reader driver supports speech output, if one is set. If none is set, tries to detect the currently active screen reader before testing for speech support. You should call Tolk_Load once before using this function. Parameters: None. Returns: true if the current screen reader driver supports speech, false otherwise.
Tolk_IsLoaded() → bool
Name: Tolk_IsLoaded Description: Tests if Tolk has been initialized. Parameters: None. Returns: true if Tolk has been initialized, false otherwise.
Tolk_IsSpeaking() → bool
Name: Tolk_IsSpeaking Description: Tests if the screen reader associated with the current screen reader driver is speaking, if one is set and supports querying for status information. If none is set, tries to detect the currently active screen reader before testing if it is speaking. You should call Tolk_Load once before using this function. Parameters: None. Returns: true if text is being spoken by the screen reader, false otherwise.
Tolk_Load() → void
Name: Tolk_Load Description: Initializes Tolk by loading and initializing the screen reader drivers and setting the current screen reader driver, provided at least one of the supported screen readers is active. Also initializes COM if it has not already been initialized on the calling thread. Calling this function more than once will only initialize COM. You should call this function before using the functions below. Use Tolk_IsLoaded to determine if Tolk has been initialized. Parameters: None. Returns: None.
Tolk_Output(Pointer<wchar_t> str, bool interrupt) → bool
Tolk_PreferSAPI(bool preferSAPI) → void
Name: Tolk_PreferSAPI Description: If auto-detection for SAPI has been turned on through Tolk_TrySAPI, sets if SAPI should be placed first (true) or last (false) in the screen reader detection list. Putting it last is the default and is good for using SAPI as a fallback option. Putting it first is good for ensuring SAPI is used even when a screen reader is running, but keep in mind screen readers will still be tried if SAPI is unavailable. This function triggers the screen reader detection process if needed. For best performance, you should call this function before calling Tolk_Load. Parameters: preferSAPI: whether or not to prefer SAPI over screen reader drivers in auto-detection. Returns: None.
Tolk_Silence() → bool
Name: Tolk_Silence Description: Silences the screen reader associated with the current screen reader driver, if one is set and supports speech output. If none is set or if it encountered an error, tries to detect the currently active screen reader before silencing it. You should call Tolk_Load once before using this function. Parameters: None. Returns: true on success, false otherwise.
Tolk_Speak(Pointer<wchar_t> str, bool interrupt) → bool
Tolk_TrySAPI(bool trySAPI) → void
Name: Tolk_TrySAPI Description: Sets if Microsoft Speech API (SAPI) should be used in the screen reader auto-detection process. The default is not to include SAPI. The SAPI driver will use the system default synthesizer, voice and soundcard. This function triggers the screen reader detection process if needed. For best performance, you should call this function before calling Tolk_Load. Parameters: trySAPI: whether or not to include SAPI in auto-detection. Returns: None.
Tolk_Unload() → void
Name: Tolk_Unload Description: Finalizes Tolk by finalizing and unloading the screen reader drivers and clearing the current screen reader driver, provided one was set. Also uninitializes COM on the calling thread. Calling this function more than once will only uninitialize COM. You should not use the functions below if this function has been called. Parameters: None. Returns: None.
toString() → String
A string representation of this object.
inherited
towlower(int _C) → int
towupper(int _C) → int
ungetwc(int _Character, Pointer<FILE> _Stream) → int
wcrtomb(Pointer<Int8> _Dest, int _Source, Pointer<mbstate_t> _State) → int
wcrtomb_s(Pointer<size_t> _Retval, Pointer<Int8> _Dst, int _SizeInBytes, int _Ch, Pointer<mbstate_t> _State) → int
wcscat(Pointer<wchar_t> _Destination, Pointer<wchar_t> _Source) → Pointer<wchar_t>
wcscat_s(Pointer<wchar_t> _Destination, int _SizeInWords, Pointer<wchar_t> _Source) → int
wcschr(Pointer<wchar_t> _Str, int _Ch) → Pointer<Uint16>
wcscmp(Pointer<wchar_t> _String1, Pointer<wchar_t> _String2) → int
wcscoll(Pointer<wchar_t> _String1, Pointer<wchar_t> _String2) → int
wcscpy(Pointer<wchar_t> _Destination, Pointer<wchar_t> _Source) → Pointer<wchar_t>
wcscpy_s(Pointer<wchar_t> _Destination, int _SizeInWords, Pointer<wchar_t> _Source) → int
wcscspn(Pointer<wchar_t> _String, Pointer<wchar_t> _Control) → int
wcsdup(Pointer<wchar_t> _String) → Pointer<wchar_t>
wcsftime(Pointer<wchar_t> _Buffer, int _SizeInWords, Pointer<wchar_t> _Format, Pointer<tm> _Tm) → int
wcsicmp(Pointer<wchar_t> _String1, Pointer<wchar_t> _String2) → int
wcsicoll(Pointer<wchar_t> _String1, Pointer<wchar_t> _String2) → int
wcslen(Pointer<wchar_t> _String) → int
wcslwr(Pointer<wchar_t> _String) → Pointer<wchar_t>
wcsncat(Pointer<wchar_t> _Destination, Pointer<wchar_t> _Source, int _Count) → Pointer<wchar_t>
wcsncat_s(Pointer<wchar_t> _Destination, int _SizeInWords, Pointer<wchar_t> _Source, int _MaxCount) → int
wcsncmp(Pointer<wchar_t> _String1, Pointer<wchar_t> _String2, int _MaxCount) → int
wcsncpy(Pointer<wchar_t> _Destination, Pointer<wchar_t> _Source, int _Count) → Pointer<wchar_t>
wcsncpy_s(Pointer<wchar_t> _Destination, int _SizeInWords, Pointer<wchar_t> _Source, int _MaxCount) → int
wcsnicmp(Pointer<wchar_t> _String1, Pointer<wchar_t> _String2, int _MaxCount) → int
wcsnlen(Pointer<wchar_t> _Source, int _MaxCount) → int
wcsnset(Pointer<wchar_t> _String, int _Value, int _MaxCount) → Pointer<wchar_t>
wcspbrk(Pointer<wchar_t> _String, Pointer<wchar_t> _Control) → Pointer<wchar_t>
wcsrchr(Pointer<wchar_t> _Str, int _Ch) → Pointer<wchar_t>
wcsrev(Pointer<wchar_t> _String) → Pointer<wchar_t>
wcsrtombs(Pointer<Int8> _Dest, Pointer<Pointer<wchar_t>> _PSource, int _Count, Pointer<mbstate_t> _State) → int
wcsrtombs_s(Pointer<size_t> _Retval, Pointer<Int8> _Dst, int _SizeInBytes, Pointer<Pointer<wchar_t>> _Src, int _Size, Pointer<mbstate_t> _State) → int
wcsset(Pointer<wchar_t> _String, int _Value) → Pointer<wchar_t>
wcsspn(Pointer<wchar_t> _String, Pointer<wchar_t> _Control) → int
wcsstr(Pointer<wchar_t> _Str, Pointer<wchar_t> _SubStr) → Pointer<wchar_t>
wcstod(Pointer<wchar_t> _String, Pointer<Pointer<wchar_t>> _EndPtr) → double
wcstof(Pointer<wchar_t> _String, Pointer<Pointer<wchar_t>> _EndPtr) → double
wcstok(Pointer<wchar_t> _String, Pointer<wchar_t> _Delimiter, Pointer<Pointer<wchar_t>> _Context) → Pointer<wchar_t>
wcstok_s(Pointer<wchar_t> _String, Pointer<wchar_t> _Delimiter, Pointer<Pointer<wchar_t>> _Context) → Pointer<wchar_t>
wcstol(Pointer<wchar_t> _String, Pointer<Pointer<wchar_t>> _EndPtr, int _Radix) → int
wcstoll(Pointer<wchar_t> _String, Pointer<Pointer<wchar_t>> _EndPtr, int _Radix) → int
wcstoul(Pointer<wchar_t> _String, Pointer<Pointer<wchar_t>> _EndPtr, int _Radix) → int
wcstoull(Pointer<wchar_t> _String, Pointer<Pointer<wchar_t>> _EndPtr, int _Radix) → int
wcsupr(Pointer<wchar_t> _String) → Pointer<wchar_t>
wcsxfrm(Pointer<wchar_t> _Destination, Pointer<wchar_t> _Source, int _MaxCount) → int
wctob(int _WCh) → int
wmemcpy_s(Pointer<wchar_t> _S1, int _N1, Pointer<wchar_t> _S2, int _N) → int
wmemmove_s(Pointer<wchar_t> _S1, int _N1, Pointer<wchar_t> _S2, int _N) → int

Operators

operator ==(Object other) → bool
The equality operator.
inherited