kanzi::WindowsIme Class Reference

#include <kanzi/core.ui/platform/input/win32/windows_ime.hpp>

Inheritance diagram for kanzi::WindowsIme:

Public Member Functions
bool	processMessages (HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam, EventQueue *queue)
	WindowsIme (Domain *domain)
Public Member Functions inherited from kanzi::InputMethod
void	connect (InputMethodListener &listener, Node &attachedNode)
	Connects an input method listener to this input method.
void	disconnect (InputMethodListener &listener)
	Disconnects the listener passed as argument.
void	ensureAvailable (InputMethodListener &listener)
	Ensures that the input method is available for the input method listener.
InputMethodListener *	getListener () const
	Returns the active listener of the input method.
bool	isBlocked () const
	Checks whether the input method is blocked by another input method that is in the text composition state.
void	notifyCompositionEnd (InputMethodListener &listener)
	Notifies the input method that text composition is completed or canceled on the listener.
void	notifyCompositionStart (InputMethodListener &listener)
	Notifies the input method that text composition is started on the listener.
void	notifyCursorMove (InputMethodListener &listener, size_t position)
	Notifies the input method about the cursor position change in a listener.
void	notifyInputMethodActionChange (InputMethodListener &listener, InputMethodAction action)
	Notifies the input method that the input method action associated with the input method listener changed.
bool	notifyInputTypeAttributesChange (InputMethodListener &listener, EchoMode echoMode, InputType inputType)
	Notifies the input method that the input type attributes of the listener changed.
void	notifyReadOnlyChange (InputMethodListener &listener, bool readOnly)
	Notifies the input method that the input method listener read-only state is changed.
void	notifySelectionChange (InputMethodListener &listener, size_t start, size_t end)
	Notifies the input method about changes in text selection in a listener.
void	notifyTextChange (InputMethodListener &listener, string_view text, size_t position)
	Notifies the input method about the text change in a listener passed as argument.
virtual	~InputMethod ()=default
	Destructor.
bool	disconnectListener ()
	Disconnects the input method from its active input method listener.
void	setText (string_view text)
	Tells the active input method listener to replace its cached text with the content passed in the text argument.
void	insertText (size_t position, string_view text)
	Tells the active input method listener to add a text to its cached text.
void	deleteText (size_t start, size_t end)
	Tells the active input method listener to remove the text between the start and end positions.
void	startTextComposition ()
	Tells the active input method listener to enter text composition state at the current cursor position.
void	updateCompositionText (string_view text)
	Tells the active input method listener to update the composition text.
void	commitCompositionText ()
	Tells the active input method listener to add the composition text received by previous calls of updateCompositionText() into the cached text.
void	cancelTextComposition ()
	Tells the active input method listener to cancel the text composition and discard the composition text.
void	moveCursor (size_t position)
	Tells the active input method listener to update the cursor position.
void	updateSelection (size_t start, size_t end)
	Tells the active input method listener to update the cursor positions at the start and end of the text selection.
void	updateInputType (InputType inputType)
	Tells the active input method listener to update its input type.
void	executeInputMethodAction ()
	Tells the active input method listener to execute the input method action.

Protected Member Functions
void	activate ()
void	connectOverride () override
	To connect the active input method listener, override this method.
void	deactivate ()
void	disconnectOverride () override
	To clear the state of the input method from previously active input method listener, override this method.
void	notifyCompositionEndOverride () override
	To handle the completion or cancellation of the text composition on an active input method listener, override this method.
void	notifyCompositionStartOverride () override
	To handle the start of the text composition on an active input method listener, override this method.
void	notifyCursorMoveOverride (size_t position) override
	To handle the cursor position change in an active input method listener, override this method.
void	notifySelectionChangeOverride (size_t start, size_t end) override
	To handle the changes in text selection in an active input method listener, override this method.
void	notifyTextChangeOverride (string_view text, size_t position) override
	To handle the text change in an active input method listener, override this method.
Protected Member Functions inherited from kanzi::InputMethod
NodeSharedPtr	getAttachedNode () const
	Returns the node to which the input method is attached.
	InputMethod ()=default
	Default constructor.
virtual void	ensureAvailableOverride ()
	To esure the input method is available for the active input method listener, override this method.
virtual bool	notifyInputTypeAttributesChangeOverride (EchoMode echoMode, InputType inputType)
	To handle the change in the input type of the active input method listener, override this method.
virtual void	notifyReadOnlyChangeOverride (bool readOnly)
	To handle the change in the read-only state of the active input method listener, override this method.
virtual void	notifyInputMethodActionChangeOverride (InputMethodAction action)
	Notifies the active input method that the input method action associated with the input method listener changed.

Detailed Description

Since

Kanzi 3.9.0

Constructor & Destructor Documentation

WindowsIme()

kanzi::WindowsIme::WindowsIme

(

Domain *

domain

)

Member Function Documentation

processMessages()

bool kanzi::WindowsIme::processMessages	(	HWND	hwnd,
		UINT	message,
		WPARAM	wparam,
		LPARAM	lparam,
		EventQueue *	queue )

connectOverride()

void kanzi::WindowsIme::connectOverride ( )

overrideprotectedvirtual

To connect the active input method listener, override this method.

See also

connect()

Implements kanzi::InputMethod.

disconnectOverride()

void kanzi::WindowsIme::disconnectOverride ( )

overrideprotectedvirtual

To clear the state of the input method from previously active input method listener, override this method.

Do not call getListener() or getAttachedNode() inside disconnectOverride(). Kanzi can be already destroying the attached node and previously active listener.

See also

disconnect()

Implements kanzi::InputMethod.

notifyTextChangeOverride()

void kanzi::WindowsIme::notifyTextChangeOverride ( string_view text, size_t position )

overrideprotectedvirtual

To handle the text change in an active input method listener, override this method.

Parameters

text	The text in the input method listener to update.
position	The cursor position in the input method listener.

See also

notifyTextChange()

Implements kanzi::InputMethod.

notifyCompositionStartOverride()

void kanzi::WindowsIme::notifyCompositionStartOverride ( )

overrideprotectedvirtual

To handle the start of the text composition on an active input method listener, override this method.

See also

notifyCompositionStart()

Implements kanzi::InputMethod.

notifyCompositionEndOverride()

void kanzi::WindowsIme::notifyCompositionEndOverride ( )

overrideprotectedvirtual

To handle the completion or cancellation of the text composition on an active input method listener, override this method.

See also

notifyCompositionEnd()

Implements kanzi::InputMethod.

notifyCursorMoveOverride()

void kanzi::WindowsIme::notifyCursorMoveOverride ( size_t position )

overrideprotectedvirtual

To handle the cursor position change in an active input method listener, override this method.

Parameters

position

The cursor position in the input method listener.

See also

notifyCursorMove()

Implements kanzi::InputMethod.

notifySelectionChangeOverride()

void kanzi::WindowsIme::notifySelectionChangeOverride ( size_t start, size_t end )

overrideprotectedvirtual

To handle the changes in text selection in an active input method listener, override this method.

If both the start and the end position have the same value, Kanzi clears the selection.

Parameters

start	The position of the start of text selection in the input method listener.
end	The position of the end of text selection in the input method listener.

See also

notifySelectionChange()

Implements kanzi::InputMethod.

activate()

void kanzi::WindowsIme::activate ( )

protected

deactivate()

void kanzi::WindowsIme::deactivate ( )

protected

---

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

• kanzi/core.ui/platform/input/win32/windows_ime.hpp