You.i Engine
CYITextEditView Class Reference

Detailed Description

Displays text to the user and allows them to edit it.

This view will display editable text as well as a blinking caret. The caret is a vertical line which indicates the current editing position.

A CYITextEditView can receive focus but must be activated in order to receive inputs. The CYITextEditView is activated by selecting it once it has focus. When CYITextEditView is clicked, it receives focus and is activated.

The clear button cannot be interacted with using focus navigation.

View Template Specification

Type Labels Property Description
Marker Blink Optional An optional timeline that will be looped while the text edit is active. If not provided, the caret will blink on and off using a timer. The visibility track must not be used to animate the blink, as the caret is shown and hidden in normal operation of the view.
Node Text Required Layer name for the text field. It must be a text layer which uses point type and left justified.
Node InputProperties Required Solid Color to mark the end of the text edit field, and also to set the color of the text that will be typed by the user. Please note that the InputProperties's parent field needs to be set to the Text layer in After Effects.
Node Caret Optional Layer name for the caret. If no 'Caret' layer exists, a default black and rectangular caret will be created. Change the color of the caret using the caret-color comment or the SetCaretColor function. The caret's anchor point will be positioned at the baseline of the text. Note that this layer must not be layer-parented to another layer.
Node Clear Optional Layer name for the button that clears the text field. Layer must be a CYIPushButtonView. This button will be made non-focusable at initialization time, even if it contains focus timelines.
Comment default-text Optional Corresponds to: SetDefaultText. Contains a quoted string.
Comment input-type Optional Corresponds to: GetInputType. Default: text, Possible Values: text, phone, number, email, uri, password. Can be set on the composition & the layer.
Comment caret-color Optional Corresponds to: SetCaretColor. Colors the caret with a provided string in hexadecimal #RRGGBB or #RRGGBBAA format.

Notes:

  • "Text" must be point type and left justified
  • "InputProperties" must be parented under "Text".
  • Comment properties may be set at the composition level or the layer level.

#include <view/YiTextEditView.h>

Inheritance diagram for CYITextEditView:

Public Member Functions

 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 CYIStringGetDefaultText () const
 
void SetDefaultTextColor (const CYIColor &defaultTextColor)
 
const CYIColorGetDefaultTextColor () const
 
void SetTextColor (const CYIColor &textColor)
 
const CYIColorGetTextColor () const
 
void SetCaretColor (const CYIColor &clrCaret)
 
const CYIColorGetCaretColor () 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::AssetRequirementGetAssetRequirements (uint32_t *pRequirementCount) override
 
virtual bool HandleEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override
 
- Public Member Functions inherited from CYISceneView
 CYISceneView ()
 
virtual ~CYISceneView ()
 
bool BuildFromTemplate (CYISceneManager *pSceneManager, const std::shared_ptr< CYIAssetViewTemplate > &pAssetViewTemplate, CYISceneManager::MISSING_CLASS_HANDLING_MODE eMissingHandlingMode=CYISceneManager::ABORT)
 
bool IsInitialized () const
 
void SetClippingAreaNode (CYISceneNode *pClippingNode)
 
virtual bool GetProperty (const CYIString &propertyName, CYIString *pValue) const override
 
void EnableDefaultHitZone ()
 
bool IsResponsiveLayoutEnabled () const
 
void EnableResponsiveLayout ()
 
void DisableResponsiveLayout ()
 
void AddAnchor (YI_ANCHOR_TYPE anchorType)
 
YI_ANCHOR_DATA GetAnchor (YI_ANCHOR_TYPE anchorType) const
 
CYIAbstractTimelineGetInTimeline () const
 
CYIAbstractTimelineGetOutTimeline () const
 
CYIAbstractTimelineGetFocusInTimeline () const
 
CYIAbstractTimelineGetFocusOutTimeline () const
 
virtual bool HandlesFocusInDescendants () const
 
virtual bool RequestFocus (CYIFocus::FOCUS_DIRECTION eDirection=CYIFocus::FOCUS_FORWARD, CYIFocus::FOCUS_ROOT_RULE eFocusRootRule=CYIFocus::FOCUS_ROOT_DESCENDANTS_UPDATE_CONTEXT, const CYIAABB &previousFocusRect=CYIAABB(), const CYIFocusSearchOptions &options=CYIFocusSearchOptions())
 
bool HasFocus () const
 
void SetFocusable (bool bFocusable)
 
bool IsFocusable () const
 
bool CanBeFocused () const
 
void SetNextFocus (CYISceneView *pView, CYIFocus::FOCUS_DIRECTION eDirection)
 
CYISceneViewGetNextFocus (CYIFocus::FOCUS_DIRECTION eDirection) const
 
void SetInitiallyFocusedView (CYISceneView *pView)
 
CYISceneViewGetInitiallyFocusedView () const
 
CYISceneViewFindNextFocus (CYIFocus::FOCUS_DIRECTION eDirection, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
 
CYISceneViewFindNextFocus (CYIFocus::FOCUS_DIRECTION eDirection, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
 
virtual CYISceneViewFindNextFocusInDescendants (const CYISceneView *pCurrentFocusView, CYIFocus::FOCUS_DIRECTION eDirection, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
 
const CYISceneNodeGetFocusRoot () const
 
CYISceneViewGetFocusHandler () const
 
virtual void OnFocusGained ()
 
virtual void FocusGained ()
 
virtual void OnFocusLost ()
 
virtual void FocusLost ()
 
const std::shared_ptr< CYIAssetViewTemplate > & GetViewTemplate () const
 
const std::vector< CYIString > & GetChildTemplateNames ()
 
virtual CYIAbstractTimelineGetTimeline (const CYIString &rMarkerName, TIMELINE_GET_MODE eMode=GET_DEFAULT)
 
CYIAbstractTimelineGetTimeline (CYIMarkerData::MARKER_ID eID, TIMELINE_GET_MODE eMode=GET_DEFAULT)
 
std::map< CYIString, CYITimeline * > GetTimelines () const
 
bool FindTimeline (CYIAbstractTimeline *&pTimeline, const CYIString &markerName, FETCH_TYPE eType, const CYIString &tag="", TIMELINE_GET_MODE eMode=GET_DEFAULT)
 
CYITimelineGroupGetTimelineGroup (const CYIString &markerName)
 
std::unique_ptr< CYITimelineGroupBuildTimelineGroup (const CYIString &markerName)
 
void BuildAnchorList ()
 
virtual void Reset ()
 
void SetLayout (std::unique_ptr< CYILayout > pLayout)
 
const CYILayoutGetLayout () const
 
CYILayoutGetLayout ()
 
virtual void Measure (const MeasureSpec &widthSpec, const MeasureSpec &heightSpec, const MeasureSpec &depthSpec) override
 
virtual void ApplyMeasurements () override
 
virtual void BuildDrawList (std::vector< IYIRenderer::Command > &children, CYIAbstractCameraSceneNode *pCameraToDrawWith=nullptr) override
 
- Public Member Functions inherited from CYISceneNode
 CYISceneNode ()
 
virtual ~CYISceneNode ()
 
void ForceDirty ()
 
void ClearDirtyFlag ()
 
void SetDirtyFlag (DirtyFlag eDirtyFlag)
 
DirtyFlag GetDirtyFlag () const
 
DirtyFlag GetPreviousDirtyFlag () const
 
const CYIStringGetName () const
 
CYIString GetUniqueName () const
 
void SetSceneManager (CYISceneManager *pSceneManager)
 
void SetName (const CYIString &name)
 
int32_t GetID () const
 
void SetID (int32_t nID)
 
uint64_t GetUniqueID () const
 
bool AddChild (std::unique_ptr< CYISceneNode > pSceneNode)
 
bool AddChild (std::unique_ptr< CYISceneNode >, int32_t nIndex)
 
bool InsertChildAfter (CYISceneNode *pRefNode, std::unique_ptr< CYISceneNode > pSceneNode)
 
std::unique_ptr< CYISceneNodeRemoveChild (CYISceneNode *pSceneNode)
 
bool ReorderChild (uint32_t uFromIndex, uint32_t uToIndex)
 
CYISceneNodeGetParent () const
 
bool ChangeParent (CYISceneNode *pParent)
 
CYISceneNodeGetDrawParent () const
 
bool IsAncestorOf (const CYISceneNode *pNode) const
 
CYISceneManagerGetSceneManager () const
 
uint32_t GetChildCount () const
 
uint32_t GetChildCountRecursive () const
 
CYISceneNodeGetChild (uint32_t nIndex) const
 
Iterator begin (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
Iterator end (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
ReverseIterator rbegin (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
ReverseIterator rend (Iterator::ITERATION_MODE eMode=Iterator::IMMEDIATE_CHILDREN) const
 
CYISceneNodeGetChild (const CYIString &sName) const
 
uint32_t GetDrawChildCount () const
 
CYISceneNodeGetDrawChild (uint32_t uIndex) const
 
CYISceneNodeGetDrawChildByID (int32_t nID) const
 
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetChild (uint32_t uTargetMatchedNodeCount=1) const
 
template<class YI_SCENE_NODE_SUBCLASS >
std::list< YI_SCENE_NODE_SUBCLASS * > GetChildren () const
 
int32_t GetIndexOfChild (const CYISceneNode *pSceneNode) const
 
void Show ()
 
void Hide ()
 
void SetVisibility (bool bVisible)
 
void SetOpacity (float fOpacity)
 
float GetCompositeOpacity () const
 
float GetLocalOpacity () const
 
bool IsVisible () const
 
bool IsTrulyVisible () const
 
CYISceneNodeGetNode (const CYIString &name)
 
CYISceneNodeGetNode (const CYIString &name, const CYIRuntimeTypeInfo &enforceClassType)
 
CYISceneNodeGetNode (const CYIRuntimeTypeInfo &enforceClassType)
 
CYISceneNodeGetNodeAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, CYISceneNode *pStartAfterTarget)
 
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetNode (const CYIString &name)
 
CYISceneNodeGetNode (const int32_t nID)
 
CYISceneNodeGetNode (const int32_t nID, const CYIRuntimeTypeInfo &enforceClassType)
 
template<class YI_SCENE_NODE_SUBCLASS >
bool FindNode (YI_SCENE_NODE_SUBCLASS *&pNode, const CYIString &nodeName, FETCH_TYPE eType, const CYIString &tag)
 
std::list< CYISceneNode * > GetNodes (const CYIString &name)
 
std::list< CYISceneNode * > GetNodes (int32_t nID)
 
std::list< CYISceneNode * > GetNodes (const CYIRuntimeTypeInfo &enforceClassType)
 
template<class YI_SCENE_NODE_SUBCLASS >
const YI_SCENE_NODE_SUBCLASS * GetNode (uint32_t uTargetMatchedNodeCount=1) const
 
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetNode (uint32_t uTargetMatchedNodeCount=1)
 
void SetMesh (const std::shared_ptr< CYIMesh > &pMesh)
 
void SetMaterial (const std::shared_ptr< CYIMaterial > &pMaterial, uint32_t nIndex=0)
 
void AddEffect (const std::shared_ptr< CYIEffect > &pEffect)
 
void RemoveEffect (const std::shared_ptr< CYIEffect > &pEffect)
 
uint32_t GetEffectCount () const
 
std::shared_ptr< CYIEffectGetEffect (uint32_t uIndex) const
 
void ConnectEffectsToTimelines (const CYITimelineTrack *pTrack)
 
void AddMask (std::unique_ptr< CYIMask > pMask)
 
std::unique_ptr< CYIMaskRemoveMask (const CYIMask *pMask)
 
uint32_t GetMaskCount () const
 
const CYIMaskGetMask (uint32_t uIndex) const
 
CYIMaskGetMask (uint32_t uIndex)
 
const std::shared_ptr< CYIMesh > & GetMesh () const
 
uint32_t GetMaterialCount () const
 
const std::shared_ptr< CYIMaterialGetMaterial (uint32_t nIndex=0) const
 
const std::shared_ptr< IYIUniformBufferObject > & GetShaderUniforms () const
 
void SetMeshTransform (const glm::mat4 &rTransform)
 
void DestroyChildren ()
 
const glm::mat4 & GetLocalTransform () const
 
const glm::mat4 & GetEffectTransform () const
 
const glm::mat4 & GetWorldTransform () const
 
bool Intersects (const CYISceneNode *pNode) const
 
void SetRenderTarget (const std::shared_ptr< CYIRenderTarget > &pRenderTarget)
 
const std::shared_ptr< CYIRenderTargetGetRenderTarget () const
 
const CYIAABBGetWorldAABB () const
 
const CYIAABBGetLocalAABB () const
 
void SetAnchorPoint (const glm::vec3 &ref)
 
void SetAnchorPoint (float fX, float fY, float fZ)
 
void SetAnchorPointX (float fX)
 
void SetAnchorPointY (float fY)
 
void SetAnchorPointZ (float fZ)
 
void SetPosition (const glm::vec3 &ref)
 
void SetPosition (float fX, float fY, float fZ)
 
void SetPositionX (float fX)
 
void SetPositionY (float fY)
 
void SetPositionZ (float fZ)
 
void SetRotation (const glm::vec3 &fEulerDegrees)
 
void SetRotation (float fPitchDegrees, float fYawDegrees, float fRollDegrees)
 
void SetRotationX (float fPitchDegrees)
 
void SetRotationY (float fYawDegrees)
 
void SetRotationZ (float fRollDegrees)
 
void SetOrientation (float fPitchDegrees, float fYawDegrees, float fRollDegrees)
 
void SetOrientation (const glm::quat &orient)
 
void SetScale (const glm::vec3 &fScaleFactors)
 
void SetScale (float fFactorX, float fFactorY, float fFactorZ)
 
void SetScaleX (float fFactor)
 
void SetScaleY (float fFactor)
 
void SetScaleZ (float fFactor)
 
const glm::vec3 & GetPosition () const
 
const glm::vec3 & GetScale () const
 
const glm::vec3 & GetWorldScale () const
 
const glm::vec3 & GetWorldSurfaceScale () const
 
const glm::vec3 & GetRotation () const
 
const glm::quat & GetOrientation () const
 
const glm::vec3 & GetAnchorPoint () const
 
virtual void SetSize (const glm::vec3 &vSize, bool bDirtyLayout=true)
 
const glm::vec3 & GetSize () const
 
const glm::vec3 & GetInitialSize () const
 
void SetMeasuredSize (const glm::vec3 &vMeasuredSize)
 
const glm::vec3 & GetMeasuredSize () const
 
void SetInternalCustomTimelineValue (uint32_t nTrackID, const CYIVariant &value)
 
virtual void SetCustomTimelineValue (uint32_t nTrackID, const CYIVariant &value)
 
void SetClippingOn ()
 
void SetClippingOff ()
 
bool GetClipping () const
 
void SetClippingBox (const CYIAABB &rWorldBox)
 
const CYIAABBGetClippingBox () const
 
void StartPropertyAnimation (YI_NODE_PROPERTY_TYPE ePropType, float fFrom, float fTo, uint32_t nDurMs, CYITimeInterpolator *pTimeInterpolator=nullptr, bool bDirtyLayout=true)
 
void StopPropertyAnimation (YI_NODE_PROPERTY_TYPE ePropType)
 
void UpdateLocalSpaceCollision (CYIActionEvent *pActionEvent)
 
virtual bool BroadcastEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent)
 
void UpdateEventForLocalSpace (CYIActionEvent *pActionEvent, glm::vec3 &rayOrigin, glm::vec3 &rayNonOriginPoint) const
 
bool IsBoundingBoxHit (const CYIRay &rWorldSpaceRay) const
 
bool IsMeshHit (const CYIRay &rWorldSpaceRay) const
 
void DumpTree () const
 
void StartCaptureKeyboardEvents ()
 
void StopCaptureKeyboardEvents ()
 
void StartCaptureTrackpadEvents ()
 
void StopCaptureTrackpadEvents ()
 
void StartCapturePointerEvents (uint8_t uPointerID)
 
void StopCapturePointerEvents (uint8_t uPointerID)
 
bool DrawBehindChildren (CYISceneNode *pSceneNode)
 
bool DrawInFrontOfChildren (CYISceneNode *pSceneNode)
 
bool DrawBehind (CYISceneNode *pSceneNode)
 
bool DrawInFront (CYISceneNode *pSceneNode)
 
bool IsFocusRoot () const
 
void SetIsFocusRoot (bool bIsFocusRoot)
 
virtual void OnFocusGainedInDescendants ()
 
virtual void FocusGainedInDescendants ()
 
virtual void OnFocusLostInDescendants ()
 
virtual void FocusLostInDescendants ()
 
virtual void OnFocusChangedInDescendants ()
 
virtual void FocusChangedInDescendants ()
 
virtual bool ContainsFocusableDescendant (const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
 
void ShowPointerDebugNode (CYIActionEvent *pActionEvent)
 
void SetUseLocalTransformAndAlpha (bool bUse)
 
virtual const std::map< CYIString, CYIString > & GetProperties () const override
 
void SetProperty (const CYIString &rPropertyName, const CYIString &rPropertyValue)
 
const std::shared_ptr< CYISceneNodeProxy > & GetSceneNodeProxy () const
 
void SetLayoutConfig (std::unique_ptr< CYILayoutConfig > pLayoutConfig)
 
const CYILayoutConfigGetLayoutConfig (LayoutConfigFetchMode eFetchMode=LAYOUT_CONFIG_LAZY_INSTANTIATE) const
 
CYILayoutConfigGetLayoutConfig (LayoutConfigFetchMode eFetchMode=LAYOUT_CONFIG_LAZY_INSTANTIATE)
 
void SetLayoutState (std::unique_ptr< CYILayoutState > pLayoutState)
 
const CYILayoutStateGetLayoutState () const
 
CYILayoutStateGetLayoutState ()
 
void RequestLayout ()
 
LayoutDirtyFlag GetLayoutDirtyFlag () const
 
virtual void SetLayoutDirtyFlag (LayoutDirtyFlag eFlag)
 
CYIAbstractCameraSceneNodeFindActiveCamera () const
 
template<typename T >
bool CanCastTo () const
 
- Public Member Functions inherited from CYIEventTarget
 CYIEventTarget ()
 
virtual ~CYIEventTarget ()
 
bool AddEventListener (YI_EVENT_TYPE eEventType, CYIEventHandler *pListener, EVENT_PHASE ePhase=BUBBLE)
 
bool RemoveEventListener (YI_EVENT_TYPE eEventType, CYIEventHandler *pListener, EVENT_PHASE ePhase=BUBBLE)
 
void SetSpecialTypeFlag (YI_SPECIAL_EVENT_TARGET_TYPE eType)
 
void ClearSpecialTypeFlag (YI_SPECIAL_EVENT_TARGET_TYPE eType)
 
YI_SPECIAL_EVENT_TARGET_TYPE GetSpecialTypes () const
 
- Public Member Functions inherited from CYIScriptableRTTIObject
 CYIScriptableRTTIObject ()
 
virtual ~CYIScriptableRTTIObject ()
 
virtual const CYIRuntimeTypeInfoGetRuntimeTypeInfoForScriptObject () const override
 
- Public Member Functions inherited from CYIScriptableObject
 CYIScriptableObject ()
 
 CYIScriptableObject (const CYIScriptableObject &other)
 
CYIScriptableObjectoperator= (const CYIScriptableObject &other)
 
virtual ~CYIScriptableObject ()
 
CYIBindingImplementationGetBindingImplementation () const
 
void SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
 
- Public Member Functions inherited from CYISignalHandler
 CYISignalHandler ()
 
 CYISignalHandler (const CYISignalHandler &rSignalHandler)
 
virtual ~CYISignalHandler ()
 
CYISignalHandleroperator= (const CYISignalHandler &rSignalHandler)
 
void MoveToThread (CYIThread *pThread)
 This function allows the user to override the default thread affinity to any CYIThread that may or may not be running. More...
 
CYIThreadHandle GetThreadAffinity () const
 
void SetThreadAffinity (const CYIThreadHandle &rThreadAffinity)
 
virtual bool IsConnected () const
 
virtual bool IsConnected (const CYISignalBase &rSignal) const
 
void Disconnect (CYISignalBase &rSignal)
 
void DisconnectFromAllSignals ()
 
- Public Member Functions inherited from CYIThread::Listener
 Listener ()
 
virtual ~Listener ()
 
virtual void OnThreadStarted (CYIThread *)
 
virtual void OnThreadTerminated (CYIThread *)
 
virtual void OnThreadFinished (CYIThread *)
 
- Public Member Functions inherited from IYIPropertiesSource
virtual ~IYIPropertiesSource ()
 
- Public Member Functions inherited from CYIEventHandler
 CYIEventHandler ()
 
 CYIEventHandler (const CYIEventHandler &)
 
virtual ~CYIEventHandler ()
 
CYIEventHandleroperator= (const CYIEventHandler &)
 
bool RegisterEventFilter (CYIEventFilter *pFilter)
 
bool UnregisterEventFilter (CYIEventFilter *pFilter)
 
bool PreFilter (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent)
 
bool PostFilter (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent)
 
bool AreEventsEnabled () const
 
void EnableEvents (bool bEnable)
 
- Public Member Functions inherited from CYIKeyboardInputBridge::Receiver
virtual ~Receiver ()
 
virtual void OnSynchronizeKeyboard (Description &receiverKeyboardInfo)
 
RETURN_KEY_TYPE GetReturnKeyType () const
 
void SetReturnKeyType (RETURN_KEY_TYPE eKeyType)
 

Public Attributes

CYISignal< const CYIString &, const CYIString & > TextChanged
 
CYISignal< CYITextEditView * > Activated
 
CYISignal< CYITextEditView * > Deactivated
 
- Public Attributes inherited from CYISceneView
CYISignal< CYISceneView * > GainedFocus
 Emitted when focus has entered this view. More...
 
CYISignal< CYISceneView * > LostFocus
 Emitted when focus has left this view. More...
 
- Public Attributes inherited from CYISceneNode
CYISignal< CYISceneNode *, YI_NODE_PROPERTY_TYPEPropertyAnimationComplete
 
CYISignal DescendantGainedFocus
 Emitted when focus has entered this tree. More...
 
CYISignal DescendantLostFocus
 Emitted when focus has left this tree. More...
 
CYISignal DescendantsChangedFocus
 Emitted when focus has changed within this tree. More...
 
- Public Attributes inherited from CYIKeyboardInputBridge::Receiver
CYISignal< CYIKeyboardInputBridge::Receiver * > ReturnKeyPressed
 

Protected Member Functions

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
 
- Protected Member Functions inherited from CYISceneView
void UpdateClipping ()
 
virtual void WorldScaleUpdated () override
 
virtual void WorldBoundingBoxUpdated () override
 
virtual void OnViewReflowed (const glm::vec3 &worldScale)
 
virtual void ViewReflowed (const glm::vec3 &worldScale)
 
virtual bool ProcessEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override
 
void UpdateResponsiveLayoutAnchors ()
 
virtual void SizeChanged () override
 
virtual void ChildNeedsLayout () override
 
virtual void LayoutDirtied () override
 
virtual void ChildAdded (CYISceneNode *pChild) override
 
virtual void ChildRemoved (CYISceneNode *pChild) override
 
virtual void ChildVisibilityChanged (CYISceneNode *pChild) override
 
void OnViewIsInAnimatedPosition ()
 
void OnViewIsGoingOutOfAnimatedPosition ()
 
void SetInTimeline (CYIAbstractTimeline *pTimeline)
 
void SetOutTimeline (CYIAbstractTimeline *pTimeline)
 
virtual void OnInit ()
 
bool TryRequestFocusOnInitiallyFocusedView ()
 
- Protected Member Functions inherited from CYISceneNode
void Update (bool bForceDirty=false)
 
virtual void OnUpdateBegin ()
 
virtual void UpdateBegin ()
 
virtual void OnUpdateEnd ()
 
virtual void OnDirtyFlagChanged ()
 
virtual void DirtyFlagChanged ()
 
virtual void OnTransformUpdated ()
 
virtual void TransformUpdated ()
 
virtual void OnWorldScaleUpdated ()
 
virtual void OnWorldSurfaceScaleUpdated ()
 
virtual void OnVisibilityUpdated ()
 
virtual void VisibilityUpdated ()
 
virtual void OnCompositeOpacityUpdated ()
 
virtual void CompositeOpacityUpdated ()
 
virtual void OnWorldBoundingBoxUpdated ()
 
virtual void OnLocalBoundingBoxUpdated ()
 
virtual void LocalBoundingBoxUpdated ()
 
virtual void OnChildAdded (CYISceneNode *pChild)
 
virtual void OnChildRemoved (CYISceneNode *pChild)
 
virtual void OnSizeChanged ()
 
virtual void CalculateLocalTransform (glm::mat4 *pTransform) const
 
virtual void OnChildVisibilityChanged (CYISceneNode *pChild)
 
LayoutDirtyFlag GetCurrentLayoutDirtyFlag () const
 
virtual CYIString GetDumpTreeString () const
 
void DumpTree (int32_t nIndentLevel) const
 
void SetShaderUniforms ()
 
virtual void SetCustomUniforms ()
 
template<class T >
void SetNodeType ()
 
virtual CYISceneNodeGetNodeFromChildren (const CYIString &name)
 
virtual CYISceneNodeGetNodeFromChildren (const int32_t nID)
 
virtual CYISceneNodeGetNodeFromChildren (const CYIRuntimeTypeInfo &enforceClassType)
 
CYISceneNodeGetNodeFromChildrenAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, bool *pbTargetReached, CYISceneNode *pStartAfterTarget)
 
- Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * > GetRuntimeTypeInfoWithObject () const =0
 
- Protected Member Functions inherited from CYIKeyboardInputBridge::Receiver
 Receiver ()
 

Protected Attributes

CYITimer m_CaretTimer
 
CYITimelineLoopm_pCaretBlinkTimelineLoop
 
CYISceneNodem_pCaretNode
 
CYITextSceneNodem_pTextNode
 
CYIPushButtonViewm_pClearBtn
 
CYITimerm_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< CYIAssetTexturem_DefaultCaretTexture
 
- Protected Attributes inherited from CYISceneView
bool m_bStopEventPropagation
 
bool m_bResponsiveLayoutEnabled
 
bool m_bSceneTreeBuilt
 
bool m_bInAnimatedPosition
 
CYISceneNodem_pClippingNode
 
CYIAbstractTimelinem_pFocusInTimeline
 
CYIAbstractTimelinem_pFocusOutTimeline
 
std::unique_ptr< CYILayoutm_pLayout
 
std::shared_ptr< CYIAssetViewTemplatem_pAssetViewTemplate
 
std::shared_ptr< CYISceneNodeProxym_pInitiallyFocusedView
 
std::multimap< YI_ANCHOR_TYPE, YI_ANCHOR_DATAm_anchors
 
std::map< CYIString, std::unique_ptr< CYITimeline > > m_timelines
 
std::map< CYIString, std::unique_ptr< CYIParallelTimelineGroup > > m_timelineGroups
 
- Protected Attributes inherited from CYISceneNode
CYIString m_name
 
CYISceneNodem_pParent
 
CYISceneNodem_pDrawParent
 
CYISceneManagerm_pSceneManager
 
std::vector< std::unique_ptr< CYISceneNode > > m_children
 
std::vector< CYISceneNode * > m_drawChildren
 
std::map< CYIString, CYIStringm_Properties
 
std::vector< std::shared_ptr< CYIMaterial > > m_pMaterials
 
std::vector< std::unique_ptr< CYIMask > > m_Masks
 
std::vector< std::shared_ptr< CYIEffect > > m_Effects
 
std::vector< PropertyAnimation * > m_propertyAnimations
 
float m_fLocalOpacity
 
CYIAABB m_WSClipBox
 
glm::mat4 m_EffectTransform
 
glm::quat m_Orientation
 
glm::vec3 m_Rotate
 
glm::vec3 m_AnchorPoint
 
glm::vec3 m_Position
 
glm::vec3 m_Scale
 
glm::vec3 m_vSize
 
glm::vec3 m_vInitialSize
 
glm::vec3 m_vMeasuredSize
 
glm::vec3 m_vlsLastCollision
 
bool m_bClip
 
bool m_bIsRotated
 
bool m_bIsOriented
 
bool m_bLocalVisibility
 
int32_t m_nID
 
uint64_t m_uGUID
 
std::shared_ptr< CYIRenderTargetm_pRenderTarget
 
std::shared_ptr< CYIMeshm_pMesh
 
std::shared_ptr< IYIUniformBufferObjectm_pShaderUniforms
 
- Protected Attributes inherited from CYIEventTarget
YI_SPECIAL_EVENT_TARGET_TYPE m_eSpecialTypes
 
std::vector< EventListenerEntry > m_listeners
 
- Protected Attributes inherited from CYIEventHandler
bool m_bEnableEvents
 
- Protected Attributes inherited from CYIKeyboardInputBridge::Receiver
RETURN_KEY_TYPE m_keyType
 

Additional Inherited Members

- Public Types inherited from CYISceneView
enum  ASSET_REQUIREMENT_TYPE {
  REQUIRES_NODE,
  REQUIRES_TIMELINE
}
 
enum  TIMELINE_GET_MODE {
  GET_DEFAULT,
  GET_TIMELINE,
  GET_TIMELINE_GROUP,
  GET_COMPONENT_OF_TIMELINE_GROUP
}
 
- Public Types inherited from CYISceneNode
enum  DirtyFlag {
  DirtyClean = 0x0000,
  DirtySceneGraph = 0x0001,
  DirtyVisibility = 0x0002,
  DirtyOpacity = 0x0004,
  DirtyLocalTransform = 0x0008,
  DirtyWorldTransform = 0x0010,
  DirtyUniform = 0x0020,
  DirtyWorldBoundingBox = 0x0040,
  DirtyMesh = 0x0080,
  DirtyWorldSurfaceScale = 0x0100,
  DirtyWorldScale = 0x0200,
  DirtyLocalBoundingBox = 0x0400,
  DirtyEverything = (DirtySceneGraph | DirtyVisibility | DirtyOpacity | DirtyLocalTransform | DirtyWorldTransform | DirtyUniform | DirtyWorldBoundingBox | DirtyWorldSurfaceScale | DirtyWorldScale | DirtyLocalBoundingBox)
}
 
enum  LayoutDirtyFlag {
  LayoutClean,
  LayoutChildDirty,
  LayoutDirty
}
 
enum  LayoutConfigFetchMode {
  LAYOUT_CONFIG_DO_NOT_LAZY_INSTANTIATE = 0,
  LAYOUT_CONFIG_LAZY_INSTANTIATE
}
 
enum  MeasureMode {
  MEASURE_UNSPECIFIED,
  MEASURE_UP_TO,
  MEASURE_EXACTLY
}
 
enum  FETCH_TYPE {
  FETCH_OPTIONAL = 0,
  FETCH_MANDATORY
}
 
typedef std::reverse_iterator< IteratorReverseIterator
 
- Public Types inherited from CYIEventTarget
enum  EVENT_PHASE {
  BUBBLE,
  CAPTURE
}
 
- Static Public Member Functions inherited from CYISceneView
static void RegisterAllViews ()
 
- Static Public Member Functions inherited from CYISceneNode
static void RegisterAllSceneNodes ()
 
- Static Public Attributes inherited from CYISceneNode
static const float OPACITY_NOT_VISIBLE_EPSILON
 

Constructor & Destructor Documentation

CYITextEditView::CYITextEditView ( )
virtual CYITextEditView::~CYITextEditView ( )
virtual

Member Function Documentation

void CYITextEditView::Activate ( )

Focuses and activates the text view. This will show the virtual keyboard if applicable.

See also
Deactivate
IsActivated
Activated
void CYITextEditView::ActivateCaret ( )

Turns on displaying of the caret. It is on by default.

virtual void CYITextEditView::Clear ( )
virtual

Clears the text and hides any keyboard selection menus such as copy and paste dialogs.

void CYITextEditView::Deactivate ( )

Deactivates the text view. Focus is retained on the text view after deactivation. This will hide any selection menus from virtual keyboards.

See also
Activate
IsActivated
Deactivated
void CYITextEditView::DeactivateCaret ( )

Turns off displaying of the caret.

void CYITextEditView::DoScrollingForMouseEvent ( )
protected

Handles scrolling when triggered by mouse movement within the view.

void CYITextEditView::DoScrollingForTimerEvent ( )
protected

Handles scrolling when triggered by m_pScrollTimer.

virtual const CYISceneView::AssetRequirement* CYITextEditView::GetAssetRequirements ( uint32_t *  pRequirementCount)
overridevirtual

Returns the asset requirements for the view; implemented in each subclass to return the nodes and timelines which must be present in the view. Used internally by the You.i Engine After Effects Plug-in.

Reimplemented from CYISceneView.

const CYIColor& CYITextEditView::GetCaretColor ( ) const

Returns the color of the caret.

See also
SetCaretColor
const CYIString& CYITextEditView::GetDefaultText ( ) const

Returns the current default text.

See also
SetDefaultText
const CYIColor& CYITextEditView::GetDefaultTextColor ( ) const

Returns the color of the default text.

See also
SetDefaultTextColor
float CYITextEditView::GetInitialTextEntryBoxWidth ( ) const

Returns the maximum width of the text entry's display area as set by the position of the input properties specified in the view template.

virtual CYIKeyboardInputBridge::INPUT_TYPE CYITextEditView::GetInputType ( ) const
overridevirtual

Returns CYIKeyboardInputBridge::INPUT_TEXT by default.

See also
INPUT_TYPE

Reimplemented from CYIKeyboardInputBridge::Receiver.

uint32_t CYITextEditView::GetMaximumCharacterCount ( ) const
const CYIColor& CYITextEditView::GetTextColor ( ) const

Returns the color of the text node.

See also
SetTextColor
float CYITextEditView::GetTextEntryBoxWidth ( ) const

Returns the maximum width of the text entry's display area.

By default this value is based on the position of the input properties specified in the view template.

float CYITextEditView::GetTextWidth ( uint32_t  nPosition)
protected

Returns the width of the text entered up to and including character at position 'n'.

virtual CYIString CYITextEditView::GetValue ( ) const
virtual
See also
SetValue
virtual bool CYITextEditView::HandleEvent ( const std::shared_ptr< CYIEventDispatcher > &  pDispatcher,
CYIEvent pEvent 
)
overridevirtual

This function intercepts key input to add characters to the text. It also handles various other events for interacting with the caret.

Reimplemented from CYISceneView.

Reimplemented in CYIPasswordTextEditView.

bool CYITextEditView::HasComposingText ( )
protected

Returns true if there is any composing text.

virtual bool CYITextEditView::Init ( )
overridevirtual

Initializes the view and all of its content. Subclasses must call CYISceneView::Init().

Note
This must be called after CYISceneView::BuildFromTemplate()

Reimplemented from CYISceneView.

Reimplemented in CYIPasswordTextEditView.

bool CYITextEditView::InitDefaultTextFromProperty ( )
protected

Initializes the default text based on the 'default-text' property specified in AE.

See also
SetDefaultText
bool CYITextEditView::InitInputType ( )
protected

Initialises the input type from the 'input-type' property specified in AE.

See also
SetInputType
bool CYITextEditView::IsActivated ( ) const

Returns true if this view is currently activated.

See also
Activate
Deactivate
void CYITextEditView::OnActivated ( )
protected

Called when the view is focused. This will activate the caret.

Note
This will only activate the caret, to bring up the keyboard ShowKeyboard() must be called.
void CYITextEditView::OnCaretBlink ( )
protected

Connected to m_pCaretTimer.TimedOut. This handles showing and hiding the caret at a timed interval.

virtual bool CYITextEditView::OnCharWhenActive ( CYIKeyEvent pEvent)
protectedvirtual

Handles character input from OnKeyInputWhenActive().

void CYITextEditView::OnClearButtonClicked ( )
protected

Called when the optional clear button is clicked. This will clear the text and reset the virtual keyboard.

virtual void CYITextEditView::OnCursorPositionChanged ( int32_t  nCursor)
overridevirtual

Called by the keyboard when the cursor position has changed. nCursor indicates the new cursor position in the existing text.

Implements CYIKeyboardInputBridge::Receiver.

Reimplemented in CYIPasswordTextEditView.

void CYITextEditView::OnDeactivated ( )
protected

Called when the view loses focus. This will hide any selection menus from virtual keyboards.

virtual bool CYITextEditView::OnFinishComposingText ( )
overridevirtual

Called by the keyboard when text is finished composing. Any composing text will be removed.

Implements CYIKeyboardInputBridge::Receiver.

virtual bool CYITextEditView::OnKeyboardHidden ( )
overridevirtual

Clears focus when the OS keyboard is hidden.

Implements CYIKeyboardInputBridge::Receiver.

bool CYITextEditView::OnKeyDownWhenActive ( CYIKeyEvent pEvent)
protected

Handles YI_KEY_DOWN events from HandleEventWhenActive().

bool CYITextEditView::OnKeyInputWhenActive ( CYIKeyEvent pEvent)
protected

Handles YI_KEY_INPUT events from HandleEventWhenActive().

void CYITextEditView::OnScrollTimerEvent ( )
protected

Connected to m_pScrollTimer.TimedOut. This handles scrolling when dragging the mouse outside the range of the view.

virtual bool CYITextEditView::OnSetComposingRegion ( int32_t  nStart,
int32_t  nEnd 
)
overridevirtual

Called by the keyboard to mark a certain region of text as the composing text.

Implements CYIKeyboardInputBridge::Receiver.

virtual bool CYITextEditView::OnSetComposingText ( const CYIString text,
int32_t  nCursor 
)
overridevirtual

Called by the keyboard when text is being composed. text contains the new composing text which replaces any previous composition text. nCursor is the new position of the cursor around the text. A value of 1 advances the cursor to the position after the new text. If >0 it is relative to the end of the text-1, if <= 0 it is relative to the start of the text.

Implements CYIKeyboardInputBridge::Receiver.

virtual void CYITextEditView::OnSynchronizeKeyboard ( Receiver::Description &  receiverDescription)
overridevirtual

Synchronizes the state of our view with the state of the OS keyboard.

void CYITextEditView::OnTextChanged ( bool  bNotifyKeyboard)
protected

Called when text is changed in the view. The TextChanged signal is emitted here.

The value of bNotifyKeyboard indicates if CYIKeyboardInputMethod::OnTextChanged should be called or not. This should be true if the text is changing as a result of being set or cleared, and not as a result of user input.

virtual bool CYITextEditView::OnTextDeleted ( int32_t  nBeforeCursor,
int32_t  nAfterCursor 
)
overridevirtual

Called by the keyboard when text is deleted. The parameters indicate the number of characters before and after the current cursor position were deleted.

Implements CYIKeyboardInputBridge::Receiver.

Reimplemented in CYIPasswordTextEditView.

virtual bool CYITextEditView::OnTextEntered ( const CYIString text,
int32_t  nCursor 
)
overridevirtual

Called by the keyboard when text is entered. text contains the new text, and nCursor is the new position of the cursor around the text. A value of 1 advances the cursor to the position after the new text. If >0 it is relative to the end of the text-1, if <= 0 it is relative to the start of the text.

Implements CYIKeyboardInputBridge::Receiver.

virtual bool CYITextEditView::OnTextPasted ( const CYIString text)
overridevirtual

Called by the keyboard when text is pasted. text contains the new text which should be inserted where the cursor is, and the cursor should be moved to the end of the pasted text.

Implements CYIKeyboardInputBridge::Receiver.

Reimplemented in CYIPasswordTextEditView.

virtual void CYITextEditView::OnTextReplaced ( const CYIString text,
int32_t  nCursor 
)
overridevirtual

Called by the keyboard when the text is replaced. text contains the new text which replaces any existing text, and nCursor indicates the cursor position in the new text.

Implements CYIKeyboardInputBridge::Receiver.

Reimplemented in CYIPasswordTextEditView.

void CYITextEditView::RemoveComposingText ( bool  bEmitChangedSignal = true)
protected

Remove composing text from the view. If the bEmitChangedSignal flag is set, then a signal will be emitted when the contents of the view are removed, otherwise a value of true will prevent the signal from firing.

void CYITextEditView::ResetCaretBlinkTimer ( )
protected

Resets the caret blink timer.

void CYITextEditView::SetCaretColor ( const CYIColor clrCaret)

Sets color of the caret.

By default the caret color corresponds to the color of the caret node's material which is CYIColor::Named().Black if no 'Caret' node is specified in the view template.

See also
CYIMaterial::GetColor
void CYITextEditView::SetCaretPositionInString ( float  fLocalSpaceX,
float  fLocalSpaceY,
int8_t  nCaretOffset = 0 
)
protected

Sets the position of the caret using spatial coordinates fLocalSpaceX and fLocalSpaceY. nCarretOffset allows specifying an offset to position the caret relative to fLocalSpaceX and fLocalSpaceY.

void CYITextEditView::SetDefaultText ( const CYIString defaultText)

Sets the text that will be displayed when no text has been input (or set using SetValue()). defaultText will be modified to max length and remove newlines.

void CYITextEditView::SetDefaultTextColor ( const CYIColor defaultTextColor)

Sets color of the default text.

By default the color will be the font color of the text node created in AE.

virtual void CYITextEditView::SetInputType ( CYIKeyboardInputBridge::INPUT_TYPE  eInputType)
virtual

Sets the input type. By default this is set to CYIKeyboardInputMethod::INPUT_TEXT. This can also be set by specifying the 'input-type' property on the view in AE.

void CYITextEditView::SetMaximumCharacterCount ( uint32_t  uMaximumCharacterCount)

Set the maximum character count. This will apply to both text and default text. The default count is 200.

void CYITextEditView::SetTextColor ( const CYIColor textColor)

Sets the color of the text node.

By default the color will be the color of the input properties specified in the view template.

bool CYITextEditView::SetTextEntryBoxWidth ( float  fBoxWidth)

Sets the maximum width of the text entry's display area. Text whose width extends beyond fBoxWidth will be clipped.

See also
GetTextEntryBoxWidth
virtual void CYITextEditView::SetValue ( CYIString  text)
virtual

Sets the current text held in the control to the provided value. If the length of the provided text is longer than the maximum character count (as returned by GetMaximumCharacterCount() ), the text will be cropped to the limit prior to setting.

Reimplemented in CYIPasswordTextEditView.

void CYITextEditView::ShowKeyboard ( )
protected

Request that the system software keyboard be displayed.

void CYITextEditView::StartScrolling ( )
protected

Starts m_pScrollTimer for handling scrolling with the mouse. This is called when the mouse moves outside the view with the mouse button held down.

void CYITextEditView::StopScrolling ( )
protected

Stops m_pScrollTimer. This is called when the mouse button is released or the view loses focus.

void CYITextEditView::UpdateCaretNodePositionAndTextOffset ( )
protected

Updates the position of the caret and the offset of the text.

void CYITextEditView::UpdateClearButton ( )
protected

Updates the visibility of the clear button based on whether the view contains any text. If there is no text, the clear button is hidden.

virtual void CYITextEditView::UpdateEnd ( )
overrideprotectedvirtual

This hook provides subclasses a means to do operations subsequent to update. This hook is called after all children of the current node have been updated.

Warning
The dirty flag will be cleared prior to calling this function to allow new dirty state to be recorded from this function. If querying information about the dirty state of the node, use GetPreviousDirtyFlag().
Overrides must call the base class implementation.
See also
Update()
OnUpdateEnd()

Reimplemented from CYISceneNode.

virtual void CYITextEditView::UpdateTextView ( )
protectedvirtual

Updates the state of all of the visual components of the CYITextEditView. Uses UpdateTextView(const CYIString &currentText) to update the view with the current text (CYITextEditView::m_text).

Reimplemented in CYIPasswordTextEditView.

void CYITextEditView::UpdateTextView ( const CYIString currentText)
protected

Updates the state of all of the visual components of the CYITextEditView. The view will be updated with the text of currentText.

virtual void CYITextEditView::WorldSurfaceScaleUpdated ( )
overrideprotectedvirtual

This will update the visible area and caret position.

Reimplemented from CYISceneNode.

Member Data Documentation

CYISignal<CYITextEditView *> CYITextEditView::Activated

Emitted when the text view becomes activated.

CYISignal<CYITextEditView *> CYITextEditView::Deactivated

Emitted when the text view becomes deactivated;

bool CYITextEditView::m_bActivated
protected
bool CYITextEditView::m_bCaretActive
protected
bool CYITextEditView::m_bPlaceholderTextMode
protected
bool CYITextEditView::m_bUpdateText
protected
CYIColor CYITextEditView::m_CaretColor
protected
CYITimer CYITextEditView::m_CaretTimer
protected
CYIString CYITextEditView::m_CurrentText
protected
std::shared_ptr<CYIAssetTexture> CYITextEditView::m_DefaultCaretTexture
protected
CYIString CYITextEditView::m_DefaultText
protected
CYIColor CYITextEditView::m_DefaultTextColor
protected
CYIKeyboardInputBridge::INPUT_TYPE CYITextEditView::m_eInputType
protected
float CYITextEditView::m_fCaretMaxX
protected
float CYITextEditView::m_fInitialCaretMaxX
protected
int32_t CYITextEditView::m_nComposingEndPos
protected
int32_t CYITextEditView::m_nComposingStartPos
protected
int32_t CYITextEditView::m_nLengthOfValueString
protected
int32_t CYITextEditView::m_nPosInString
protected
CYITimelineLoop* CYITextEditView::m_pCaretBlinkTimelineLoop
protected
CYISceneNode* CYITextEditView::m_pCaretNode
protected
CYIPushButtonView* CYITextEditView::m_pClearBtn
protected
CYIString CYITextEditView::m_PreviousText
protected
CYITimer* CYITextEditView::m_pScrollTimer
protected
CYITextSceneNode* CYITextEditView::m_pTextNode
protected
CYIColor CYITextEditView::m_TextColor
protected
uint32_t CYITextEditView::m_uMaximumCharacterCount
protected
glm::vec3 CYITextEditView::m_vScrollMouseLocalSpaceLocation
protected
glm::vec2 CYITextEditView::m_vScrollMouseLocationDown
protected
CYISignal<const CYIString & , const CYIString & > CYITextEditView::TextChanged

Emitted when the text changes. The first signal parameter is the text currently in the text view. The second signal parameter is the text which was previously in the text view before the text changed.


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