cocos2d-X 节点(CCIMEDelegate.h)API

本文来自http://blog.csdn.net/runaying ,引用必须注明出处!

cocos2d-X 节点(CCIMEDelegate.h)API

温馨提醒:为了大家能更好学习,强烈推荐大家看看本人的这篇博客 Cocos2d-X权威指南笔记

///cocos2d-x-3.0alpha0/cocos2dx/text_input_node


#ifndef __CC_IME_DELEGATE_H__
#define __CC_IME_DELEGATE_H__

#include "cocoa/CCGeometry.h"

NS_CC_BEGIN

/**
 * @addtogroup input
 * @{
 */

typedef struct
{
    Rect  begin;              // 软键盘的动画开始时的矩形
    Rect  end;                // 软键盘的动画结束时的矩形
    float     duration;           // 软键盘的动画持续时间
} IMEKeyboardNotificationInfo;

/**
@brief    输入法编辑器委托。
*/
class CC_DLL IMEDelegate
{
public:
    /**
     * @js NA
     * @lua NA
     */
    virtual ~IMEDelegate();
    /**
     * @js NA
     * @lua NA
     */
    virtual bool attachWithIME();
    /**
     * @js NA
     * @lua NA
     */
    virtual bool detachWithIME();

protected:
    friend class IMEDispatcher;

    /**
    @brief    决定委托实例是否准备接收IME消息。
   在 IMEDispatcher 里面调用.
    * @js NA
    * @lua NA
    */
    virtual bool canAttachWithIME() { return false; }
    /**
    @brief    当委托从IME分离, 调用 IMEDispatcher 里的这个方法.
    * @js NA
    * @lua NA
    */
    virtual void didAttachWithIME() {}

    /**
    @brief    决定委托实例是否停止接收IME消息.
    * @js NA
    * @lua NA
    */
    virtual bool canDetachWithIME() { return false; }

    /**
    @brief    当委托从IME分离, 调用 IMEDispatcher 里的这个方法.
    * @js NA
    * @lua NA
    */
    virtual void didDetachWithIME() {}

    /**
    @brief    当从 IME 里面接收文本消息时,调用IMEDispatcher 里的这个方法.
    * @js NA
    * @lua NA
    */
    virtual void insertText(const char * text, int len) {CC_UNUSED_PARAM(text);CC_UNUSED_PARAM(len);}

    /**
    @brief    用户点击后退键时,调用IMEDispatcher 里的这个方法.
    * @js NA
    * @lua NA
    */
    virtual void deleteBackward() {}

    /**
    @brief    文本存储委托,在 IMEDispatcher 里面调用
    * @js NA
    * @lua NA
    */
    virtual const char * getContentText() { return 0; }

    //////////////////////////////////////////////////////////////////////////
    // keyboard show/hide notification
    //////////////////////////////////////////////////////////////////////////
    /**
     * @js NA
     * @lua NA
     */
    virtual void keyboardWillShow(IMEKeyboardNotificationInfo& info)   {CC_UNUSED_PARAM(info);}
    /**
     * @js NA
     * @lua NA
     */
    virtual void keyboardDidShow(IMEKeyboardNotificationInfo& info)    {CC_UNUSED_PARAM(info);}
    /**
     * @js NA
     * @lua NA
     */
    virtual void keyboardWillHide(IMEKeyboardNotificationInfo& info)   {CC_UNUSED_PARAM(info);}
    /**
     * @js NA
     * @lua NA
     */
    virtual void keyboardDidHide(IMEKeyboardNotificationInfo& info)    {CC_UNUSED_PARAM(info);}

protected:
    /**
     * @js NA
     * @lua NA
     */
    IMEDelegate();
};

// end of input group
/// @}

NS_CC_END

#endif    // __CC_IME_DELEGATE_H__




你可能感兴趣的:(cocos2d,cocos2dx,cocos2d-x)