cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
IMEDispatcher Class Reference

Input Method Edit Message Dispatcher. More...

#include <CCIMEDispatcher.h>

Public Member Functions

 ~IMEDispatcher ()
void dispatchInsertText (const char *text, size_t len)
 Dispatches the input text from IME. More...
 
void dispatchDeleteBackward ()
 Dispatches the delete-backward operation. More...
 
const std::string & getContentText ()
 Get the content text from IMEDelegate, retrieved previously from IME. More...
 
void dispatchKeyboardWillShow (IMEKeyboardNotificationInfo &info)
void dispatchKeyboardDidShow (IMEKeyboardNotificationInfo &info)
void dispatchKeyboardWillHide (IMEKeyboardNotificationInfo &info)
void dispatchKeyboardDidHide (IMEKeyboardNotificationInfo &info)

Static Public Member Functions

static IMEDispatchersharedDispatcher ()
 Returns the shared IMEDispatcher object for the system. More...
 

Protected Member Functions

void addDelegate (IMEDelegate *delegate)
 Add delegate to receive IME messages. More...
 
local addDelegate ( local delegate)
 Add delegate to receive IME messages. More...
 
bool attachDelegateWithIME (IMEDelegate *delegate)
 Attach the Delegate to the IME. More...
 
var attachDelegateWithIME ( var delegate)
 Attach the Delegate to the IME. More...
 
local attachDelegateWithIME ( local delegate)
 Attach the Delegate to the IME. More...
 
bool detachDelegateWithIME (IMEDelegate *delegate)
 Dettach the delegate to the IME. More...
 
local detachDelegateWithIME ( local delegate)
 Dettach the delegate to the IME. More...
 
void removeDelegate (IMEDelegate *delegate)
 Remove the delegate from the delegates which receive IME messages. More...
 

Friends

class IMEDelegate

Detailed Description

Input Method Edit Message Dispatcher.

Constructor & Destructor Documentation

Member Function Documentation

void addDelegate ( IMEDelegate delegate)
protected

Add delegate to receive IME messages.

Parameters
delegateA instance implements IMEDelegate delegate.
var addDelegate ( var  delegate)
protected

Add delegate to receive IME messages.

Parameters
delegateA instance implements IMEDelegate delegate.
local addDelegate ( local  delegate)
protected

Add delegate to receive IME messages.

Parameters
delegateA instance implements IMEDelegate delegate.
bool attachDelegateWithIME ( IMEDelegate delegate)
protected

Attach the Delegate to the IME.

Parameters
delegateA instance implements IMEDelegate delegate.
Returns
If the old delegate can detach from the IME, and the new delegate can attach to the IME, return true, otherwise false.
var attachDelegateWithIME ( var  delegate)
protected

Attach the Delegate to the IME.

Parameters
delegateA instance implements IMEDelegate delegate.
Returns
If the old delegate can detach from the IME, and the new delegate can attach to the IME, return true, otherwise false.
local attachDelegateWithIME ( local  delegate)
protected

Attach the Delegate to the IME.

Parameters
delegateA instance implements IMEDelegate delegate.
Returns
If the old delegate can detach from the IME, and the new delegate can attach to the IME, return true, otherwise false.
bool detachDelegateWithIME ( IMEDelegate delegate)
protected

Dettach the delegate to the IME.

See also
attachDelegateWithIME(IMEDelegate*)
Parameters
delegateA instance implements IMEDelegate delegate.
Returns
Whether the IME is detached or not.
var detachDelegateWithIME ( var  delegate)
protected

Dettach the delegate to the IME.

See also
attachDelegateWithIME(IMEDelegate*)
Parameters
delegateA instance implements IMEDelegate delegate.
Returns
Whether the IME is detached or not.
local detachDelegateWithIME ( local  delegate)
protected

Dettach the delegate to the IME.

See also
attachDelegateWithIME(IMEDelegate*)
Parameters
delegateA instance implements IMEDelegate delegate.
Returns
Whether the IME is detached or not.
void dispatchDeleteBackward ( )

Dispatches the delete-backward operation.

void dispatchInsertText ( const char *  text,
size_t  len 
)

Dispatches the input text from IME.

void dispatchKeyboardDidHide ( IMEKeyboardNotificationInfo info)
void dispatchKeyboardDidShow ( IMEKeyboardNotificationInfo info)
void dispatchKeyboardWillHide ( IMEKeyboardNotificationInfo info)
void dispatchKeyboardWillShow ( IMEKeyboardNotificationInfo info)
const std::string& getContentText ( )

Get the content text from IMEDelegate, retrieved previously from IME.

void removeDelegate ( IMEDelegate delegate)
protected

Remove the delegate from the delegates which receive IME messages.

Parameters
delegateA instance implements the IMEDelegate delegate.
var removeDelegate ( var  delegate)
protected

Remove the delegate from the delegates which receive IME messages.

Parameters
delegateA instance implements the IMEDelegate delegate.
local removeDelegate ( local  delegate)
protected

Remove the delegate from the delegates which receive IME messages.

Parameters
delegateA instance implements the IMEDelegate delegate.
static IMEDispatcher*
sharedDispatcher
( )
static

Returns the shared IMEDispatcher object for the system.

Friends And Related Function Documentation

friend class IMEDelegate
friend
var IMEDelegate
friend
local IMEDelegate
friend

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