axmol/cocos2dx/keypad_dispatcher/CCKeypadDelegate.h

/****************************************************************************
Copyright (c) 2010 cocos2d-x.org

http://www.cocos2d-x.org

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
****************************************************************************/

#ifndef __CCKEYPAD_DELEGATE_H__
#define __CCKEYPAD_DELEGATE_H__


#include "cocoa/CCObject.h"

NS_CC_BEGIN

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

class CC_DLL KeypadDelegate
{
public:
    /** The back key clicked
    * @js NA
    * @lua NA
    */
    
    virtual void keyBackClicked() {}

    /** The menu key clicked. only available on wophone & android
    * @js NA
    * @lua NA
    */
    virtual void keyMenuClicked() {};
};

/**
@brief
KeypadHandler
Object than contains the KeypadDelegate.
*/
class CC_DLL KeypadHandler : public Object
{
public:
    /**
     * @js NA
     * @lua NA
     */
    virtual ~KeypadHandler(void);

    /** delegate
     * @js NA
     * @lua NA
     */
    KeypadDelegate* getDelegate();
    /**
     * @js NA
     * @lua NA
     */
    void setDelegate(KeypadDelegate *pDelegate);

    /** initializes a KeypadHandler with a delegate 
     * @js NA
     * @lua NA
     */
    virtual bool initWithDelegate(KeypadDelegate *pDelegate);

public:
    /** allocates a KeypadHandler with a delegate 
     * @js NA
     * @lua NA
     */
    static KeypadHandler* handlerWithDelegate(KeypadDelegate *pDelegate);

protected:
    KeypadDelegate* _delegate;
};

// end of input group
/// @} 

NS_CC_END

#endif // __CCKEYPAD_DELEGATE_H__