Dali 3D User Interface Engine
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
Dali::Toolkit::Internal::AccessibilityManager Class Reference

Manages registration of actors in an accessibility focus chain and changing the focused actor within that chain. More...

#include <accessibility-manager-impl.h>

Inheritance diagram for Dali::Toolkit::Internal::AccessibilityManager:
Inheritance graph
[legend]
Collaboration diagram for Dali::Toolkit::Internal::AccessibilityManager:
Collaboration graph
[legend]

Classes

struct  ActorAdditionalInfo
 

Public Types

typedef
Dali::Toolkit::AccessibilityManager::AccessibilityActionSignalType 
AccessibilityActionSignalType
 
typedef
Dali::Toolkit::AccessibilityManager::AccessibilityActionScrollSignalType 
AccessibilityActionScrollSignalType
 
typedef std::pair< unsigned
int, unsigned int > 
FocusIDPair
 
typedef std::map< unsigned int,
unsigned int > 
FocusIDContainer
 
typedef FocusIDContainer::iterator FocusIDIter
 
typedef
FocusIDContainer::const_iterator 
FocusIDConstIter
 
typedef std::pair< unsigned
int, ActorAdditionalInfo
IDAdditionalInfoPair
 
typedef std::map< unsigned int,
ActorAdditionalInfo
IDAdditionalInfoContainer
 
typedef
IDAdditionalInfoContainer::iterator 
IDAdditionalInfoIter
 
typedef
IDAdditionalInfoContainer::const_iterator 
IDAdditionalInfoConstIter
 

Public Member Functions

 AccessibilityManager ()
 Construct a new AccessibilityManager. More...
 
void Initialise ()
 Initialise the AccessibilityManager. More...
 
void SetAccessibilityAttribute (Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type, const std::string &text)
 Set the information of the specified actor's accessibility attribute. More...
 
std::string GetAccessibilityAttribute (Actor actor, Toolkit::AccessibilityManager::AccessibilityAttribute type) const
 Get the text of the specified actor's accessibility attribute. More...
 
void SetFocusOrder (Actor actor, const unsigned int order)
 Set the focus order of the actor. More...
 
unsigned int GetFocusOrder (Actor actor) const
 Get the focus order of the actor. More...
 
unsigned int GenerateNewFocusOrder () const
 Generates a new focus order number which can be used to assign to actors which need to be appended to the end of the current focus order chain. More...
 
Actor GetActorByFocusOrder (const unsigned int order)
 Get the actor that has the specified focus order. More...
 
bool SetCurrentFocusActor (Actor actor)
 Move the focus to the specified actor. More...
 
Actor GetCurrentFocusActor ()
 Get the current focused actor. More...
 
Actor GetCurrentFocusGroup ()
 Get the focus group of current focused actor. More...
 
unsigned int GetCurrentFocusOrder ()
 Get the focus order of currently focused actor. More...
 
bool MoveFocusForward ()
 Move the focus to the next focusable actor in the focus chain (according to the focus traversal order). More...
 
bool MoveFocusBackward ()
 Move the focus to the previous focusable actor in the focus chain (according to the focus traversal order). More...
 
void ClearFocus ()
 Clear the focus from the current focused actor if any, so that no actor is focused in the focus chain. More...
 
void Reset ()
 Clear the every registered focusable actor from focus-manager. More...
 
void SetFocusGroup (Actor actor, bool isFocusGroup)
 Set whether an actor is a focus group that can limit the scope of focus movement to its child actors in the focus chain. More...
 
bool IsFocusGroup (Actor actor) const
 Check whether the actor is set as a focus group or not. More...
 
void SetGroupMode (bool enabled)
 Set whether the group mode is enabled or not. More...
 
bool GetGroupMode () const
 Get whether the group mode is enabled or not. More...
 
void SetWrapMode (bool wrapped)
 Set whether focus will be moved to the beginning of the focus chain when it reaches the end or vice versa. More...
 
bool GetWrapMode () const
 Get whether the wrap mode is enabled or not. More...
 
void SetFocusIndicatorActor (Actor indicator)
 Set the focus indicator actor. More...
 
Actor GetFocusIndicatorActor ()
 Get the focus indicator actor. More...
 
Actor GetFocusGroup (Actor actor)
 Returns the closest ancestor of the given actor that is a focus group. More...
 
Vector2 GetReadPosition () const
 Returns the current position of the read action. More...
 
Toolkit::AccessibilityManager::FocusChangedSignalTypeFocusChangedSignal ()
 This signal is emitted when the current focused actor is changed. More...
 
Toolkit::AccessibilityManager::FocusOvershotSignalTypeFocusOvershotSignal ()
 This signal is emitted when there is no way to move focus further. More...
 
Toolkit::AccessibilityManager::FocusedActorActivatedSignalTypeFocusedActorActivatedSignal ()
 This signal is emitted when the current focused actor is activated. More...
 
AccessibilityActionSignalTypeStatusChangedSignal ()
 This is emitted when accessibility(screen-reader) feature turned on or off. More...
 
AccessibilityActionSignalTypeActionNextSignal ()
  More...
 
AccessibilityActionSignalTypeActionPreviousSignal ()
 This is emitted when accessibility action is received to move focus to the previous focusable actor (by one finger flick up). More...
 
AccessibilityActionSignalTypeActionActivateSignal ()
 This is emitted when accessibility action is received to activate the current focused actor (by one finger double tap). More...
 
AccessibilityActionSignalTypeActionOverSignal ()
 This is emitted when accessibility action is received to focus and read the actor (by one finger move). More...
 
AccessibilityActionSignalTypeActionReadSignal ()
 This is emitted when accessibility action is received to focus and read the actor (by one finger tap). More...
 
AccessibilityActionSignalTypeActionReadNextSignal ()
 This is emitted when accessibility action is received to move focus to the next focusable actor (by one finger flick right). More...
 
AccessibilityActionSignalTypeActionReadPreviousSignal ()
 This is emitted when accessibility action is received to move focus to the previous focusable actor (by one finger flick left). More...
 
AccessibilityActionSignalTypeActionUpSignal ()
 This is emitted when accessibility action is received to change the value when the current focused actor is a slider (by double finger down and move up and right). More...
 
AccessibilityActionSignalTypeActionDownSignal ()
 This is emitted when accessibility action is received to change the value when the current focused actor is a slider (by double finger down and move down and left). More...
 
AccessibilityActionSignalTypeActionClearFocusSignal ()
 This is emitted when accessibility action is received to clear the focus from the current focused actor if any, so that no actor is focused in the focus chain. More...
 
AccessibilityActionSignalTypeActionBackSignal ()
 This is emitted when accessibility action is received to navigate back (by two fingers circle draw). More...
 
AccessibilityActionSignalTypeActionScrollUpSignal ()
 This is emitted when accessibility action is received to scroll up the list (by two finger swipe up). More...
 
AccessibilityActionSignalTypeActionScrollDownSignal ()
 This is emitted when accessibility action is received to scroll down the list (by two finger swipe down). More...
 
AccessibilityActionSignalTypeActionPageLeftSignal ()
 This is emitted when accessibility action is received to scroll left to the previous page (by two finger swipe left). More...
 
AccessibilityActionSignalTypeActionPageRightSignal ()
 This is emitted when accessibility action is received to scroll right to the next page (by two finger swipe right). More...
 
AccessibilityActionSignalTypeActionPageUpSignal ()
 This is emitted when accessibility action is received to scroll up to the previous page (by one finger swipe left and right). More...
 
AccessibilityActionSignalTypeActionPageDownSignal ()
 This is emitted when accessibility action is received to scroll down to the next page (by one finger swipe right and left). More...
 
AccessibilityActionSignalTypeActionMoveToFirstSignal ()
 This is emitted when accessibility action is received to move the focus to the first item on the screen (by one finger swipe up and down). More...
 
AccessibilityActionSignalTypeActionMoveToLastSignal ()
 This is emitted when accessibility action is received to move the focus to the last item on the screen (by one finger swipe down and up). More...
 
AccessibilityActionSignalTypeActionReadFromTopSignal ()
 This is emitted when accessibility action is received to focus and read from the first item on the top continously (by three fingers single tap). More...
 
AccessibilityActionSignalTypeActionReadFromNextSignal ()
 This is emitted when accessibility action is received to move the focus to and read from the next item continously (by three fingers double tap). More...
 
AccessibilityActionSignalTypeActionZoomSignal ()
 This is emitted when accessibility action is received to zoom (by one finger triple tap). More...
 
AccessibilityActionSignalTypeActionReadIndicatorInformationSignal ()
 This is emitted when accessibility action is received to read the information in the indicator (by two fingers triple tap). More...
 
AccessibilityActionSignalTypeActionReadPauseResumeSignal ()
 This is emitted when accessibility action is received to pause/resume the current speech (by two fingers single tap). More...
 
AccessibilityActionSignalTypeActionStartStopSignal ()
 This is emitted when accessibility action is received to start/stop the current action (by two fingers double tap). More...
 
AccessibilityActionScrollSignalTypeActionScrollSignal ()
 This is emitted when accessibility action is received to handle scroll event (by two fingers drag). More...
 
- Public Member Functions inherited from Dali::BaseObject
template<class T >
bool ConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, const T &functor)
 Connects a void() functor to a specified signal. More...
 
bool DoAction (const std::string &actionName, const Property::Map &attributes)
 Perform action on this object with the given action name and attributes. More...
 
const std::string & GetTypeName () const
 Returns the type name for the Handle. More...
 
bool GetTypeInfo (Dali::TypeInfo &info) const
 Returns the type info for the Handle. More...
 
bool DoConnectSignal (ConnectionTrackerInterface *connectionTracker, const std::string &signalName, FunctorDelegate *functorDelegate)
 Not intended for application developers. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 
- Public Member Functions inherited from Dali::ConnectionTracker
 ConnectionTracker ()
 Constructor. More...
 
virtual ~ConnectionTracker ()
 Virtual destructor. More...
 
void DisconnectAll ()
 Disconnect all signals from this object. More...
 
virtual void SignalConnected (SlotObserver *slotObserver, CallbackBase *callback)
 Called when a signal is connected. More...
 
virtual void SignalDisconnected (SlotObserver *slotObserver, CallbackBase *callback)
 This method is called when the signal is disconnecting. More...
 
std::size_t GetConnectionCount () const
 returns the connection count .0 More...
 
- Public Member Functions inherited from Dali::ConnectionTrackerInterface
 ConnectionTrackerInterface ()
 Constructor. More...
 
virtual ~ConnectionTrackerInterface ()
 Virtual destructor. More...
 
- Public Member Functions inherited from Dali::SignalObserver
 SignalObserver ()
 Constructor. More...
 
virtual ~SignalObserver ()
 Virtual destructor. More...
 

Static Public Member Functions

static bool DoConnectSignal (BaseObject *object, ConnectionTrackerInterface *tracker, const std::string &signalName, FunctorDelegate *functor)
 Connects a callback function with the object's signals. More...
 

Protected Member Functions

virtual ~AccessibilityManager ()
 Destructor. More...
 
- Protected Member Functions inherited from Dali::BaseObject
 BaseObject ()
 Default constructor. More...
 
virtual ~BaseObject ()
 A reference counted object may only be deleted by calling Unreference(). More...
 
void RegisterObject ()
 Registers the object as created with the Object registry. More...
 
void UnregisterObject ()
 Unregisters the object from Object registry. More...
 
- Protected Member Functions inherited from Dali::RefObject
 RefObject ()
 Default constructor. More...
 
virtual ~RefObject ()
 RefObject is intended as a base class. More...
 
 RefObject (const RefObject &rhs)
 Copy constructor. More...
 
RefObjectoperator= (const RefObject &rhs)
 Assignment operator. More...
 

Private Member Functions

ActorAdditionalInfo GetActorAdditionalInfo (const unsigned int actorID) const
 Get the additional information (e.g. More...
 
void SynchronizeActorAdditionalInfo (const unsigned int actorID, const unsigned int order)
 Synchronize the actor's additional information to reflect its latest focus order. More...
 
bool DoSetCurrentFocusActor (const unsigned int actorID)
 Move the focus to the specified actor and send notification for the focus change. More...
 
bool DoMoveFocus (FocusIDIter focusIDIter, bool forward, bool wrapped)
 Move the focus to the next actor in the focus chain towards the specified direction. More...
 
void DoActivate (Actor actor)
 Activate the actor. More...
 
void CreateDefaultFocusIndicatorActor ()
 Create the default indicator actor to highlight the focused actor. More...
 
void SetFocusable (Actor actor, bool focusable)
 Set whether the actor is focusable or not. More...
 
virtual bool HandlePanGesture (const Integration::PanGestureEvent &panEvent)
 Handle the accessibility pan gesture. More...
 
virtual bool ChangeAccessibilityStatus ()
 Change the accessibility status when Accessibility feature(screen-reader) turned on or off. More...
 
virtual bool ClearAccessibilityFocus ()
 Clear the accessibility focus from the current focused actor. More...
 
virtual bool AccessibilityActionScroll (Dali::TouchEvent &touchEvent)
 Perform the accessibility action associated with a scroll event. More...
 
virtual bool AccessibilityActionPrevious (bool allowEndFeedback)
 Perform the accessibility action to move focus to the previous focusable actor (by one finger flick up). More...
 
virtual bool AccessibilityActionNext (bool allowEndFeedback)
 Perform the accessibility action to move focus to the next focusable actor (by one finger flick down). More...
 
virtual bool AccessibilityActionReadPrevious (bool allowEndFeedback)
 Perform the accessibility action to move focus to the previous focusable actor (by one finger flick left). More...
 
virtual bool AccessibilityActionReadNext (bool allowEndFeedback)
 Perform the accessibility action to move focus to the next focusable actor (by one finger flick right). More...
 
virtual bool AccessibilityActionRead (bool allowReadAgain)
 Perform the accessibility action to focus and read the actor (by one finger tap or move). More...
 
virtual bool AccessibilityActionActivate ()
 Perform the accessibility action to activate the current focused actor (by one finger double tap). More...
 
virtual bool AccessibilityActionUp ()
 Perform the accessibility action to change the value when the current focused actor is a slider (by double finger down and move up and right). More...
 
virtual bool AccessibilityActionDown ()
 Perform the accessibility action to change the value when the current focused actor is a slider (by double finger down and move down and left). More...
 
virtual bool AccessibilityActionBack ()
 Perform the accessibility action to navigate back (by two fingers circle draw). More...
 
virtual bool AccessibilityActionScrollUp ()
 Perform the accessibility action to scroll up the list and focus on the first item on the list after the scrolling and read the item (by two finger swipe up). More...
 
virtual bool AccessibilityActionScrollDown ()
 Perform the accessibility action to scroll down the list and focus on the first item on the list after the scrolling and read the item (by two finger swipe down). More...
 
virtual bool AccessibilityActionPageLeft ()
 Perform the accessibility action to scroll left to the previous page (by two finger swipe left). More...
 
virtual bool AccessibilityActionPageRight ()
 Perform the accessibility action to scroll right to the next page (by two finger swipe right). More...
 
virtual bool AccessibilityActionPageUp ()
 Perform the accessibility action to scroll up to the previous page (by one finger swipe left and right). More...
 
virtual bool AccessibilityActionPageDown ()
 Perform the accessibility action to scroll down to the next page (by one finger swipe right and left). More...
 
virtual bool AccessibilityActionMoveToFirst ()
 Perform the accessibility action to move the focus to the first item on the screen (by one finger swipe up and down). More...
 
virtual bool AccessibilityActionMoveToLast ()
 Perform the accessibility action to move the focus to the last item on the screen (by one finger swipe down and up). More...
 
virtual bool AccessibilityActionReadFromTop ()
 Perform the accessibility action to move the focus to the first item on the top and read from the top item continously (by three fingers single tap). More...
 
virtual bool AccessibilityActionReadFromNext ()
 Perform the accessibility action to move the focus to and read from the next item continously (by three fingers double tap). More...
 
virtual bool AccessibilityActionZoom ()
 Perform the accessibility action to move the focus to do the zooming (by one finger triple tap). More...
 
virtual bool AccessibilityActionReadIndicatorInformation ()
 Perform the accessibility action to read the information in the indicator (by two fingers triple tap). More...
 
virtual bool AccessibilityActionReadPauseResume ()
 Perform the accessibility action to pause/resume the current read out (by two fingers single tap). More...
 
virtual bool AccessibilityActionStartStop ()
 Perform the accessibility action to start/stop the current action (by two fingers double tap). More...
 
virtual bool AccessibilityActionTouch (const TouchEvent &touchEvent)
 Perform the accessibility action to mouse move (by one finger tap & hold and move). More...
 
void TtsStateChanged (const Dali::TtsPlayer::State previousState, const Dali::TtsPlayer::State currentState)
 This function is connected to the TtsPlayer StateChangeSignal. More...
 
 AccessibilityManager (const AccessibilityManager &)
 
AccessibilityManageroperator= (const AccessibilityManager &rhs)
 

Private Attributes

Toolkit::AccessibilityManager::FocusChangedSignalType mFocusChangedSignal
 The signal to notify the focus change. More...
 
Toolkit::AccessibilityManager::FocusOvershotSignalType mFocusOvershotSignal
 The signal to notify the focus overshooted. More...
 
Toolkit::AccessibilityManager::FocusedActorActivatedSignalType mFocusedActorActivatedSignal
 The signal to notify the activation of focused actor. More...
 
AccessibilityActionSignalType mStatusChangedSignal
 
AccessibilityActionSignalType mActionNextSignal
 
AccessibilityActionSignalType mActionPreviousSignal
 
AccessibilityActionSignalType mActionActivateSignal
 
AccessibilityActionSignalType mActionOverSignal
 
AccessibilityActionSignalType mActionReadSignal
 
AccessibilityActionSignalType mActionReadNextSignal
 
AccessibilityActionSignalType mActionReadPreviousSignal
 
AccessibilityActionSignalType mActionUpSignal
 
AccessibilityActionSignalType mActionDownSignal
 
AccessibilityActionSignalType mActionClearFocusSignal
 
AccessibilityActionSignalType mActionBackSignal
 
AccessibilityActionSignalType mActionScrollUpSignal
 
AccessibilityActionSignalType mActionScrollDownSignal
 
AccessibilityActionSignalType mActionPageLeftSignal
 
AccessibilityActionSignalType mActionPageRightSignal
 
AccessibilityActionSignalType mActionPageUpSignal
 
AccessibilityActionSignalType mActionPageDownSignal
 
AccessibilityActionSignalType mActionMoveToFirstSignal
 
AccessibilityActionSignalType mActionMoveToLastSignal
 
AccessibilityActionSignalType mActionReadFromTopSignal
 
AccessibilityActionSignalType mActionReadFromNextSignal
 
AccessibilityActionSignalType mActionZoomSignal
 
AccessibilityActionSignalType mActionReadIndicatorInformationSignal
 
AccessibilityActionSignalType mActionReadPauseResumeSignal
 
AccessibilityActionSignalType mActionStartStopSignal
 
AccessibilityActionScrollSignalType mActionScrollSignal
 
FocusIDContainer mFocusIDContainer
 The container to look up actor ID by focus order. More...
 
IDAdditionalInfoContainer mIDAdditionalInfoContainer
 The container to look up additional information by actor ID. More...
 
FocusIDPair mCurrentFocusActor
 The focus order and actor ID of current focused actor. More...
 
Actor mCurrentGesturedActor
 The actor that will handle the gesture. More...
 
Actor mFocusIndicatorActor
 The focus indicator actor shared by all the focusable actors for highlight. More...
 
Vector2 mPreviousPosition
 The previous pan position; useful for calculating velocity for Gesture::Finished events. More...
 
unsigned int mRecursiveFocusMoveCounter
 The counter to count the number of recursive focus movement attempted before the focus movement is successful. More...
 
bool mIsWrapped:1
 Whether the focus movement is wrapped around or not. More...
 
bool mIsFocusWithinGroup:1
 Whether the focus movement is limited to the current focus group or not. More...
 
bool mIsEndcapFeedbackEnabled:1
 Whether the endcap feedback need to be played when the focus leaves the end or vice versa. More...
 
bool mIsEndcapFeedbackPlayed:1
 Whether the endcap feedback was played or not. More...
 
bool mIsAccessibilityTtsEnabled:1
 Whether accessibility feature(screen-reader) turned on/off. More...
 
bool mTtsCreated:1
 Whether the TTS Player has been accessed. More...
 
bool mIsFocusIndicatorEnabled:1
 Whether indicator should be shown / hidden. It could be enabled when TTS enabled or 'Tab' key operated. More...
 
bool mContinuousPlayMode:1
 Keeps track of whether or not we are in continuous play mode. More...
 

Detailed Description

Manages registration of actors in an accessibility focus chain and changing the focused actor within that chain.

This class provides the functionality of registering the focus order and description of actors and maintaining the focus chain.

It provides functionality of setting the focus and moving the focus forward and backward. It also draws a highlight for the focused actor and emits a signal when the focus is changed.

Signals

Signal Name Method
focusChanged FocusChangedSignal()
focusOvershot FocusOvershotSignal()
focusedActorActivated FocusedActorActivatedSignal()

.0

Definition at line 47 of file accessibility-manager-impl.h.

Member Typedef Documentation

Definition at line 52 of file accessibility-manager-impl.h.

Definition at line 51 of file accessibility-manager-impl.h.

typedef FocusIDContainer::const_iterator Dali::Toolkit::Internal::AccessibilityManager::FocusIDConstIter

Definition at line 69 of file accessibility-manager-impl.h.

typedef std::map<unsigned int, unsigned int> Dali::Toolkit::Internal::AccessibilityManager::FocusIDContainer

Definition at line 67 of file accessibility-manager-impl.h.

Definition at line 68 of file accessibility-manager-impl.h.

typedef std::pair<unsigned int, unsigned int> Dali::Toolkit::Internal::AccessibilityManager::FocusIDPair

Definition at line 66 of file accessibility-manager-impl.h.

typedef IDAdditionalInfoContainer::const_iterator Dali::Toolkit::Internal::AccessibilityManager::IDAdditionalInfoConstIter

Definition at line 74 of file accessibility-manager-impl.h.

Definition at line 72 of file accessibility-manager-impl.h.

typedef IDAdditionalInfoContainer::iterator Dali::Toolkit::Internal::AccessibilityManager::IDAdditionalInfoIter

Definition at line 73 of file accessibility-manager-impl.h.

Definition at line 71 of file accessibility-manager-impl.h.

Constructor & Destructor Documentation

Dali::Toolkit::Internal::AccessibilityManager::AccessibilityManager ( )

Construct a new AccessibilityManager.

Definition at line 109 of file accessibility-manager-impl.cpp.

Dali::Toolkit::Internal::AccessibilityManager::~AccessibilityManager ( )
protectedvirtual

Destructor.

Definition at line 124 of file accessibility-manager-impl.cpp.

Dali::Toolkit::Internal::AccessibilityManager::AccessibilityManager ( const AccessibilityManager )
private

Member Function Documentation

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionActivate ( )
privatevirtual

Perform the accessibility action to activate the current focused actor (by one finger double tap).

Returns
whether the accessibility action is performed or not.

Definition at line 766 of file accessibility-manager-impl.cpp.

References DoActivate(), GetCurrentFocusActor(), and mActionActivateSignal.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionBack ( )
privatevirtual

Perform the accessibility action to navigate back (by two fingers circle draw).

Returns
whether the accessibility action is performed or not.

Definition at line 949 of file accessibility-manager-impl.cpp.

References mActionBackSignal, and mIsAccessibilityTtsEnabled.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionDown ( )
privatevirtual

Perform the accessibility action to change the value when the current focused actor is a slider (by double finger down and move down and left).

Returns
whether the accessibility action is performed or not.

Definition at line 892 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), Dali::Toolkit::Internal::GetImplementation(), mActionDownSignal, mIsAccessibilityTtsEnabled, and Dali::Toolkit::Internal::Control::OnAccessibilityValueChange().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionMoveToFirst ( )
privatevirtual

Perform the accessibility action to move the focus to the first item on the screen (by one finger swipe up and down).

Returns
whether the accessibility action is performed or not.

Definition at line 1124 of file accessibility-manager-impl.cpp.

References mActionMoveToFirstSignal, and mIsAccessibilityTtsEnabled.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionMoveToLast ( )
privatevirtual

Perform the accessibility action to move the focus to the last item on the screen (by one finger swipe down and up).

Returns
whether the accessibility action is performed or not.

Definition at line 1137 of file accessibility-manager-impl.cpp.

References mActionMoveToLastSignal, and mIsAccessibilityTtsEnabled.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionNext ( bool  allowEndFeedback)
privatevirtual

Perform the accessibility action to move focus to the next focusable actor (by one finger flick down).

Parameters
allowEndFeedbacktrue if end of list feedback should be played when the focus is alread reached to the end
Returns
whether the accessibility action is performed or not.

Definition at line 728 of file accessibility-manager-impl.cpp.

References mActionNextSignal, mIsAccessibilityTtsEnabled, mIsEndcapFeedbackEnabled, and MoveFocusForward().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageDown ( )
privatevirtual

Perform the accessibility action to scroll down to the next page (by one finger swipe right and left).

Returns
whether the accessibility action is performed or not.

Definition at line 1097 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), mActionPageDownSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageLeft ( )
privatevirtual

Perform the accessibility action to scroll left to the previous page (by two finger swipe left).

Returns
whether the accessibility action is performed or not.

Definition at line 1016 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), mActionPageLeftSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageRight ( )
privatevirtual

Perform the accessibility action to scroll right to the next page (by two finger swipe right).

Returns
whether the accessibility action is performed or not.

Definition at line 1043 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), mActionPageRightSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageUp ( )
privatevirtual

Perform the accessibility action to scroll up to the previous page (by one finger swipe left and right).

Returns
whether the accessibility action is performed or not.

Definition at line 1070 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), mActionPageUpSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPrevious ( bool  allowEndFeedback)
privatevirtual

Perform the accessibility action to move focus to the previous focusable actor (by one finger flick up).

Parameters
allowEndFeedbacktrue if end of list feedback should be played when the focus is alread reached to the end
Returns
whether the accessibility action is performed or not.

Definition at line 747 of file accessibility-manager-impl.cpp.

References mActionPreviousSignal, mIsAccessibilityTtsEnabled, mIsEndcapFeedbackEnabled, and MoveFocusBackward().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionRead ( bool  allowReadAgain)
privatevirtual

Perform the accessibility action to focus and read the actor (by one finger tap or move).

Parameters
allowReadAgaintrue if the action read again the same object (i.e. read action) false if the action just read when the focus object is changed (i.e. over action)
Returns
whether the accessibility action is performed or not.

Definition at line 786 of file accessibility-manager-impl.cpp.

References Dali::HitTestAlgorithm::Results::actor, DALI_LOG_INFO, Dali::AccessibilityAdaptor::Get(), Dali::Stage::GetCurrent(), GetCurrentFocusActor(), GetFocusOrder(), Dali::AccessibilityAdaptor::GetReadPosition(), Dali::HitTestAlgorithm::HitTest(), Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::IsActorFocusableFunction(), mActionOverSignal, mActionReadSignal, mFocusIDContainer, mIsAccessibilityTtsEnabled, and SetCurrentFocusActor().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionReadFromNext ( )
privatevirtual

Perform the accessibility action to move the focus to and read from the next item continously (by three fingers double tap).

Returns
whether the accessibility action is performed or not.

Definition at line 1163 of file accessibility-manager-impl.cpp.

References mActionReadFromNextSignal, mContinuousPlayMode, mIsAccessibilityTtsEnabled, and MoveFocusForward().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionReadFromTop ( )
privatevirtual

Perform the accessibility action to move the focus to the first item on the top and read from the top item continously (by three fingers single tap).

Returns
whether the accessibility action is performed or not.

Definition at line 1150 of file accessibility-manager-impl.cpp.

References mActionReadFromTopSignal, and mIsAccessibilityTtsEnabled.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionReadIndicatorInformation ( )
privatevirtual

Perform the accessibility action to read the information in the indicator (by two fingers triple tap).

Returns
whether the accessibility action is performed or not.

Definition at line 1234 of file accessibility-manager-impl.cpp.

References mActionReadIndicatorInformationSignal, and mIsAccessibilityTtsEnabled.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionReadNext ( bool  allowEndFeedback)
privatevirtual

Perform the accessibility action to move focus to the next focusable actor (by one finger flick right).

Parameters
allowEndFeedbacktrue if end of list feedback should be played when the focus is alread reached to the end
Returns
whether the accessibility action is performed or not.

Definition at line 829 of file accessibility-manager-impl.cpp.

References mActionReadNextSignal, mIsAccessibilityTtsEnabled, and MoveFocusForward().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionReadPauseResume ( )
privatevirtual

Perform the accessibility action to pause/resume the current read out (by two fingers single tap).

Returns
whether the accessibility action is performed or not.

Definition at line 1247 of file accessibility-manager-impl.cpp.

References Dali::TtsPlayer::Get(), Dali::TtsPlayer::GetState(), mActionReadPauseResumeSignal, mIsAccessibilityTtsEnabled, Dali::TtsPlayer::Pause(), Dali::TtsPlayer::PAUSED, Dali::TtsPlayer::PLAYING, Dali::TtsPlayer::Resume(), and Dali::TtsPlayer::SCREEN_READER.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionReadPrevious ( bool  allowEndFeedback)
privatevirtual

Perform the accessibility action to move focus to the previous focusable actor (by one finger flick left).

Parameters
allowEndFeedbacktrue if end of list feedback should be played when the focus is alread reached to the end
Returns
whether the accessibility action is performed or not.

Definition at line 847 of file accessibility-manager-impl.cpp.

References mActionReadPreviousSignal, mIsAccessibilityTtsEnabled, and MoveFocusBackward().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionScroll ( Dali::TouchEvent touchEvent)
privatevirtual

Perform the accessibility action associated with a scroll event.

Parameters
touchEventThe touch point (and time) of the event.
Returns
whether the focus is cleared or not.

Definition at line 938 of file accessibility-manager-impl.cpp.

References mActionScrollSignal.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionScrollDown ( )
privatevirtual

Perform the accessibility action to scroll down the list and focus on the first item on the list after the scrolling and read the item (by two finger swipe down).

Returns
whether the accessibility action is performed or not.

Definition at line 989 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), mActionScrollDownSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionScrollUp ( )
privatevirtual

Perform the accessibility action to scroll up the list and focus on the first item on the list after the scrolling and read the item (by two finger swipe up).

Returns
whether the accessibility action is performed or not.

Definition at line 962 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), mActionScrollUpSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionStartStop ( )
privatevirtual

Perform the accessibility action to start/stop the current action (by two fingers double tap).

Returns
whether the accessibility action is performed or not.

Definition at line 1277 of file accessibility-manager-impl.cpp.

References mActionStartStopSignal, and mIsAccessibilityTtsEnabled.

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionTouch ( const TouchEvent touchEvent)
privatevirtual

Perform the accessibility action to mouse move (by one finger tap & hold and move).

Parameters
touchEventtouch event structure
Returns
whether the accessibility action is performed or not.

Definition at line 1290 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::OnAccessibilityTouch().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionUp ( )
privatevirtual

Perform the accessibility action to change the value when the current focused actor is a slider (by double finger down and move up and right).

Returns
whether the accessibility action is performed or not.

Definition at line 865 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), Dali::Toolkit::Internal::GetImplementation(), mActionUpSignal, mIsAccessibilityTtsEnabled, and Dali::Toolkit::Internal::Control::OnAccessibilityValueChange().

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionZoom ( )
privatevirtual

Perform the accessibility action to move the focus to do the zooming (by one finger triple tap).

Returns
whether the accessibility action is performed or not.

Definition at line 1207 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Control::DownCast(), GetCurrentFocusActor(), Dali::Toolkit::Internal::GetImplementation(), mActionZoomSignal, mIsAccessibilityTtsEnabled, and Dali::Toolkit::Internal::Control::OnAccessibilityZoom().

Here is the call graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionActivateSignal ( )
inline

This is emitted when accessibility action is received to activate the current focused actor (by one finger double tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 263 of file accessibility-manager-impl.h.

References mActionActivateSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionActivateSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionBackSignal ( )
inline

This is emitted when accessibility action is received to navigate back (by two fingers circle draw).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 327 of file accessibility-manager-impl.h.

References mActionBackSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionBackSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionClearFocusSignal ( )
inline

This is emitted when accessibility action is received to clear the focus from the current focused actor if any, so that no actor is focused in the focus chain.

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 319 of file accessibility-manager-impl.h.

References mActionClearFocusSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionClearFocusSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionDownSignal ( )
inline

This is emitted when accessibility action is received to change the value when the current focused actor is a slider (by double finger down and move down and left).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 311 of file accessibility-manager-impl.h.

References mActionDownSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionDownSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionMoveToFirstSignal ( )
inline

This is emitted when accessibility action is received to move the focus to the first item on the screen (by one finger swipe up and down).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 383 of file accessibility-manager-impl.h.

References mActionMoveToFirstSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionMoveToFirstSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionMoveToLastSignal ( )
inline

This is emitted when accessibility action is received to move the focus to the last item on the screen (by one finger swipe down and up).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 391 of file accessibility-manager-impl.h.

References mActionMoveToLastSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionMoveToLastSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionNextSignal ( )
inline

Definition at line 247 of file accessibility-manager-impl.h.

References mActionNextSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionNextSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionOverSignal ( )
inline

This is emitted when accessibility action is received to focus and read the actor (by one finger move).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 271 of file accessibility-manager-impl.h.

References mActionOverSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionOverSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionPageDownSignal ( )
inline

This is emitted when accessibility action is received to scroll down to the next page (by one finger swipe right and left).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 375 of file accessibility-manager-impl.h.

References mActionPageDownSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionPageDownSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionPageLeftSignal ( )
inline

This is emitted when accessibility action is received to scroll left to the previous page (by two finger swipe left).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 351 of file accessibility-manager-impl.h.

References mActionPageLeftSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionPageLeftSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionPageRightSignal ( )
inline

This is emitted when accessibility action is received to scroll right to the next page (by two finger swipe right).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 359 of file accessibility-manager-impl.h.

References mActionPageRightSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionPageRightSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionPageUpSignal ( )
inline

This is emitted when accessibility action is received to scroll up to the previous page (by one finger swipe left and right).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 367 of file accessibility-manager-impl.h.

References mActionPageUpSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionPageUpSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionPreviousSignal ( )
inline

This is emitted when accessibility action is received to move focus to the previous focusable actor (by one finger flick up).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 255 of file accessibility-manager-impl.h.

References mActionPreviousSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionPreviousSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadFromNextSignal ( )
inline

This is emitted when accessibility action is received to move the focus to and read from the next item continously (by three fingers double tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 407 of file accessibility-manager-impl.h.

References mActionReadFromNextSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadFromNextSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadFromTopSignal ( )
inline

This is emitted when accessibility action is received to focus and read from the first item on the top continously (by three fingers single tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 399 of file accessibility-manager-impl.h.

References mActionReadFromTopSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadFromTopSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadIndicatorInformationSignal ( )
inline

This is emitted when accessibility action is received to read the information in the indicator (by two fingers triple tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 423 of file accessibility-manager-impl.h.

References mActionReadIndicatorInformationSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadIndicatorInformationSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadNextSignal ( )
inline

This is emitted when accessibility action is received to move focus to the next focusable actor (by one finger flick right).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 287 of file accessibility-manager-impl.h.

References mActionReadNextSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadNextSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadPauseResumeSignal ( )
inline

This is emitted when accessibility action is received to pause/resume the current speech (by two fingers single tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 431 of file accessibility-manager-impl.h.

References mActionReadPauseResumeSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadPauseResumeSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadPreviousSignal ( )
inline

This is emitted when accessibility action is received to move focus to the previous focusable actor (by one finger flick left).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 295 of file accessibility-manager-impl.h.

References mActionReadPreviousSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadPreviousSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionReadSignal ( )
inline

This is emitted when accessibility action is received to focus and read the actor (by one finger tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 279 of file accessibility-manager-impl.h.

References mActionReadSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionReadSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionScrollDownSignal ( )
inline

This is emitted when accessibility action is received to scroll down the list (by two finger swipe down).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 343 of file accessibility-manager-impl.h.

References mActionScrollDownSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionScrollDownSignal().

Here is the caller graph for this function:

AccessibilityActionScrollSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionScrollSignal ( )
inline

This is emitted when accessibility action is received to handle scroll event (by two fingers drag).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager, const TouchEvent& event );

.0

Returns
The signal to connect to.

Definition at line 447 of file accessibility-manager-impl.h.

References mActionScrollSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionScrollSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionScrollUpSignal ( )
inline

This is emitted when accessibility action is received to scroll up the list (by two finger swipe up).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 335 of file accessibility-manager-impl.h.

References mActionScrollUpSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionScrollUpSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionStartStopSignal ( )
inline

This is emitted when accessibility action is received to start/stop the current action (by two fingers double tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 439 of file accessibility-manager-impl.h.

References mActionStartStopSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionStartStopSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionUpSignal ( )
inline

This is emitted when accessibility action is received to change the value when the current focused actor is a slider (by double finger down and move up and right).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 303 of file accessibility-manager-impl.h.

References mActionUpSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionUpSignal().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::ActionZoomSignal ( )
inline

This is emitted when accessibility action is received to zoom (by one finger triple tap).

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 415 of file accessibility-manager-impl.h.

References mActionZoomSignal.

Referenced by Dali::Toolkit::AccessibilityManager::ActionZoomSignal().

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::ChangeAccessibilityStatus ( )
privatevirtual

Change the accessibility status when Accessibility feature(screen-reader) turned on or off.

Returns
whether the status is changed or not.

Definition at line 680 of file accessibility-manager-impl.cpp.

References Dali::Actor::Add(), Dali::AccessibilityAdaptor::Get(), Dali::TtsPlayer::Get(), GetCurrentFocusActor(), Dali::AccessibilityAdaptor::IsEnabled(), mFocusIndicatorActor, mIsAccessibilityTtsEnabled, mIsFocusIndicatorEnabled, mStatusChangedSignal, mTtsCreated, Dali::Actor::Remove(), Dali::TtsPlayer::SCREEN_READER, Dali::TtsPlayer::StateChangedSignal(), and TtsStateChanged().

Referenced by Initialise().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::ClearAccessibilityFocus ( )
privatevirtual

Clear the accessibility focus from the current focused actor.

Returns
whether the focus is cleared or not.

Definition at line 919 of file accessibility-manager-impl.cpp.

References ClearFocus(), mActionClearFocusSignal, and mIsAccessibilityTtsEnabled.

Here is the call graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::ClearFocus ( )

Clear the focus from the current focused actor if any, so that no actor is focused in the focus chain.

It will emit focus changed signal without current focused actor. .0

Precondition
The AccessibilityManager has been initialized.

Definition at line 479 of file accessibility-manager-impl.cpp.

References Dali::TtsPlayer::Get(), GetCurrentFocusActor(), mCurrentFocusActor, mFocusChangedSignal, mFocusIndicatorActor, mIsAccessibilityTtsEnabled, Dali::Actor::Remove(), Dali::TtsPlayer::SCREEN_READER, and Dali::TtsPlayer::Stop().

Referenced by ClearAccessibilityFocus(), Dali::Toolkit::KeyboardFocusManager::ClearFocus(), Dali::Toolkit::AccessibilityManager::ClearFocus(), Reset(), and SetFocusOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::CreateDefaultFocusIndicatorActor ( )
private
void Dali::Toolkit::Internal::AccessibilityManager::DoActivate ( Actor  actor)
private

Activate the actor.

If the actor is control, call OnAccessibilityActivated virtual function. This function will emit FocusedActorActivatedSignal.

Parameters
actorThe actor to activate

Definition at line 463 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Internal::Control::AccessibilityActivate(), Dali::Toolkit::Control::DownCast(), Dali::Toolkit::Internal::GetImplementation(), and mFocusedActorActivatedSignal.

Referenced by AccessibilityActionActivate().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::DoConnectSignal ( BaseObject object,
ConnectionTrackerInterface tracker,
const std::string &  signalName,
FunctorDelegate functor 
)
static

Connects a callback function with the object's signals.

Parameters
[in]objectThe object providing the signal.
[in]trackerUsed to disconnect the signal.
[in]signalNameThe signal to connect to.
[in]functorA newly allocated FunctorDelegate.
Returns
True if the signal was connected.
Postcondition
If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.

Definition at line 1397 of file accessibility-manager-impl.cpp.

References FocusChangedSignal(), FocusedActorActivatedSignal(), FocusOvershotSignal(), Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::SIGNAL_FOCUS_CHANGED, Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::SIGNAL_FOCUS_OVERSHOT, and Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::SIGNAL_FOCUSED_ACTOR_ACTIVATED.

Here is the call graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::DoMoveFocus ( FocusIDIter  focusIDIter,
bool  forward,
bool  wrapped 
)
private

Move the focus to the next actor in the focus chain towards the specified direction.

Parameters
focusIDIterThe iterator pointing to the current focused actor
forwardWhether the focus movement is forward or not. The focus movement will be backward if this is false.
wrappedWhether the focus shoule be moved wrapped around or not
Returns
Whether the focus is successful or not

Definition at line 580 of file accessibility-manager-impl.cpp.

References DALI_LOG_INFO, DALI_LOG_WARNING, DoSetCurrentFocusActor(), Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::FOCUS_CHAIN_END_SOUND_FILE, Dali::PropertyTypes::Get(), GetCurrentFocusActor(), mFocusIDContainer, mFocusOvershotSignal, mIsEndcapFeedbackEnabled, mIsEndcapFeedbackPlayed, mRecursiveFocusMoveCounter, Dali::Toolkit::AccessibilityManager::OVERSHOT_NEXT, and Dali::Toolkit::AccessibilityManager::OVERSHOT_PREVIOUS.

Referenced by MoveFocusBackward(), and MoveFocusForward().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::DoSetCurrentFocusActor ( const unsigned int  actorID)
private
Toolkit::AccessibilityManager::FocusChangedSignalType & Dali::Toolkit::Internal::AccessibilityManager::FocusChangedSignal ( )

This signal is emitted when the current focused actor is changed.

A callback of the following type may be connected:

void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);

.0

Returns
The signal to connect to.
Precondition
The Object has been initialized.

Definition at line 1382 of file accessibility-manager-impl.cpp.

References mFocusChangedSignal.

Referenced by DoConnectSignal(), Dali::Toolkit::KeyboardFocusManager::FocusChangedSignal(), and Dali::Toolkit::AccessibilityManager::FocusChangedSignal().

Here is the caller graph for this function:

Toolkit::AccessibilityManager::FocusedActorActivatedSignalType & Dali::Toolkit::Internal::AccessibilityManager::FocusedActorActivatedSignal ( )

This signal is emitted when the current focused actor is activated.

A callback of the following type may be connected:

void YourCallbackName(Actor activatedActor);

.0

Returns
The signal to connect to.
Precondition
The Object has been initialized.

Definition at line 1392 of file accessibility-manager-impl.cpp.

References mFocusedActorActivatedSignal.

Referenced by DoConnectSignal(), and Dali::Toolkit::AccessibilityManager::FocusedActorActivatedSignal().

Here is the caller graph for this function:

Toolkit::AccessibilityManager::FocusOvershotSignalType & Dali::Toolkit::Internal::AccessibilityManager::FocusOvershotSignal ( )

This signal is emitted when there is no way to move focus further.

A callback of the following type may be connected:

void YourCallbackName(Actor currentFocusedActor, FocusOvershotDirection direction);

.0

Returns
The signal to connect to.
Precondition
The Object has been initialized.

Definition at line 1387 of file accessibility-manager-impl.cpp.

References mFocusOvershotSignal.

Referenced by DoConnectSignal(), and Dali::Toolkit::AccessibilityManager::FocusOvershotSignal().

Here is the caller graph for this function:

unsigned int Dali::Toolkit::Internal::AccessibilityManager::GenerateNewFocusOrder ( ) const

Generates a new focus order number which can be used to assign to actors which need to be appended to the end of the current focus order chain.

The new number will be an increment over the very last focus order number in the focus chain. If the focus chain is empty then the function returns 1, else the number returned will be FOLast + 1 where FOLast is the focus order of the very last control in the focus chain.

.0

Returns
The focus order of the actor
Precondition
The AccessibilityManager has been initialized.

Definition at line 262 of file accessibility-manager-impl.cpp.

References mFocusIDContainer.

Referenced by Dali::Toolkit::AccessibilityManager::GenerateNewFocusOrder().

Here is the caller graph for this function:

std::string Dali::Toolkit::Internal::AccessibilityManager::GetAccessibilityAttribute ( Actor  actor,
Toolkit::AccessibilityManager::AccessibilityAttribute  type 
) const

Get the text of the specified actor's accessibility attribute.

.0

Parameters
actorThe actor to be queried
typeThe attribute type to be queried
Returns
The text of the actor's accessibility information
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 173 of file accessibility-manager-impl.cpp.

References GetActorAdditionalInfo(), Dali::Actor::GetId(), and Dali::Toolkit::Internal::AccessibilityManager::ActorAdditionalInfo::mAccessibilityAttributes.

Referenced by Dali::Toolkit::AccessibilityManager::GetAccessibilityAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

AccessibilityManager::ActorAdditionalInfo Dali::Toolkit::Internal::AccessibilityManager::GetActorAdditionalInfo ( const unsigned int  actorID) const
private

Get the additional information (e.g.

focus order and description) of the given actor.

Parameters
actorIDThe ID of the actor to be queried
Returns
The additional information of the actor

Definition at line 139 of file accessibility-manager-impl.cpp.

References mIDAdditionalInfoContainer.

Referenced by DoSetCurrentFocusActor(), GetAccessibilityAttribute(), GetFocusOrder(), SetAccessibilityAttribute(), and SynchronizeActorAdditionalInfo().

Here is the caller graph for this function:

Actor Dali::Toolkit::Internal::AccessibilityManager::GetActorByFocusOrder ( const unsigned int  order)

Get the actor that has the specified focus order.

It will return an empty handle if no actor in the stage has the specified focus order.

.0

Parameters
orderThe focus order of the actor
Returns
The actor that has the specified focus order or an empty handle if no actor in the stage has the specified focus order.
Precondition
The AccessibilityManager has been initialized.

Definition at line 275 of file accessibility-manager-impl.cpp.

References Dali::Actor::FindChildById(), Dali::Stage::GetCurrent(), Dali::Stage::GetRootLayer(), and mFocusIDContainer.

Referenced by Dali::Toolkit::AccessibilityManager::GetActorByFocusOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

Actor Dali::Toolkit::Internal::AccessibilityManager::GetCurrentFocusActor ( )
Actor Dali::Toolkit::Internal::AccessibilityManager::GetCurrentFocusGroup ( )

Get the focus group of current focused actor.

.0

Returns
A handle to the immediate parent of the current focused actor which is also a focus group, or an empty handle if no actor is focused.
Precondition
The AccessibilityManager has been initialized.

Definition at line 396 of file accessibility-manager-impl.cpp.

References GetCurrentFocusActor(), and GetFocusGroup().

Referenced by Dali::Toolkit::AccessibilityManager::GetCurrentFocusGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

unsigned int Dali::Toolkit::Internal::AccessibilityManager::GetCurrentFocusOrder ( )

Get the focus order of currently focused actor.

.0

Returns
The focus order of the currently focused actor or 0 if no actor is in focus.
Precondition
The AccessibilityManager has been initialized.

Definition at line 401 of file accessibility-manager-impl.cpp.

References mCurrentFocusActor.

Referenced by Dali::Toolkit::AccessibilityManager::GetCurrentFocusOrder().

Here is the caller graph for this function:

Actor Dali::Toolkit::Internal::AccessibilityManager::GetFocusGroup ( Actor  actor)

Returns the closest ancestor of the given actor that is a focus group.

.0

Parameters
actorThe actor to be checked for its focus group
Returns
The focus group the given actor belongs to or an empty handle if the given actor doesn't belong to any focus group

Definition at line 533 of file accessibility-manager-impl.cpp.

References Dali::Actor::GetParent(), and IsFocusGroup().

Referenced by DoSetCurrentFocusActor(), GetCurrentFocusGroup(), Dali::Toolkit::KeyboardFocusManager::GetFocusGroup(), and Dali::Toolkit::AccessibilityManager::GetFocusGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

Actor Dali::Toolkit::Internal::AccessibilityManager::GetFocusIndicatorActor ( )

Get the focus indicator actor.

.0

Returns
A handle to the focus indicator actor
Precondition
The AccessibilityManager has been initialized.

Definition at line 575 of file accessibility-manager-impl.cpp.

References mFocusIndicatorActor.

Referenced by Dali::Toolkit::KeyboardFocusManager::GetFocusIndicatorActor(), and Dali::Toolkit::AccessibilityManager::GetFocusIndicatorActor().

Here is the caller graph for this function:

unsigned int Dali::Toolkit::Internal::AccessibilityManager::GetFocusOrder ( Actor  actor) const

Get the focus order of the actor.

When the focus order is 0, it means the focus order of the actor is undefined.

.0

Parameters
actorThe actor to be queried
Returns
The focus order of the actor
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 249 of file accessibility-manager-impl.cpp.

References GetActorAdditionalInfo(), Dali::Actor::GetId(), and Dali::Toolkit::Internal::AccessibilityManager::ActorAdditionalInfo::mFocusOrder.

Referenced by AccessibilityActionRead(), DoSetCurrentFocusActor(), Dali::Toolkit::AccessibilityManager::GetFocusOrder(), and SetFocusOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::GetGroupMode ( ) const

Get whether the group mode is enabled or not.

.0

Returns
Whether the group mode is enabled or not.
Precondition
The AccessibilityManager has been initialized.

Definition at line 555 of file accessibility-manager-impl.cpp.

References mIsFocusWithinGroup.

Referenced by Dali::Toolkit::AccessibilityManager::GetGroupMode().

Here is the caller graph for this function:

Vector2 Dali::Toolkit::Internal::AccessibilityManager::GetReadPosition ( ) const

Returns the current position of the read action.

.0

Returns
The current event position.

Definition at line 544 of file accessibility-manager-impl.cpp.

References Dali::AccessibilityAdaptor::Get(), and Dali::AccessibilityAdaptor::GetReadPosition().

Referenced by Dali::Toolkit::AccessibilityManager::GetReadPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::GetWrapMode ( ) const

Get whether the wrap mode is enabled or not.

.0

Returns
Whether the wrap mode is enabled or not.
Precondition
The AccessibilityManager has been initialized.

Definition at line 565 of file accessibility-manager-impl.cpp.

References mIsWrapped.

Referenced by Dali::Toolkit::AccessibilityManager::GetWrapMode().

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::HandlePanGesture ( const Integration::PanGestureEvent &  panEvent)
privatevirtual
void Dali::Toolkit::Internal::AccessibilityManager::Initialise ( )
bool Dali::Toolkit::Internal::AccessibilityManager::IsFocusGroup ( Actor  actor) const

Check whether the actor is set as a focus group or not.

.0

Parameters
actorThe actor to be checked.
Returns
Whether the actor is set as a focus group.
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 516 of file accessibility-manager-impl.cpp.

References Dali::Handle::GetProperty(), Dali::Handle::GetPropertyIndex(), Dali::Property::INVALID_INDEX, and Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::IS_FOCUS_GROUP().

Referenced by GetFocusGroup(), Dali::Toolkit::KeyboardFocusManager::IsFocusGroup(), and Dali::Toolkit::AccessibilityManager::IsFocusGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::MoveFocusBackward ( )

Move the focus to the previous focusable actor in the focus chain (according to the focus traversal order).

When the focus movement is wrapped around, the focus will be moved to the last focusable actor when it reaches the beginning of the focus chain.

.0

Returns
true if the moving was successful
Precondition
The AccessibilityManager has been initialized.

Definition at line 434 of file accessibility-manager-impl.cpp.

References DALI_LOG_INFO, DoMoveFocus(), DoSetCurrentFocusActor(), mCurrentFocusActor, mFocusIDContainer, mIsWrapped, and mRecursiveFocusMoveCounter.

Referenced by AccessibilityActionPrevious(), AccessibilityActionReadPrevious(), and Dali::Toolkit::AccessibilityManager::MoveFocusBackward().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::MoveFocusForward ( )

Move the focus to the next focusable actor in the focus chain (according to the focus traversal order).

When the focus movement is wrapped around, the focus will be moved to the first focusable actor when it reaches the end of the focus chain.

.0

Returns
true if the moving was successful
Precondition
The AccessibilityManager has been initialized.

Definition at line 406 of file accessibility-manager-impl.cpp.

References DALI_LOG_INFO, DoMoveFocus(), DoSetCurrentFocusActor(), mCurrentFocusActor, mFocusIDContainer, mIsWrapped, and mRecursiveFocusMoveCounter.

Referenced by AccessibilityActionNext(), AccessibilityActionReadFromNext(), AccessibilityActionReadNext(), Dali::Toolkit::AccessibilityManager::MoveFocusForward(), and TtsStateChanged().

Here is the call graph for this function:

Here is the caller graph for this function:

AccessibilityManager& Dali::Toolkit::Internal::AccessibilityManager::operator= ( const AccessibilityManager rhs)
private
void Dali::Toolkit::Internal::AccessibilityManager::Reset ( )

Clear the every registered focusable actor from focus-manager.

.0

Precondition
The AccessibilityManager has been initialized.

Definition at line 500 of file accessibility-manager-impl.cpp.

References ClearFocus(), mFocusIDContainer, and mIDAdditionalInfoContainer.

Referenced by Dali::Toolkit::AccessibilityManager::Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetAccessibilityAttribute ( Actor  actor,
Toolkit::AccessibilityManager::AccessibilityAttribute  type,
const std::string &  text 
)

Set the information of the specified actor's accessibility attribute.

.0

Parameters
actorThe actor the text to be set with
typeThe attribute type the text to be set with
textThe text for the actor's accessibility information
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 159 of file accessibility-manager-impl.cpp.

References GetActorAdditionalInfo(), Dali::Actor::GetId(), Dali::Toolkit::Internal::AccessibilityManager::ActorAdditionalInfo::mAccessibilityAttributes, and mIDAdditionalInfoContainer.

Referenced by Dali::Toolkit::AccessibilityManager::SetAccessibilityAttribute().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Internal::AccessibilityManager::SetCurrentFocusActor ( Actor  actor)

Move the focus to the specified actor.

Only one actor can be focused at the same time. The actor must have a defined focus order and must be focusable, visible and in the stage.

.0

Parameters
actorThe actor to be focused
Returns
Whether the focus is successful or not
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 289 of file accessibility-manager-impl.cpp.

References DoSetCurrentFocusActor(), and Dali::Actor::GetId().

Referenced by AccessibilityActionRead(), Dali::Toolkit::KeyboardFocusManager::SetCurrentFocusActor(), and Dali::Toolkit::AccessibilityManager::SetCurrentFocusActor().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetFocusable ( Actor  actor,
bool  focusable 
)
private

Set whether the actor is focusable or not.

A focusable property will be registered for the actor if not yet.

Parameters
actorThe actor to be focused
focusableWhether the actor is focusable or not

Definition at line 654 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::ACTOR_FOCUSABLE(), Dali::Property::READ_WRITE, and Dali::Handle::RegisterProperty().

Here is the call graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetFocusGroup ( Actor  actor,
bool  isFocusGroup 
)

Set whether an actor is a focus group that can limit the scope of focus movement to its child actors in the focus chain.

.0

Parameters
actorThe actor to be set as a focus group.
isFocusGroupWhether to set the actor to be a focus group or not.
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 507 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::IS_FOCUS_GROUP(), Dali::Property::READ_WRITE, and Dali::Handle::RegisterProperty().

Referenced by Dali::Toolkit::AccessibilityManager::SetFocusGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetFocusIndicatorActor ( Actor  indicator)

Set the focus indicator actor.

This will replace the default focus indicator actor in AccessibilityManager and will be added to the focused actor as a highlight.

.0

Parameters
indicatorThe indicator actor to be added
Precondition
The AccessibilityManager has been initialized.
The indicator actor has been initialized.

Definition at line 570 of file accessibility-manager-impl.cpp.

References mFocusIndicatorActor.

Referenced by CreateDefaultFocusIndicatorActor(), Dali::Toolkit::KeyboardFocusManager::SetFocusIndicatorActor(), and Dali::Toolkit::AccessibilityManager::SetFocusIndicatorActor().

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetFocusOrder ( Actor  actor,
const unsigned int  order 
)

Set the focus order of the actor.

The focus order of each actor in the focus chain is unique. If there is another actor assigned with the same focus order already, the new actor will be inserted to the focus chain with that focus order, and the focus order of the original actor and all the actors followed in the focus chain will be increased accordingly. If the focus order assigned to the actor is 0, it means that actor's focus order is undefined (e.g. the actor has a description but with no focus order being set yet) and therefore that actor is not focusable.

.0

Parameters
actorThe actor the focus order to be set with
orderThe focus order of the actor
Precondition
The AccessibilityManager has been initialized.
The Actor has been initialized.

Definition at line 186 of file accessibility-manager-impl.cpp.

References Dali::Toolkit::Internal::anonymous_namespace{accessibility-manager-impl.cpp}::ACTOR_FOCUSABLE(), ClearFocus(), GetCurrentFocusActor(), GetFocusOrder(), Dali::Actor::GetId(), mFocusIDContainer, Dali::Property::READ_WRITE, Dali::Handle::RegisterProperty(), Dali::Handle::SetProperty(), and SynchronizeActorAdditionalInfo().

Referenced by Dali::Toolkit::AccessibilityManager::SetFocusOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetGroupMode ( bool  enabled)

Set whether the group mode is enabled or not.

When the group mode is enabled, the focus movement will be limited to the child actors of the current focus group including the current focus group itself. The current focus group is the closest ancestor of the current focused actor that set as a focus group. .0

Parameters
enabledWhether the group mode is enabled or not
Precondition
The AccessibilityManager has been initialized.

Definition at line 550 of file accessibility-manager-impl.cpp.

References mIsFocusWithinGroup.

Referenced by Dali::Toolkit::AccessibilityManager::SetGroupMode().

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SetWrapMode ( bool  wrapped)

Set whether focus will be moved to the beginning of the focus chain when it reaches the end or vice versa.

When both the wrap mode and the group mode are enabled, focus will be wrapped within the current focus group. Focus will not be wrapped in default. .0

Parameters
wrappedWhether the focus movement is wrapped around or not
Precondition
The AccessibilityManager has been initialized.

Definition at line 560 of file accessibility-manager-impl.cpp.

References mIsWrapped.

Referenced by Dali::Toolkit::AccessibilityManager::SetWrapMode(), and Dali::Toolkit::ScrollView::SetWrapMode().

Here is the caller graph for this function:

AccessibilityActionSignalType& Dali::Toolkit::Internal::AccessibilityManager::StatusChangedSignal ( )
inline

This is emitted when accessibility(screen-reader) feature turned on or off.

A callback of the following type may be connected:

bool YourCallback( AccessibilityManager& manager );

.0

Returns
The signal to connect to.

Definition at line 239 of file accessibility-manager-impl.h.

References mStatusChangedSignal.

Referenced by Dali::Toolkit::AccessibilityManager::StatusChangedSignal().

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::SynchronizeActorAdditionalInfo ( const unsigned int  actorID,
const unsigned int  order 
)
private

Synchronize the actor's additional information to reflect its latest focus order.

Parameters
actorIDThe ID of the actor
orderThe focus order of the actor
Returns
The additional information of the actor

Definition at line 151 of file accessibility-manager-impl.cpp.

References GetActorAdditionalInfo(), Dali::Toolkit::Internal::AccessibilityManager::ActorAdditionalInfo::mFocusOrder, and mIDAdditionalInfoContainer.

Referenced by SetFocusOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Internal::AccessibilityManager::TtsStateChanged ( const Dali::TtsPlayer::State  previousState,
const Dali::TtsPlayer::State  currentState 
)
private

This function is connected to the TtsPlayer StateChangeSignal.

It is called when the TTS players state changes.

Parameters
previousStateThe previous state of the TTS player (for comparison)
currentStateThe current state of the TTS player

Definition at line 1184 of file accessibility-manager-impl.cpp.

References mContinuousPlayMode, MoveFocusForward(), Dali::TtsPlayer::PLAYING, and Dali::TtsPlayer::READY.

Referenced by ChangeAccessibilityStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionActivateSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionBackSignal
private

Definition at line 730 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionBack(), and ActionBackSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionClearFocusSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionDownSignal
private

Definition at line 728 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionDown(), and ActionDownSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionMoveToFirstSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionMoveToLastSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionNextSignal
private

Definition at line 720 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionNext(), and ActionNextSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionOverSignal
private

Definition at line 723 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionRead(), and ActionOverSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionPageDownSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionPageLeftSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionPageRightSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionPageUpSignal
private

Definition at line 735 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionPageUp(), and ActionPageUpSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionPreviousSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadFromNextSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadFromTopSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadIndicatorInformationSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadNextSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadPauseResumeSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadPreviousSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionReadSignal
private

Definition at line 724 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionRead(), and ActionReadSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionScrollDownSignal
private
AccessibilityActionScrollSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionScrollSignal
private

Definition at line 745 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionScroll(), and ActionScrollSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionScrollUpSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionStartStopSignal
private
AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionUpSignal
private

Definition at line 727 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionUp(), and ActionUpSignal().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mActionZoomSignal
private

Definition at line 741 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionZoom(), and ActionZoomSignal().

bool Dali::Toolkit::Internal::AccessibilityManager::mContinuousPlayMode
private

Keeps track of whether or not we are in continuous play mode.

Definition at line 762 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionReadFromNext(), and TtsStateChanged().

FocusIDPair Dali::Toolkit::Internal::AccessibilityManager::mCurrentFocusActor
private

The focus order and actor ID of current focused actor.

Definition at line 749 of file accessibility-manager-impl.h.

Referenced by ClearFocus(), DoSetCurrentFocusActor(), GetCurrentFocusActor(), GetCurrentFocusOrder(), MoveFocusBackward(), and MoveFocusForward().

Actor Dali::Toolkit::Internal::AccessibilityManager::mCurrentGesturedActor
private

The actor that will handle the gesture.

Definition at line 750 of file accessibility-manager-impl.h.

Referenced by HandlePanGesture().

Toolkit::AccessibilityManager::FocusChangedSignalType Dali::Toolkit::Internal::AccessibilityManager::mFocusChangedSignal
private

The signal to notify the focus change.

Definition at line 714 of file accessibility-manager-impl.h.

Referenced by ClearFocus(), DoSetCurrentFocusActor(), and FocusChangedSignal().

Toolkit::AccessibilityManager::FocusedActorActivatedSignalType Dali::Toolkit::Internal::AccessibilityManager::mFocusedActorActivatedSignal
private

The signal to notify the activation of focused actor.

Definition at line 716 of file accessibility-manager-impl.h.

Referenced by DoActivate(), and FocusedActorActivatedSignal().

FocusIDContainer Dali::Toolkit::Internal::AccessibilityManager::mFocusIDContainer
private
Actor Dali::Toolkit::Internal::AccessibilityManager::mFocusIndicatorActor
private

The focus indicator actor shared by all the focusable actors for highlight.

Definition at line 751 of file accessibility-manager-impl.h.

Referenced by ChangeAccessibilityStatus(), ClearFocus(), DoSetCurrentFocusActor(), GetFocusIndicatorActor(), and SetFocusIndicatorActor().

Toolkit::AccessibilityManager::FocusOvershotSignalType Dali::Toolkit::Internal::AccessibilityManager::mFocusOvershotSignal
private

The signal to notify the focus overshooted.

Definition at line 715 of file accessibility-manager-impl.h.

Referenced by DoMoveFocus(), and FocusOvershotSignal().

IDAdditionalInfoContainer Dali::Toolkit::Internal::AccessibilityManager::mIDAdditionalInfoContainer
private

The container to look up additional information by actor ID.

Definition at line 748 of file accessibility-manager-impl.h.

Referenced by GetActorAdditionalInfo(), Reset(), SetAccessibilityAttribute(), and SynchronizeActorAdditionalInfo().

bool Dali::Toolkit::Internal::AccessibilityManager::mIsAccessibilityTtsEnabled
private
bool Dali::Toolkit::Internal::AccessibilityManager::mIsEndcapFeedbackEnabled
private

Whether the endcap feedback need to be played when the focus leaves the end or vice versa.

Definition at line 757 of file accessibility-manager-impl.h.

Referenced by AccessibilityActionNext(), AccessibilityActionPrevious(), and DoMoveFocus().

bool Dali::Toolkit::Internal::AccessibilityManager::mIsEndcapFeedbackPlayed
private

Whether the endcap feedback was played or not.

Definition at line 758 of file accessibility-manager-impl.h.

Referenced by DoMoveFocus().

bool Dali::Toolkit::Internal::AccessibilityManager::mIsFocusIndicatorEnabled
private

Whether indicator should be shown / hidden. It could be enabled when TTS enabled or 'Tab' key operated.

Definition at line 761 of file accessibility-manager-impl.h.

Referenced by ChangeAccessibilityStatus(), and DoSetCurrentFocusActor().

bool Dali::Toolkit::Internal::AccessibilityManager::mIsFocusWithinGroup
private

Whether the focus movement is limited to the current focus group or not.

Definition at line 756 of file accessibility-manager-impl.h.

Referenced by DoSetCurrentFocusActor(), GetGroupMode(), and SetGroupMode().

bool Dali::Toolkit::Internal::AccessibilityManager::mIsWrapped
private

Whether the focus movement is wrapped around or not.

Definition at line 755 of file accessibility-manager-impl.h.

Referenced by GetWrapMode(), MoveFocusBackward(), MoveFocusForward(), and SetWrapMode().

Vector2 Dali::Toolkit::Internal::AccessibilityManager::mPreviousPosition
private

The previous pan position; useful for calculating velocity for Gesture::Finished events.

Definition at line 752 of file accessibility-manager-impl.h.

Referenced by HandlePanGesture().

unsigned int Dali::Toolkit::Internal::AccessibilityManager::mRecursiveFocusMoveCounter
private

The counter to count the number of recursive focus movement attempted before the focus movement is successful.

Definition at line 753 of file accessibility-manager-impl.h.

Referenced by DoMoveFocus(), MoveFocusBackward(), and MoveFocusForward().

AccessibilityActionSignalType Dali::Toolkit::Internal::AccessibilityManager::mStatusChangedSignal
private

Definition at line 719 of file accessibility-manager-impl.h.

Referenced by ChangeAccessibilityStatus(), and StatusChangedSignal().

bool Dali::Toolkit::Internal::AccessibilityManager::mTtsCreated
private

Whether the TTS Player has been accessed.

Definition at line 760 of file accessibility-manager-impl.h.

Referenced by ChangeAccessibilityStatus().


The documentation for this class was generated from the following files:
Dali Docs Home
Read more about Dali