You.i Engine
CYIPasswordTextEditView Class Reference

Detailed Description

A CYITextEditView implementation which masks its contents.

This view provides a method of masking entered text contents, this is most useful for password fields. The view allows for a mask character to be configured as well as the duration which the last entered character will be visible for.

Certain configurations of CYIPasswordTextEditView can lead to erratic behavior if bidirectinoal or right-to-left text is entered. If the view is set to use text justifications CYITextEditView::Justification::Start or CYITextEditView::Justification::End, the view will automatically align based on the detected base direction of the text. Since password mask characters are typically not strongly directional, including the default character '•', the default text direction of left-to-right will typically be detected when all characters are mask characters. If a right-to-left character is entered, and the show character timer, which is set using SetCharacterShowTime, is not set to zero, the visible right-to-left character will briefly cause the string to be detected as having a base direction of right-to-left. Since the start and end justifications automatically adjust alignment based on base text direction, this can cause the entered text to jump between the left and right side of the view.
We recommend using justifications with a static alignment, such as CYITextEditView::Justification::Left, CYITextEditView::Justification::Right, or CYITextEditView::Justification::Center when calling CYITextEditView::SetXJustify on a CYIPasswordTextEditView that is expected to have bidirectinoal or right-to-left text entered. Alternatively, the show character timer can be set to zero by calling SetCharacterShowTime, to prevent strongly directional characters from ever being visible.

View Template Specification

Type Labels Property Description
Node Text Required Layer name for the text field.

#include <view/YiPasswordTextEditView.h>

Inheritance diagram for CYIPasswordTextEditView:

Public Member Functions

 CYIPasswordTextEditView ()
virtual ~CYIPasswordTextEditView ()
char32_t GetMaskCharacter () const
uint64_t GetCharacterShowTime ()
void SetMaskCharacter (char32_t maskCharacter)
void SetCharacterShowTime (uint64_t timeMs)
void EnableMasking (bool maskChars)
bool IsMaskingEnabled () const
virtual bool Init () override
virtual void SetValue (CYIString text, bool notifyKeyboard=true) override
virtual bool OnTextDeleted (int32_t beforeCursor, int32_t afterCursor) override
virtual void OnTextReplaced (const CYIString &text, size_t cursor) override
virtual void OnCursorPositionChanged (size_t cursor) override
virtual bool OnTextPasted (const CYIString &pText) override
virtual bool HandleEvent (const std::shared_ptr< CYIEventDispatcher > &pDispatcher, CYIEvent *pEvent) override
- Public Member Functions inherited from CYITextEditView
 CYITextEditView ()
virtual ~CYITextEditView ()
virtual void Clear ()
virtual CYIString GetValue () const
void SetDefaultText (const CYIString &defaultText, bool cropToMaxCharacterCount=true)
const CYIStringGetDefaultText () const
void SetDefaultTextColor (const CYIColor &defaultTextColor)
const CYIColorGetDefaultTextColor () const
bool IsDisplayingDefaultText () const
void SetTextColor (const CYIColor &textColor)
const CYIColorGetTextColor () const
void SetFontSize (int32_t size)
size_t GetFontSize () const
void SetCaretColor (const CYIColor &clrCaret)
const CYIColorGetCaretColor () const
size_t GetCaretPosition () const
void DeactivateCaret ()
void ActivateCaret ()
void SetClearButtonMode (ClearButtonMode mode)
ClearButtonMode GetClearButtonMode () const
void SetMaximumCharacterCount (size_t maximumCharacterCount)
void SetEditingEnabled (bool enable)
bool IsEditingEnabled () const
void Activate ()
void Deactivate ()
bool IsActivated () const
size_t GetMaximumCharacterCount () const
bool SetTextEntryBoxWidth (float boxWidth)
float GetTextEntryBoxWidth () const
float GetInitialTextEntryBoxWidth () const
void SetXJustify (Justification xJustify)
Justification GetXJustify () const
virtual bool OnTextEntered (const CYIString &pText, int32_t caret) override
virtual bool OnKeyboardHidden () override
virtual void OnSynchronizeKeyboard (Receiver::Description &receiverDescription) override
virtual void SetReturnKeyType (CYIKeyboardInputBridge::ReturnKeyType keyType) override
virtual void SetInputType (CYIKeyboardInputBridge::InputType inputType)
virtual CYIKeyboardInputBridge::InputType GetInputType () const override
virtual bool OnSetComposingText (const CYIString &pText, int32_t caret) override
virtual bool OnFinishComposingText () override
virtual bool OnSetComposingRegion (int32_t start, int32_t end) override
virtual const CYISceneView::AssetRequirementGetAssetRequirements (uint32_t *pRequirementCount) override
- Public Member Functions inherited from CYISceneView
 CYISceneView ()
virtual ~CYISceneView ()
bool BuildFromTemplate (CYISceneManager *pSceneManager, const std::shared_ptr< CYIAssetViewTemplate > &pAssetViewTemplate, CYISceneManager::MissingClassHandlingMode missingHandlingMode=CYISceneManager::MissingClassHandlingMode::Abort)
bool IsInitialized () const
void SetClippingAreaNode (CYISceneNode *pClippingNode)
virtual CYIOptional< CYIStringViewGetProperty (CYIStringView propertyName) const override
bool GetProperty (CYIStringView propertyName, CYIString *pValue) const
virtual std::map< CYIString, CYIStringGetProperties () const override
virtual void ForEachProperty (const std::function< void(const CYIString &, const CYIString &)> &action) const override
virtual bool HasProperties () const override
void EnableDefaultHitZone ()
bool IsResponsiveLayoutEnabled () const
void EnableResponsiveLayout ()
void DisableResponsiveLayout ()
void AddAnchor (EYIAnchorType anchorType)
YI_ANCHOR_DATA GetAnchor (EYIAnchorType anchorType) const
CYIAbstractTimelineGetInTimeline () const
CYIAbstractTimelineGetOutTimeline () const
CYIAbstractTimelineGetFocusInTimeline () const
CYIAbstractTimelineGetFocusOutTimeline () const
virtual bool HandlesFocusInDescendants () const
virtual bool RequestFocus (CYIFocus::Direction direction=CYIFocus::Direction::Forward, CYIFocus::FocusRootRule focusRootRule=CYIFocus::FocusRootRule::DescendantsUpdateContext, const CYIAABB &previousFocusRect=CYIAABB(), const CYIFocusSearchOptions &options=CYIFocusSearchOptions())
bool HasFocus () const
void SetFocusable (bool focusable)
bool IsFocusable () const
bool CanBeFocused () const
void SetNextFocus (CYISceneView *pView, CYIFocus::Direction direction)
CYISceneViewGetNextFocus (CYIFocus::Direction direction) const
void SetInitiallyFocusedView (CYISceneView *pView, InitialFocusLifetime initialFocusLifetime=InitialFocusLifetime::Persistent)
CYISceneViewGetInitiallyFocusedView () const
CYISceneViewFindNextFocus (CYIFocus::Direction direction, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
CYISceneViewFindNextFocus (CYIFocus::Direction direction, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
virtual CYISceneViewFindNextFocusInDescendants (const CYISceneView *pCurrentFocusView, CYIFocus::Direction direction, CYIAABB &screenSpaceFocusRegion, const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const
const CYISceneNodeGetFocusRoot () const
CYISceneViewGetFocusHandler () const
virtual void OnFocusGained ()
virtual void FocusGained ()
virtual void OnFocusLost ()
virtual void FocusLost ()
virtual void FocusGainedInDescendants () override
virtual bool ContainsFocusableDescendant (const CYIFocusSearchOptions &options=CYIFocusSearchOptions()) const override
const std::shared_ptr< CYIAssetViewTemplate > & GetViewTemplate () const
const std::vector< CYIString > & GetChildTemplateNames ()
virtual CYIAbstractTimelineGetTimeline (CYIStringView markerName, TimelineGetMode mode=TimelineGetMode::GetDefault)
CYIAbstractTimelineGetTimeline (CYIMarkerData::ID id, TimelineGetMode mode=TimelineGetMode::GetDefault)
std::map< CYIString, CYITimeline * > GetTimelines () const
bool FindTimeline (CYIAbstractTimeline *&pTimeline, CYIStringView markerName, FetchType type, const CYIString &tag="", TimelineGetMode mode=TimelineGetMode::GetDefault)
CYITimelineGroupGetTimelineGroup (CYIStringView markerName)
std::unique_ptr< CYITimelineGroupBuildTimelineGroup (CYIStringView 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 SetDirtyFlag (DirtyFlag dirtyFlag)
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 id)
uint64_t GetUniqueID () const
bool AddChild (std::unique_ptr< CYISceneNode > pSceneNode)
bool AddChild (std::unique_ptr< CYISceneNode >, size_t index)
bool InsertChildAfter (CYISceneNode *pRefNode, std::unique_ptr< CYISceneNode > pSceneNode)
std::unique_ptr< CYISceneNodeRemoveChild (CYISceneNode *pSceneNode)
bool ReorderChild (size_t fromIndex, size_t toIndex)
CYITransformGetTransform ()
CYISceneNodeGetParent () const
bool ChangeParent (CYISceneNode *pParent)
CYISceneNodeGetDrawParent () const
bool IsAncestorOf (const CYISceneNode *pNode) const
CYISceneManagerGetSceneManager () const
size_t GetChildCount () const
uint32_t GetChildCountRecursive () const
CYISceneNodeGetChild (size_t index) const
Iterator begin (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const
Iterator end (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const
ReverseIterator rbegin (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const
ReverseIterator rend (Iterator::Mode mode=Iterator::Mode::ImmediateChildren) const
CYISceneNodeGetChild (const CYIString &name) const
size_t GetDrawChildCount () const
CYISceneNodeGetDrawChild (size_t index) const
CYISceneNodeGetDrawChildByID (int32_t id) const
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetChild (uint32_t targetMatchedNodeCount=1) const
template<class YI_SCENE_NODE_SUBCLASS >
std::list< YI_SCENE_NODE_SUBCLASS * > GetChildren () const
template<class YI_SCENE_NODE_SUBCLASS >
std::list< YI_SCENE_NODE_SUBCLASS * > GetDrawChildren () const
size_t GetIndexOfChild (const CYISceneNode *pSceneNode) const
size_t GetIndexOfDrawChild (const CYISceneNode *pSceneNode) const
void Show ()
void Hide ()
void SetVisibility (bool visible)
void SetOpacity (float opacity)
float GetCompositeOpacity () const
float GetLocalOpacity () const
bool IsVisible () const
bool IsTrulyVisible () const
bool IsPerceptible () const
CYISceneNodeGetNode (CYIStringView name)
CYISceneNodeGetNode (CYIStringView 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 (CYIStringView name)
CYISceneNodeGetNode (const int32_t id)
CYISceneNodeGetNode (const int32_t id, const CYIRuntimeTypeInfo &enforceClassType)
CYISceneNodeGetNodeWithUniqueID (uint64_t uniqueID)
template<class YI_SCENE_NODE_SUBCLASS >
bool FindNode (YI_SCENE_NODE_SUBCLASS *&pNode, CYIStringView nodeName, FetchType type, const CYIString &tag)
std::list< CYISceneNode * > GetNodes (CYIStringView name)
std::list< CYISceneNode * > GetNodes (int32_t id)
std::list< CYISceneNode * > GetNodes (const CYIRuntimeTypeInfo &enforceClassType)
template<class YI_SCENE_NODE_SUBCLASS >
const YI_SCENE_NODE_SUBCLASS * GetNode (uint32_t targetMatchedNodeCount=1) const
template<class YI_SCENE_NODE_SUBCLASS >
YI_SCENE_NODE_SUBCLASS * GetNode (uint32_t targetMatchedNodeCount=1)
void SetMesh (const std::shared_ptr< CYIMesh > &pMesh)
bool SetNPatchBitmap (const std::shared_ptr< CYIBitmap > &pNPatchBitmap)
void ClearNPatch ()
void SetMaterial (const std::shared_ptr< CYIMaterial > &pMaterial, size_t index=0)
void AddEffect (const std::shared_ptr< CYIEffect > &pEffect)
void RemoveEffect (const std::shared_ptr< CYIEffect > &pEffect)
size_t GetEffectCount () const
const std::shared_ptr< CYIEffect > & GetEffect (size_t index) const
void ConnectEffectsToTimelines (const CYITimelineTrack *pTrack)
void AddMask (std::unique_ptr< CYIMask > pMask)
std::unique_ptr< CYIMaskRemoveMask (const CYIMask *pMask)
size_t GetMaskCount () const
const CYIMaskGetMask (size_t index) const
CYIMaskGetMask (size_t index)
const std::shared_ptr< CYIMesh > & GetMesh () const
const std::shared_ptr< CYIBitmap > & GetNPatchBitmap () const
size_t GetMaterialCount () const
const std::shared_ptr< CYIMaterial > & GetMaterial (size_t index=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< CYIRenderTarget > & GetRenderTarget () const
const CYIAABBGetWorldAABB () const
const CYIAABBGetLocalAABB () const
void SetAnchorPoint (const glm::vec3 &anchorPoint)
void SetAnchorPoint (float x, float y, float z)
void SetAnchorPointX (float x)
void SetAnchorPointY (float y)
void SetAnchorPointZ (float z)
void SetPosition (const glm::vec3 &position)
void SetPosition (float x, float y, float z)
void SetPositionX (float x)
void SetPositionY (float y)
void SetPositionZ (float z)
void SetRotation (const glm::vec3 &rotation)
void SetRotation (float pitchDegrees, float yawDegrees, float rollDegrees)
void SetRotationX (float pitchDegrees)
void SetRotationY (float yawDegrees)
void SetRotationZ (float rollDegrees)
void SetOrientation (float pitchDegrees, float yawDegrees, float rollDegrees)
void SetOrientation (const glm::quat &orientation)
void SetScale (const glm::vec3 &scale)
void SetScale (float factorX, float factorY, float factorZ)
void SetScaleX (float factor)
void SetScaleY (float factor)
void SetScaleZ (float factor)
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 &size, bool dirtyLayout=true)
const glm::vec3 & GetSize () const
const glm::vec3 & GetInitialSize () const
void SetMeasuredSize (const glm::vec3 &measuredSize)
const glm::vec3 & GetMeasuredSize () const
void SetInternalCustomTimelineValue (uint32_t trackID, const CYIVariant &value)
virtual void SetCustomTimelineValue (uint32_t trackID, const CYIVariant &value)
void SetClippingOn ()
void SetClippingOff ()
bool GetClipping () const
void SetClippingBox (const CYIAABB &rWorldBox)
const CYIAABBGetClippingBox () const
void StartPropertyAnimation (PropertyAnimation::Type propType, float from, float to, uint32_t durMs, CYITimeInterpolator *pTimeInterpolator=nullptr, bool dirtyLayout=true)
void StopPropertyAnimation (PropertyAnimation::Type propType)
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 pointerID)
void StopCapturePointerEvents (uint8_t pointerID)
bool DrawBehindChildren (CYISceneNode *pSceneNode, bool *pChanged=nullptr)
bool DrawInFrontOfChildren (CYISceneNode *pSceneNode, bool *pChanged=nullptr)
bool DrawBehind (CYISceneNode *pSceneNode, bool *pChanged=nullptr)
bool DrawInFront (CYISceneNode *pSceneNode, bool *pChanged=nullptr)
bool IsFocusRoot () const
void SetIsFocusRoot (bool isFocusRoot)
virtual void OnFocusGainedInDescendants ()
virtual void OnFocusLostInDescendants ()
virtual void FocusLostInDescendants ()
virtual void OnFocusChangedInDescendants ()
virtual void FocusChangedInDescendants ()
void SetUseLocalTransformAndAlpha (bool use)
bool GetProperty (CYIStringView propertyName, CYIString *pValue) const
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 fetchMode=LayoutConfigFetchMode::LazyInstantiate) const
CYILayoutConfigGetLayoutConfig (LayoutConfigFetchMode fetchMode=LayoutConfigFetchMode::LazyInstantiate)
void SetLayoutState (std::unique_ptr< CYILayoutState > pLayoutState)
const CYILayoutStateGetLayoutState () const
CYILayoutStateGetLayoutState ()
void RequestLayout ()
LayoutDirtyFlag GetLayoutDirtyFlag () const
virtual void SetLayoutDirtyFlag (LayoutDirtyFlag flag)
virtual CYIAbstractCameraSceneNodeFindActiveCamera (const CYISceneNode *pTargetSceneNode=nullptr) const
CYIAccessibilityAttributes::Accessible GetAccessible () const
void SetAccessible (CYIAccessibilityAttributes::Accessible accessible)
const CYIAccessibilityAttributesGetAccessibilityAttributes () const
std::unique_ptr< CYIAccessibilityAttributesTakeAccessibilityAttributes ()
void SetAccessibilityAttributes (std::unique_ptr< CYIAccessibilityAttributes > pAttributes)
template<typename T >
bool CanCastTo () const
- Public Member Functions inherited from CYIEventTarget
 CYIEventTarget ()
virtual ~CYIEventTarget ()
bool AddEventListener (CYIEvent::Type eventType, CYIEventHandler *pListener, CYIEventTarget::Phase phase=CYIEventTarget::Phase::Bubble)
bool RemoveEventListener (CYIEvent::Type eventType, CYIEventHandler *pListener, CYIEventTarget::Phase phase=CYIEventTarget::Phase::Bubble)
void SetSpecialTypeFlag (SpecialEventTargetType type)
void ClearSpecialTypeFlag (SpecialEventTargetType type)
SpecialEventTargetType GetSpecialTypes () const
const std::shared_ptr< CYIEventTargetProxy > & GetProxy () const
- 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 ()=default
bool GetProperty (CYIStringView propertyName, CYIString *pValue) const
- 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 enable)
- Public Member Functions inherited from CYIKeyboardInputBridge::Receiver
virtual ~Receiver ()
virtual void OnSynchronizeKeyboard (Description &receiverKeyboardInfo)
ReturnKeyType GetReturnKeyType () const
bool SetAccessoryImageUrl (const CYIUrl &url)
const CYIUrlGetAccessoryImageUrl () const

Protected Member Functions

virtual void UpdateTextView () override
void UpdateTextView (bool showLastChar)
void HideLastCharacter ()
CYIString GetMaskedText (const CYIString &text, bool showLastChar) const
- Protected Member Functions inherited from CYITextEditView
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 notifyKeyboard)
void UpdateCaretNodePositionAndTextOffset ()
void ResetCaretBlinkTimer ()
void SetCaretPositionInString (float localSpaceX, float localSpaceY, int8_t caretOffset=0)
void RemoveComposingText (bool emitChangedSignal=true)
bool HasComposingText ()
void OnClearButtonClicked ()
void UpdateClearButton ()
void UpdateTextSpan (bool updateTextOffset)
bool InitInputType ()
bool InitDefaultTextFromProperty ()
float GetTextWidth (uint32_t position)
void OnScrollTimerEvent ()
void StartScrolling ()
void StopScrolling ()
void DoScrollingForTimerEvent ()
void DoScrollingForMouseEvent ()
virtual void WorldSurfaceScaleUpdated () override
virtual void UpdateBegin () 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 ()
virtual void OnUpdateBegin ()
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 OnChildVisibilityChanged (CYISceneNode *pChild)
LayoutDirtyFlag GetCurrentLayoutDirtyFlag () const
virtual CYIString GetDumpTreeString () const
void DumpTree (int32_t indentLevel) const
virtual void SetCustomUniforms ()
template<class T >
void SetNodeType ()
virtual CYISceneNodeGetNodeFromChildren (CYIStringView name)
virtual CYISceneNodeGetNodeFromChildren (const int32_t id)
virtual CYISceneNodeGetNodeFromChildren (const CYIRuntimeTypeInfo &enforceClassType)
CYISceneNodeGetNodeFromChildrenAfterTarget (const CYIRuntimeTypeInfo &enforceClassType, bool *pTargetReached, CYISceneNode *pStartAfterTarget)
- Protected Member Functions inherited from CYIKeyboardInputBridge::Receiver
 Receiver ()

Additional Inherited Members

- Public Types inherited from CYITextEditView
enum  Justification : uint8_t {
  Justification::Left = 0,
enum  ClearButtonMode {
- Public Types inherited from CYISceneView
enum  TimelineGetMode {
enum  InitialFocusLifetime {
- Public Types inherited from CYISceneNode
enum  LayoutDirtyFlag : uint8_t {
enum  LayoutConfigFetchMode {
  LayoutConfigFetchMode::DoNotLazyInstantiate = 0,
enum  MeasureMode {
enum  FetchType {
  FetchType::Optional = 0,
typedef std::reverse_iterator< IteratorReverseIterator
typedef uint16_t DirtyFlag
- Public Types inherited from CYIEventTarget
enum  SpecialEventTargetType : uint8_t {
  SpecialEventTargetType::None = 0x00,
  SpecialEventTargetType::NoPick = 0x20
enum  Phase : uint8_t {
- Static Public Member Functions inherited from CYISceneView
static void RegisterAllViews ()
- Static Public Member Functions inherited from CYISceneNode
static void RegisterAllSceneNodes ()
- Public Attributes inherited from CYITextEditView
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 *, PropertyAnimation::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...
CYISignal< CYIAccessibilityAttributes::AccessibleAccessibleStateChanged
 Emitted when accessible state changed. More...
- Public Attributes inherited from CYIKeyboardInputBridge::Receiver
CYISignal< CYIKeyboardInputBridge::Receiver * > ReturnKeyPressed
- Static Public Attributes inherited from CYISceneNode
static constexpr DirtyFlag DirtyClean = 0x0000
static constexpr DirtyFlag DirtySceneGraph = 0x0001
static constexpr DirtyFlag DirtyVisibility = 0x0002
static constexpr DirtyFlag DirtyOpacity = 0x0004
static constexpr DirtyFlag DirtyLocalTransform = 0x0008
static constexpr DirtyFlag DirtyWorldTransform = 0x0010
static constexpr DirtyFlag DirtyUniform = 0x0020
static constexpr DirtyFlag DirtyWorldBoundingBox = 0x0040
static constexpr DirtyFlag DirtyMesh = 0x0080
static constexpr DirtyFlag DirtyWorldSurfaceScale = 0x0100
static constexpr DirtyFlag DirtyWorldScale = 0x0200
static constexpr DirtyFlag DirtyLocalBoundingBox = 0x0400
static constexpr DirtyFlag DirtyEverything = (DirtySceneGraph | DirtyVisibility | DirtyOpacity | DirtyLocalTransform | DirtyWorldTransform | DirtyUniform | DirtyWorldBoundingBox | DirtyWorldSurfaceScale | DirtyWorldScale | DirtyLocalBoundingBox)
- Protected Attributes inherited from CYITextEditView
CYITimer m_CaretTimer
std::unique_ptr< CYITimelineLoopm_pCaretBlinkTimelineLoop
std::unique_ptr< CYITimerm_pScrollTimer
CYIString m_CurrentText
CYIString m_PreviousText
CYIString m_DefaultText
CYIColor m_DefaultTextColor
CYIColor m_TextColor
CYIColor m_CaretColor
ClearButtonMode m_clearButtonMode
bool m_updateText
bool m_editingEnabled
bool m_activated
bool m_caretActive
bool m_placeholderTextMode
size_t m_lengthOfValueString
CYITextEngine::PositionInString m_posInString
bool m_alignedCharacterMustBeVisible
size_t m_maximumCharacterCount
size_t m_composingStartPos
size_t m_composingEndPos
CYIKeyboardInputBridge::InputType m_inputType
glm::vec2 m_scrollMouseLocationDown
glm::vec3 m_scrollMouseLocalSpaceLocation
float m_caretMaxX
float m_initialCaretMaxX
Justification m_xJustify
std::shared_ptr< CYIAssetTexturem_DefaultCaretTexture
- Protected Attributes inherited from CYISceneView
bool m_stopEventPropagation
bool m_responsiveLayoutEnabled
bool m_sceneTreeBuilt
bool m_inAnimatedPosition
std::unique_ptr< CYILayoutm_pLayout
std::shared_ptr< CYIAssetViewTemplatem_pAssetViewTemplate
std::shared_ptr< CYISceneNodeProxym_pInitiallyFocusedView
InitialFocusLifetime m_initialFocusLifetime
std::multimap< EYIAnchorType, YI_ANCHOR_DATAm_anchors
std::map< CYIString, std::unique_ptr< CYITimeline >, std::less<> > m_timelines
std::map< CYIString, std::unique_ptr< CYIParallelTimelineGroup >, std::less<> > m_timelineGroups
- Protected Attributes inherited from CYISceneNode
CYIString m_name
std::vector< std::unique_ptr< CYISceneNode > > m_children
std::vector< CYISceneNode * > m_drawChildren
std::map< CYIString, CYIString, std::less<> > m_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< std::unique_ptr< PropertyAnimation > > m_propertyAnimations
float m_localOpacity
glm::mat4 m_EffectTransform
std::unique_ptr< CYITransformm_pTransform
glm::vec3 m_size
glm::vec3 m_initialSize
glm::vec3 m_measuredSize
glm::vec3 m_vlsLastCollision
bool m_clip
bool m_localVisibility
int32_t m_id
uint64_t m_guid
std::shared_ptr< CYIRenderTargetm_pRenderTarget
std::shared_ptr< CYIMeshm_pMesh
std::unique_ptr< CYINPatch > m_pNPatch
std::shared_ptr< CYIBitmapm_pNPatchBitmap
std::shared_ptr< IYIUniformBufferObjectm_pShaderUniforms
- Protected Attributes inherited from CYIEventTarget
std::vector< EventListenerEntry > m_listeners
SpecialEventTargetType m_specialTypes
- Protected Attributes inherited from CYIEventHandler
bool m_enableEvents
- Protected Attributes inherited from CYIKeyboardInputBridge::Receiver
CYIUrl m_accessoryImageUrl
ReturnKeyType m_keyType

Constructor & Destructor Documentation

◆ CYIPasswordTextEditView()

CYIPasswordTextEditView::CYIPasswordTextEditView ( )

◆ ~CYIPasswordTextEditView()

virtual CYIPasswordTextEditView::~CYIPasswordTextEditView ( )

Member Function Documentation

◆ EnableMasking()

void CYIPasswordTextEditView::EnableMasking ( bool  maskChars)

Enables/disables the masking of characters in this view.

By default masking is enabled for this view.

See also

◆ GetCharacterShowTime()

uint64_t CYIPasswordTextEditView::GetCharacterShowTime ( )

Returns the duration that the last entered character will be shown for.

See also

◆ GetMaskCharacter()

char32_t CYIPasswordTextEditView::GetMaskCharacter ( ) const

Returns the character that is currently being used to mask text entered into this view.

See also

◆ GetMaskedText()

CYIString CYIPasswordTextEditView::GetMaskedText ( const CYIString text,
bool  showLastChar 
) const

Returns a masked version of text. All characters of text will be masked unless showLastChar is true, in this case the last character of text will be left unmasked.

◆ HandleEvent()

virtual bool CYIPasswordTextEditView::HandleEvent ( const std::shared_ptr< CYIEventDispatcher > &  pDispatcher,
CYIEvent pEvent 

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

Reimplemented from CYITextEditView.

◆ HideLastCharacter()

void CYIPasswordTextEditView::HideLastCharacter ( )

Hides all characters in the text. If m_maskingEnabled is false, this has no effect.

◆ Init()

virtual bool CYIPasswordTextEditView::Init ( )

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

This must be called after CYISceneView::BuildFromTemplate()

Reimplemented from CYITextEditView.

◆ IsMaskingEnabled()

bool CYIPasswordTextEditView::IsMaskingEnabled ( ) const

Returns whether or not characters are being masked. True means characters are being masked; false means characters are being shown.

See also

◆ OnCursorPositionChanged()

virtual void CYIPasswordTextEditView::OnCursorPositionChanged ( size_t  cursor)

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

Reimplemented from CYITextEditView.

◆ OnTextDeleted()

virtual bool CYIPasswordTextEditView::OnTextDeleted ( int32_t  beforeCursor,
int32_t  afterCursor 

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

Reimplemented from CYITextEditView.

◆ OnTextPasted()

virtual bool CYIPasswordTextEditView::OnTextPasted ( const CYIString text)

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.

Reimplemented from CYITextEditView.

◆ OnTextReplaced()

virtual void CYIPasswordTextEditView::OnTextReplaced ( const CYIString text,
size_t  cursor 

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

Reimplemented from CYITextEditView.

◆ SetCharacterShowTime()

void CYIPasswordTextEditView::SetCharacterShowTime ( uint64_t  timeMs)

Sets the duration in milliseconds to show the last entered character. After this amount of time, the character is replaced by the mask character.

The default duration is 2 seconds.

See also

◆ SetMaskCharacter()

void CYIPasswordTextEditView::SetMaskCharacter ( char32_t  maskCharacter)

Sets the character that will be used to mask the text entered into this view to maskCharacter.

The default mask character is '•'.

◆ SetValue()

virtual void CYIPasswordTextEditView::SetValue ( CYIString  text,
bool  notifyKeyboard = true 

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.

The TextChanged signal will not be emitted when calling this function.

Reimplemented from CYITextEditView.

◆ UpdateTextView() [1/2]

virtual void CYIPasswordTextEditView::UpdateTextView ( )

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

Reimplemented from CYITextEditView.

◆ UpdateTextView() [2/2]

void CYIPasswordTextEditView::UpdateTextView ( bool  showLastChar)

Updates the state of all of the visual components of the CYITextEditView, specifying whether the last character should be shown.

See also

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