YiTextEditView.h

Go to the documentation of this file.

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

#include "platform/YiKeyboardInputBridge.h"
#include "utility/YiColor.h"
#include "utility/YiTimer.h"
#include "view/YiSceneView.h"

class CYIAssetTexture;
class CYIKeyEvent;
class CYIPushButtonView;
class CYITextSceneNode;
class CYITimelineLoop;

class CYITextEditView : public CYISceneView, public CYIKeyboardInputBridge::Receiver
{
public:

    CYITextEditView();
    virtual ~CYITextEditView();

    virtual bool Init() override;

    virtual void Clear();

    virtual void SetValue(CYIString text);

    virtual CYIString GetValue() const;

    void SetDefaultText(const CYIString & defaultText);

    const CYIString &GetDefaultText() const;

    void SetDefaultTextColor(const CYIColor &defaultTextColor);

    const CYIColor &GetDefaultTextColor() const;

    void SetTextColor(const CYIColor &textColor);

    const CYIColor &GetTextColor() const;

    void SetCaretColor(const CYIColor &clrCaret);

    const CYIColor &GetCaretColor() const;

    void DeactivateCaret();

    void ActivateCaret();
    
    void SetMaximumCharacterCount(uint32_t uMaximumCharacterCount);

    void Activate();

    void Deactivate();

    bool IsActivated() const;

    uint32_t GetMaximumCharacterCount() const;

    bool SetTextEntryBoxWidth(float fBoxWidth);

    float GetTextEntryBoxWidth() const;

    float GetInitialTextEntryBoxWidth() const;

    virtual bool OnTextEntered(const CYIString &pText, int32_t nCaret) override;

    virtual bool OnTextDeleted(int32_t nBeforeCaret, int32_t nAfterCaret) override;
    virtual void OnTextReplaced(const CYIString &text, int32_t nCursor) override;
    virtual void OnCursorPositionChanged(int32_t nCursor) override;

    virtual bool OnKeyboardHidden() override;
    
    virtual void OnSynchronizeKeyboard(Receiver::Description &receiverDescription) override;
    
    virtual void SetInputType(CYIKeyboardInputBridge::INPUT_TYPE eInputType);

    virtual CYIKeyboardInputBridge::INPUT_TYPE GetInputType() const override;

    virtual bool OnSetComposingText(const CYIString &pText, int32_t nCaret) override;

    virtual bool OnFinishComposingText() override;

    virtual bool OnSetComposingRegion(int32_t nStart, int32_t nEnd) override;
    virtual bool OnTextPasted(const CYIString &pText) override;

    virtual const CYISceneView::AssetRequirement *GetAssetRequirements(uint32_t *pRequirementCount) override;

    virtual bool HandleEvent(const std::shared_ptr<CYIEventDispatcher> &pDispatcher, CYIEvent *pEvent) override;

    CYISignal<const CYIString & /*currentText*/, const CYIString & /*previousText*/> TextChanged;

    CYISignal<CYITextEditView *> Activated;

    CYISignal<CYITextEditView *> Deactivated;

protected:
    virtual void UpdateTextView();
    
    void UpdateTextView(const CYIString &currentText);

    bool OnKeyDownWhenActive(CYIKeyEvent *pEvent);

    bool OnKeyInputWhenActive(CYIKeyEvent *pEvent);

    virtual bool OnCharWhenActive(CYIKeyEvent *pEvent);

    void OnCaretBlink();

    void OnActivated();

    void OnDeactivated();

    void ShowKeyboard();

    void OnTextChanged(bool bNotifyKeyboard);

    void UpdateCaretNodePositionAndTextOffset();

    void ResetCaretBlinkTimer();

    void SetCaretPositionInString(float fLocalSpaceX, float fLocalSpaceY, int8_t nCaretOffset = 0);

    void RemoveComposingText(bool bEmitChangedSignal = true);

    bool HasComposingText();

    void OnClearButtonClicked();

    void UpdateClearButton();

    bool InitInputType();

    bool InitDefaultTextFromProperty();

    float GetTextWidth(uint32_t nPosition);

    void OnScrollTimerEvent();

    void StartScrolling();

    void StopScrolling();

    void DoScrollingForTimerEvent();

    void DoScrollingForMouseEvent();

    virtual void WorldSurfaceScaleUpdated() override;

    virtual void UpdateEnd() override;

    CYITimer                m_CaretTimer;
    CYITimelineLoop         *m_pCaretBlinkTimelineLoop;
    CYISceneNode            *m_pCaretNode;
    CYITextSceneNode        *m_pTextNode;
    CYIPushButtonView       *m_pClearBtn;
    CYITimer                *m_pScrollTimer;
    CYIString               m_CurrentText;
    CYIString               m_PreviousText;
    CYIString               m_DefaultText;
    CYIColor                m_DefaultTextColor;
    CYIColor                m_TextColor;
    CYIColor                m_CaretColor;
    bool                    m_bUpdateText;
    bool                    m_bActivated;
    bool                    m_bCaretActive;
    bool                    m_bPlaceholderTextMode;
    int32_t m_nLengthOfValueString;
    int32_t m_nPosInString;
    uint32_t m_uMaximumCharacterCount;
    int32_t m_nComposingStartPos;
    int32_t m_nComposingEndPos;
    CYIKeyboardInputBridge::INPUT_TYPE m_eInputType;

    glm::vec2               m_vScrollMouseLocationDown;
    glm::vec3               m_vScrollMouseLocalSpaceLocation;

    float m_fCaretMaxX;
    float m_fInitialCaretMaxX;

    std::shared_ptr<CYIAssetTexture> m_DefaultCaretTexture;

private:
    bool HandleEventWhenActive(const std::shared_ptr<CYIEventDispatcher> &pDispatcher, CYIEvent *pEvent);
    bool HandleEventWhenInactive(const std::shared_ptr<CYIEventDispatcher> &pDispatcher, CYIEvent *pEvent);

    bool TabKeyPressed(const CYIKeyEvent *pKeyEvent);

    void DoScrolling(bool bIsMouseEvent);
    void NotifyKeyboardOnTextChange();
    void NotifyKeyboardOnCursorPositionWillChange();
    void NotifyKeyboardOnCursorPositionChanged();

    YI_TYPE_BASES(CYITextEditView, CYISceneView)
    YI_DISALLOW_COPY_AND_ASSIGN(CYITextEditView)
};

#endif // _YI_TEXT_EDIT_VIEW_H_