YiKeyboardInputBridge.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_KEYBOARD_INPUT_BRIDGE_H_
#define _YI_KEYBOARD_INPUT_BRIDGE_H_

#include "framework/YiPredef.h"
#include "signal/YiSignal.h"
#include "utility/YiString.h"

class CYIKeyboardInputBridge
{
public:
    enum INPUT_TYPE
    {
        INPUT_TEXT,
        INPUT_PHONE,
        INPUT_NUMBER,
        INPUT_EMAIL,
        INPUT_URI,
        INPUT_PASSWORD
    };
    
    enum RETURN_KEY_TYPE
    {
        RETURN_KEY_DEFAULT, 
        RETURN_KEY_GO, 
        RETURN_KEY_SEARCH, 
        RETURN_KEY_NEXT, 
        RETURN_KEY_DONE 
    };

    class Receiver
    {
    public:

        struct Description
        {
            Description() : nMaximumCharacterCount(0), nCurrentCursorPosition(0)
            {}

            CYIString defaultText; 
            uint32_t nMaximumCharacterCount; 
            YI_RECT_REL screenRect; 
            int32_t nCurrentCursorPosition; 
        };

        virtual ~Receiver() {}

        virtual bool OnTextEntered(const CYIString &text, int32_t nCursor) = 0;
        virtual bool OnTextDeleted(int32_t nBeforeCursor, int32_t nAfterCursor) = 0;

        virtual void OnTextReplaced(const CYIString &text, int32_t nCursor) = 0;

        virtual void OnCursorPositionChanged(int32_t nCursor) = 0;

        virtual bool OnKeyboardHidden() = 0;

        virtual void OnSynchronizeKeyboard(Description &receiverKeyboardInfo);

        virtual INPUT_TYPE GetInputType() const;
        
        RETURN_KEY_TYPE GetReturnKeyType() const;

        void SetReturnKeyType(RETURN_KEY_TYPE eKeyType);

        /*
            \details Triggered when the return key is pressed. The active Receiver is included as a signal parameter.
         */
        CYISignal<CYIKeyboardInputBridge::Receiver *> ReturnKeyPressed;

        virtual bool OnSetComposingText(const CYIString &text, int32_t nCursor) = 0;
        virtual bool OnFinishComposingText() = 0;
        virtual bool OnSetComposingRegion(int32_t nStart, int32_t nEnd) = 0;

        virtual bool OnTextPasted(const CYIString &text) = 0;

    protected:
        Receiver() : m_keyType(RETURN_KEY_DEFAULT) {}

        RETURN_KEY_TYPE m_keyType;
    };

    CYIKeyboardInputBridge();
    virtual ~CYIKeyboardInputBridge();

    void ResetKeyboard(Receiver *pSource);

    virtual bool ShowKeyboard(Receiver *pSource);

    virtual bool HideKeyboard();

    bool IsKeyboardShowing() const;

    bool IsHardwareKeyboardAvailable() const;

    void OnTextChanged(const CYIString & text, Receiver *pSource);
    void OnCursorPositionChanged(int32_t nCursor, Receiver *pSource);

    void OnCursorPositionWillChange(Receiver *pSource);

    Receiver *GetCurrentReceiver();

    void ShowSelectionMenu(bool bTextSelected, YI_RECT rect);

    void HideSelectionMenu();

    CYISignal<> KeyboardShown;

    CYISignal<> KeyboardHidden;

protected:
    virtual void ResetKeyboardInternal() = 0;
    virtual bool ShowKeyboardInternal(Receiver *pSource) = 0;
    virtual bool HideKeyboardInternal() = 0;
    virtual bool IsKeyboardShowingInternal() const = 0;
    virtual bool IsHardwareKeyboardAvailableInternal() const = 0;
    virtual void OnCursorPositionWillChangeInternal() = 0;
    virtual void OnCursorPositionChangedInternal(int32_t nStart, int32_t nEnd) = 0;
    virtual void OnTextChangedInternal(const CYIString &rText) = 0;
    virtual void ShowSelectionMenuInternal(bool bTextSelected, YI_RECT rect) = 0;
    virtual void HideSelectionMenuInternal() = 0;
    virtual void OnKeyboardShown();
    virtual void OnKeyboardHidden();

private:
    Receiver *m_pCurrentReceiver;
};

inline CYIKeyboardInputBridge::INPUT_TYPE CYIKeyboardInputBridge::Receiver::GetInputType() const
{
    return INPUT_TEXT;
}

inline CYIKeyboardInputBridge::RETURN_KEY_TYPE CYIKeyboardInputBridge::Receiver::GetReturnKeyType() const
{
    return m_keyType;
}

inline void CYIKeyboardInputBridge::Receiver::SetReturnKeyType(CYIKeyboardInputBridge::RETURN_KEY_TYPE keyType)
{
    m_keyType = keyType;
}

inline bool CYIKeyboardInputBridge::Receiver::OnSetComposingText(const CYIString &pText, int32_t nCursor)
{
    YI_UNUSED(pText);
    YI_UNUSED(nCursor);

    return false;
}

inline bool CYIKeyboardInputBridge::Receiver::OnFinishComposingText()
{
    return false;
}

inline bool CYIKeyboardInputBridge::Receiver::OnSetComposingRegion(int32_t nStart, int32_t nEnd)
{
    YI_UNUSED(nStart);
    YI_UNUSED(nEnd);

    return false;
}


#endif /* _YI_KEYBOARD_INPUT_METHOD_H_ */