IMEManagerInterface Class Reference

#include <IMEManager.h>

Inherits SubsystemInterface.

Inherited by IMEManager.

Public Member Functions
virtual	~IMEManagerInterface ()
virtual void	attach (GameWindow *window)=0
	attach IME to specified window
virtual void	detatch (void)=0
	detatch IME from current window
virtual void	enable (void)=0
	Enable IME.
virtual void	disable (void)=0
	Disable IME.
virtual Bool	isEnabled (void)=0
	Is IME enabled.
virtual Bool	isAttachedTo (GameWindow *window)=0
	Is the manager currently attached to the window.
virtual GameWindow *	getWindow (void)=0
	Returns the window we are currently attached to.
virtual Bool	isComposing (void)=0
	Manager is currently composing new input string.
virtual void	getCompositionString (UnicodeString &string)=0
	Return the current composition string.
virtual Int	getCompositionCursorPosition (void)=0
	Returns the composition cursor position.
virtual Int	getIndexBase (void)=0
	Get index base for candidate list.
virtual Int	getCandidateCount ()=0
	Returns the total number of candidates.
virtual UnicodeString *	getCandidate (Int index)=0
	Returns the candidate string.
virtual Int	getSelectedCandidateIndex ()=0
	Returns the indexed of the currently selected candidate.
virtual Int	getCandidatePageSize ()=0
	Returns the page size for the candidates list.
virtual Int	getCandidatePageStart ()=0
	Returns the index of the first visibel candidate.
virtual Bool	serviceIMEMessage (void *windowsHandle, UnsignedInt message, Int wParam, Int lParam)=0
	Checks for and service IME messages. Returns TRUE if message serviced.
virtual Int	result (void)=0
	result return value of last serviced IME message
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	init ()=0
virtual void	postProcessLoad ()
virtual void	reset ()=0
virtual void	update ()=0
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Definition at line 74 of file IMEManager.h.

Constructor & Destructor Documentation

~IMEManagerInterface()

virtual IMEManagerInterface::~IMEManagerInterface ( )

inlinevirtual

Definition at line 79 of file IMEManager.h.

Member Function Documentation

attach()

virtual void IMEManagerInterface::attach ( GameWindow * window )

pure virtual

attach IME to specified window

Implemented in IMEManager.

detatch()

virtual void IMEManagerInterface::detatch ( void )

pure virtual

detatch IME from current window

Implemented in IMEManager.

disable()

virtual void IMEManagerInterface::disable ( void )

pure virtual

Disable IME.

Implemented in IMEManager.

enable()

virtual void IMEManagerInterface::enable ( void )

pure virtual

Enable IME.

Implemented in IMEManager.

getCandidate()

virtual UnicodeString * IMEManagerInterface::getCandidate ( Int index )

pure virtual

Returns the candidate string.

Implemented in IMEManager.

getCandidateCount()

virtual Int IMEManagerInterface::getCandidateCount ( )

pure virtual

Returns the total number of candidates.

Implemented in IMEManager.

getCandidatePageSize()

virtual Int IMEManagerInterface::getCandidatePageSize ( )

pure virtual

Returns the page size for the candidates list.

Implemented in IMEManager.

getCandidatePageStart()

virtual Int IMEManagerInterface::getCandidatePageStart ( )

pure virtual

Returns the index of the first visibel candidate.

Implemented in IMEManager.

getCompositionCursorPosition()

virtual Int IMEManagerInterface::getCompositionCursorPosition ( void )

pure virtual

Returns the composition cursor position.

Implemented in IMEManager.

getCompositionString()

virtual void IMEManagerInterface::getCompositionString ( UnicodeString & string )

pure virtual

Return the current composition string.

Implemented in IMEManager.

getIndexBase()

virtual Int IMEManagerInterface::getIndexBase ( void )

pure virtual

Get index base for candidate list.

Implemented in IMEManager.

getSelectedCandidateIndex()

virtual Int IMEManagerInterface::getSelectedCandidateIndex ( )

pure virtual

Returns the indexed of the currently selected candidate.

Implemented in IMEManager.

getWindow()

virtual GameWindow * IMEManagerInterface::getWindow ( void )

pure virtual

Returns the window we are currently attached to.

Implemented in IMEManager.

isAttachedTo()

virtual Bool IMEManagerInterface::isAttachedTo ( GameWindow * window )

pure virtual

Is the manager currently attached to the window.

Implemented in IMEManager.

isComposing()

virtual Bool IMEManagerInterface::isComposing ( void )

pure virtual

Manager is currently composing new input string.

Implemented in IMEManager.

isEnabled()

virtual Bool IMEManagerInterface::isEnabled ( void )

pure virtual

Is IME enabled.

Implemented in IMEManager.

result()

virtual Int IMEManagerInterface::result ( void )

pure virtual

result return value of last serviced IME message

Implemented in IMEManager.

serviceIMEMessage()

virtual Bool IMEManagerInterface::serviceIMEMessage ( void * windowsHandle, UnsignedInt message, Int wParam, Int lParam )

pure virtual

Checks for and service IME messages. Returns TRUE if message serviced.

Implemented in IMEManager.

---

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

• Code/GameEngine/Include/GameClient/IMEManager.h