Dali 3D User Interface Engine
List of all members | Classes | Public Types | Public Member Functions | Static Public Member Functions
Dali::Toolkit::Control Class Reference

Control is the base class for all controls. More...

#include <control.h>

Inheritance diagram for Dali::Toolkit::Control:
Inheritance graph
[legend]
Collaboration diagram for Dali::Toolkit::Control:
Collaboration graph
[legend]

Classes

struct  KeyboardFocus
 Describes the direction to move the keyboard focus towards. More...
 
struct  Property
 An enumeration of properties belonging to the Control class. More...
 

Public Types

enum  PropertyRange { PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 }
 The start and end property ranges for control. More...
 
typedef Signal< bool(Control,
const KeyEvent &) > 
KeyEventSignalType
 Key Event signal type;. More...
 
typedef Signal< void(Control) > KeyInputFocusSignalType
 Key InputFocusType signal type;. More...
 

Public Member Functions

 Control ()
 Create an uninitialized Control handle. More...
 
 Control (const Control &uiControl)
 Copy constructor. More...
 
 ~Control ()
 Dali::Control is intended as a base class. More...
 
Controloperator= (const Control &handle)
 Assignment operator. More...
 
void SetKeyInputFocus ()
 This sets the control to receive key events. More...
 
bool HasKeyInputFocus ()
 Quries whether the control has key input focus. More...
 
void ClearKeyInputFocus ()
 Once an actor is Set to receive key input focus this function is called to stop it receiving key events. More...
 
PinchGestureDetector GetPinchGestureDetector () const
 Retrieves the pinch gesture detector of the control. More...
 
PanGestureDetector GetPanGestureDetector () const
 Retrieves the pan gesture detector of the control. More...
 
TapGestureDetector GetTapGestureDetector () const
 Retrieves the tap gesture detector of the control. More...
 
LongPressGestureDetector GetLongPressGestureDetector () const
 Retrieves the long press gesture detector of the control. More...
 
void SetStyleName (const std::string &styleName)
 Sets the name of the style to be applied to the control. More...
 
const std::string & GetStyleName () const
 Retrieves the name of the style to be applied to the control (if any). More...
 
void SetBackgroundColor (const Vector4 &color)
 Sets the background color of the control. More...
 
Vector4 GetBackgroundColor () const
 .3 More...
 
void SetBackgroundImage (Image image)
 Sets an image as the background of the control. More...
 
void ClearBackground ()
 Clears the background. More...
 
KeyEventSignalTypeKeyEventSignal ()
 This signal is emitted when key event is received. More...
 
KeyInputFocusSignalTypeKeyInputFocusGainedSignal ()
 This signal is emitted when the control gets Key Input Focus. More...
 
KeyInputFocusSignalTypeKeyInputFocusLostSignal ()
 This signal is emitted when the control loses Key Input Focus which could be due to it being gained by another Control or Actor or just cleared from this control as no longer required. More...
 
 Control (Internal::Control &implementation)
 Create an initialised Control. More...
 
 Control (Dali::Internal::CustomActor *internal)
 This constructor is used by CustomActor within Dali core to create additional Control handles using an Internal CustomActor pointer. More...
 
template<typename I >
DALI_INTERNAL void VerifyCustomActorPointer (Dali::Internal::CustomActor *internal)
 Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an implementation of their class. More...
 
- Public Member Functions inherited from Dali::CustomActor
 CustomActor ()
 Create an uninitialized CustomActor handle. More...
 
 ~CustomActor ()
 Destructor. More...
 
CustomActorImplGetImplementation ()
 Retrieve the custom actor implementation. More...
 
const CustomActorImplGetImplementation () const
 Retrieve the custom actor implementation. More...
 
 CustomActor (CustomActorImpl &implementation)
 Create an initialised CustomActor. More...
 
 CustomActor (const CustomActor &copy)
 Copy constructor. More...
 
CustomActoroperator= (const CustomActor &rhs)
 Assignment operator. More...
 
 CustomActor (Internal::CustomActor *actor)
 This constructor is used internally to create additional CustomActor handles. More...
 
- Public Member Functions inherited from Dali::Actor
 Actor ()
 Create an uninitialized Actor; this can be initialized with Actor::New(). More...
 
 ~Actor ()
 Dali::Actor is intended as a base class. More...
 
 Actor (const Actor &copy)
 Copy constructor. More...
 
Actoroperator= (const Actor &rhs)
 Assignment operator. More...
 
const std::string & GetName () const
 Retrieve the Actor's name. More...
 
void SetName (const std::string &name)
 Sets the Actor's name. More...
 
unsigned int GetId () const
 Retrieve the unique ID of the actor. More...
 
bool IsRoot () const
 Query whether an actor is the root actor, which is owned by the Stage. More...
 
bool OnStage () const
 Query whether the actor is connected to the Stage. More...
 
bool IsLayer () const
 Query whether the actor is of class Dali::Layer. More...
 
Layer GetLayer ()
 Gets the layer in which the actor is present. More...
 
void Add (Actor child)
 Adds a child Actor to this Actor. More...
 
void Remove (Actor child)
 Removes a child Actor from this Actor. More...
 
void Unparent ()
 Removes an actor from its parent. More...
 
unsigned int GetChildCount () const
 Retrieve the number of children held by the actor. More...
 
Actor GetChildAt (unsigned int index) const
 Retrieve and child actor by index. More...
 
Actor FindChildByName (const std::string &actorName)
 Search through this actor's hierarchy for an actor with the given name. More...
 
Actor FindChildById (const unsigned int id)
 Search through this actor's hierarchy for an actor with the given unique ID. More...
 
Actor GetParent () const
 Retrieve the actor's parent. More...
 
void SetParentOrigin (const Vector3 &origin)
 Set the origin of an actor, within its parent's area. More...
 
Vector3 GetCurrentParentOrigin () const
 Retrieve the parent-origin of an actor. More...
 
void SetAnchorPoint (const Vector3 &anchorPoint)
 Set the anchor-point of an actor. More...
 
Vector3 GetCurrentAnchorPoint () const
 Retrieve the anchor-point of an actor. More...
 
void SetSize (float width, float height)
 Sets the size of an actor. More...
 
void SetSize (float width, float height, float depth)
 Sets the size of an actor. More...
 
void SetSize (const Vector2 &size)
 Sets the size of an actor. More...
 
void SetSize (const Vector3 &size)
 Sets the size of an actor. More...
 
Vector3 GetTargetSize () const
 Retrieve the actor's size. More...
 
Vector3 GetCurrentSize () const
 Retrieve the actor's size. More...
 
Vector3 GetNaturalSize () const
 Return the natural size of the actor. More...
 
void SetPosition (float x, float y)
 Sets the position of the actor. More...
 
void SetPosition (float x, float y, float z)
 Sets the position of the Actor. More...
 
void SetPosition (const Vector3 &position)
 Sets the position of the Actor. More...
 
void SetX (float x)
 Set the position of an actor along the X-axis. More...
 
void SetY (float y)
 Set the position of an actor along the Y-axis. More...
 
void SetZ (float z)
 Set the position of an actor along the Z-axis. More...
 
void TranslateBy (const Vector3 &distance)
 Translate an actor relative to its existing position. More...
 
Vector3 GetCurrentPosition () const
 Retrieve the position of the Actor. More...
 
Vector3 GetCurrentWorldPosition () const
 Retrieve the world-position of the Actor. More...
 
void SetPositionInheritanceMode (PositionInheritanceMode mode)
 Set the actors position inheritance mode. More...
 
PositionInheritanceMode GetPositionInheritanceMode () const
 Returns the actors position inheritance mode. More...
 
void SetOrientation (const Degree &angle, const Vector3 &axis)
 Sets the orientation of the Actor. More...
 
void SetOrientation (const Radian &angle, const Vector3 &axis)
 Sets the orientation of the Actor. More...
 
void SetOrientation (const Quaternion &orientation)
 Sets the orientation of the Actor. More...
 
void RotateBy (const Degree &angle, const Vector3 &axis)
 Apply a relative rotation to an actor. More...
 
void RotateBy (const Radian &angle, const Vector3 &axis)
 Apply a relative rotation to an actor. More...
 
void RotateBy (const Quaternion &relativeRotation)
 Apply a relative rotation to an actor. More...
 
Quaternion GetCurrentOrientation () const
 Retreive the Actor's orientation. More...
 
void SetInheritOrientation (bool inherit)
 Set whether a child actor inherits it's parent's orientation. More...
 
bool IsOrientationInherited () const
 Returns whether the actor inherits its parent's orientation. More...
 
Quaternion GetCurrentWorldOrientation () const
 Retrieve the world-orientation of the Actor. More...
 
void SetScale (float scale)
 Set the scale factor applied to an actor. More...
 
void SetScale (float scaleX, float scaleY, float scaleZ)
 Set the scale factor applied to an actor. More...
 
void SetScale (const Vector3 &scale)
 Set the scale factor applied to an actor. More...
 
void ScaleBy (const Vector3 &relativeScale)
 Apply a relative scale to an actor. More...
 
Vector3 GetCurrentScale () const
 Retrieve the scale factor applied to an actor. More...
 
Vector3 GetCurrentWorldScale () const
 Retrieve the world-scale of the Actor. More...
 
void SetInheritScale (bool inherit)
 Set whether a child actor inherits it's parent's scale. More...
 
bool IsScaleInherited () const
 Returns whether the actor inherits its parent's scale. More...
 
Matrix GetCurrentWorldMatrix () const
 Retrieves the world-matrix of the actor. More...
 
void SetVisible (bool visible)
 Sets the visibility flag of an actor. More...
 
bool IsVisible () const
 Retrieve the visibility flag of an actor. More...
 
void SetOpacity (float opacity)
 Sets the opacity of an actor. More...
 
float GetCurrentOpacity () const
 Retrieve the actor's opacity. More...
 
void SetColor (const Vector4 &color)
 Sets the actor's color; this is an RGBA value. More...
 
Vector4 GetCurrentColor () const
 Retrieve the actor's color. More...
 
void SetColorMode (ColorMode colorMode)
 Sets the actor's color mode. More...
 
ColorMode GetColorMode () const
 Returns the actor's color mode. More...
 
Vector4 GetCurrentWorldColor () const
 Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range. More...
 
void SetDrawMode (DrawMode::Type drawMode)
 Set how the actor and its children should be drawn. More...
 
DrawMode::Type GetDrawMode () const
 Query how the actor and its children will be drawn. More...
 
void SetSensitive (bool sensitive)
 Sets whether an actor should emit touch or hover signals; see SignalTouch() and SignalHover(). More...
 
bool IsSensitive () const
 Query whether an actor emits touch or hover event signals. More...
 
bool ScreenToLocal (float &localX, float &localY, float screenX, float screenY) const
 Converts screen coordinates into the actor's coordinate system using the default camera. More...
 
void SetLeaveRequired (bool required)
 Sets whether the actor should receive a notification when touch or hover motion events leave the boundary of the actor. More...
 
bool GetLeaveRequired () const
 This returns whether the actor requires touch or hover events whenever touch or hover motion events leave the boundary of the actor. More...
 
void SetKeyboardFocusable (bool focusable)
 Sets whether the actor should be focusable by keyboard navigation. More...
 
bool IsKeyboardFocusable () const
 Returns whether the actor is focusable by keyboard navigation. More...
 
void SetResizePolicy (ResizePolicy::Type policy, Dimension::Type dimension)
 Set the resize policy to be used for the given dimension(s). More...
 
ResizePolicy::Type GetResizePolicy (Dimension::Type dimension) const
 Return the resize policy used for a single dimension. More...
 
void SetSizeScalePolicy (SizeScalePolicy::Type policy)
 Set the policy to use when setting size with size negotiation. More...
 
SizeScalePolicy::Type GetSizeScalePolicy () const
 Return the size scale policy in use. More...
 
void SetSizeModeFactor (const Vector3 &factor)
 Sets the relative to parent size factor of the actor. More...
 
Vector3 GetSizeModeFactor () const
 Retrieve the relative to parent size factor of the actor. More...
 
float GetHeightForWidth (float width)
 Calculate the height of the actor given a width. More...
 
float GetWidthForHeight (float height)
 Calculate the width of the actor given a height. More...
 
float GetRelayoutSize (Dimension::Type dimension) const
 Return the value of negotiated dimension for the given dimension. More...
 
void SetPadding (const Padding &padding)
 Set the padding for use in layout. More...
 
void GetPadding (Padding &paddingOut) const
 Return the value of the padding. More...
 
void SetMinimumSize (const Vector2 &size)
 Set the minimum size an actor can be assigned in size negotiation. More...
 
Vector2 GetMinimumSize ()
 Return the minimum relayout size. More...
 
void SetMaximumSize (const Vector2 &size)
 Set the maximum size an actor can be assigned in size negotiation. More...
 
Vector2 GetMaximumSize ()
 Return the maximum relayout size. More...
 
int GetHierarchyDepth ()
 Get depth in the hierarchy for the actor. More...
 
unsigned int AddRenderer (Renderer &renderer)
 Add a renderer to this actor. More...
 
unsigned int GetRendererCount () const
 Get the number of renderers on this actor. More...
 
Renderer GetRendererAt (unsigned int index)
 Get a Renderer by index. More...
 
void RemoveRenderer (Renderer &renderer)
 Remove an renderer from the actor. More...
 
void RemoveRenderer (unsigned int index)
 Remove an renderer from the actor by index. More...
 
TouchSignalTypeTouchedSignal ()
 This signal is emitted when touch input is received. More...
 
HoverSignalTypeHoveredSignal ()
 This signal is emitted when hover input is received. More...
 
WheelEventSignalTypeWheelEventSignal ()
 This signal is emitted when wheel event is received. More...
 
OnStageSignalTypeOnStageSignal ()
 This signal is emitted after the actor has been connected to the stage. More...
 
OffStageSignalTypeOffStageSignal ()
 This signal is emitted after the actor has been disconnected from the stage. More...
 
OnRelayoutSignalTypeOnRelayoutSignal ()
 This signal is emitted after the size has been set on the actor during relayout. More...
 
DALI_INTERNAL Actor (Internal::Actor *actor)
 This constructor is used by Actor::New() methods. More...
 
- Public Member Functions inherited from Dali::Handle
 Handle (Dali::Internal::Object *handle)
 This constructor is used by Dali New() methods. More...
 
 Handle ()
 This constructor provides an uninitialized Dali::Handle. More...
 
 ~Handle ()
 Dali::Handle is intended as a base class. More...
 
 Handle (const Handle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
Handleoperator= (const Handle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
bool Supports (Capability capability) const
 Query whether an handle supports a given capability. More...
 
unsigned int GetPropertyCount () const
 Query how many properties are provided by an handle. More...
 
std::string GetPropertyName (Property::Index index) const
 Query the name of a property. More...
 
Property::Index GetPropertyIndex (const std::string &name) const
 Query the index of a property. More...
 
bool IsPropertyWritable (Property::Index index) const
 Query whether a property can be set using SetProperty(). More...
 
bool IsPropertyAnimatable (Property::Index index) const
 Query whether a writable property can be the target of an animation or constraint. More...
 
bool IsPropertyAConstraintInput (Property::Index index) const
 Query whether a property can be used as in input to a constraint. More...
 
Property::Type GetPropertyType (Property::Index index) const
 Query the type of a property. More...
 
void SetProperty (Property::Index index, const Property::Value &propertyValue)
 Set the value of an existing property. More...
 
Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue)
 Register a new animatable property. More...
 
Property::Index RegisterProperty (const std::string &name, const Property::Value &propertyValue, Property::AccessMode accessMode)
 Register a new property. More...
 
Property::Value GetProperty (Property::Index index) const
 Retrieve a property value. More...
 
template<typename T >
GetProperty (Property::Index index) const
 Convenience function for obtaining a property of a known type. More...
 
void GetPropertyIndices (Property::IndexContainer &indices) const
 Retrieve all the property indices for this object (including custom properties). More...
 
PropertyNotification AddPropertyNotification (Property::Index index, const PropertyCondition &condition)
 Add a property notification to this object. More...
 
PropertyNotification AddPropertyNotification (Property::Index index, int componentIndex, const PropertyCondition &condition)
 Add a property notification to this object. More...
 
void RemovePropertyNotification (Dali::PropertyNotification propertyNotification)
 Remove a property notification from this object. More...
 
void RemovePropertyNotifications ()
 Remove all property notifications from this object. More...
 
void RemoveConstraints ()
 Remove all constraints from an Object. More...
 
void RemoveConstraints (unsigned int tag)
 Remove all the constraint from the Object with a matching tag. More...
 
- Public Member Functions inherited from Dali::BaseHandle
 BaseHandle (Dali::BaseObject *handle)
 This constructor is used by Dali New() methods. More...
 
 BaseHandle ()
 This constructor provides an uninitialized Dali::BaseHandle. More...
 
 ~BaseHandle ()
 Dali::BaseHandle is intended as a base class. More...
 
 BaseHandle (const BaseHandle &handle)
 This copy constructor is required for (smart) pointer semantics. More...
 
BaseHandleoperator= (const BaseHandle &rhs)
 This assignment operator is required for (smart) pointer semantics. More...
 
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...
 
BaseObjectGetBaseObject ()
 Retrieve the internal Dali resource. More...
 
const BaseObjectGetBaseObject () const
 Retrieve the internal Dali resource. More...
 
void Reset ()
 Resets the handle. More...
 
 operator BooleanType () const
 Converts an handle to a BooleanType. More...
 
bool operator== (const BaseHandle &rhs) const
 Equality operator overload. More...
 
bool operator!= (const BaseHandle &rhs) const
 Inequality operator overload. More...
 
Dali::RefObjectGetObjectPtr () const
 Get the reference counted object pointer. More...
 

Static Public Member Functions

static Control New ()
 Create a new instance of a Control. More...
 
static Control DownCast (BaseHandle handle)
 Downcast a handle to Control handle. More...
 
template<typename T , typename I >
static DALI_INTERNALDownCast (BaseHandle handle)
 Template to allow deriving controls to DownCast handles to deriving handle classes. More...
 
- Static Public Member Functions inherited from Dali::CustomActor
static CustomActor DownCast (BaseHandle handle)
 Downcast a handle to CustomActor handle. More...
 
- Static Public Member Functions inherited from Dali::Actor
static Actor New ()
 Create an initialized Actor. More...
 
static Actor DownCast (BaseHandle handle)
 Downcast a handle to Actor handle. More...
 
- Static Public Member Functions inherited from Dali::Handle
static Handle New ()
 Create a new object. More...
 
static Handle DownCast (BaseHandle handle)
 Downcast to a handle. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::BaseHandle
void ThisIsSaferThanReturningVoidStar () const
 Used by the safe bool idiom. More...
 

Detailed Description

Control is the base class for all controls.

The implementation of the control must be supplied; see Internal::Control for more details. .0

See Also
Internal::Control

Signals

Signal Name Method
keyEvent KeyEventSignal()
keyInputFocusGained KeyInputFocusGainedSignal()
keyInputFocusLost KeyInputFocusLostSignal()
tapped GetTapGestureDetector().DetectedSignal()
panned GetPanGestureDetector().DetectedSignal()
pinched GetPinchGestureDetector().DetectedSignal()
longPressed GetLongPressGestureDetector().DetectedSignal()

Actions

Action Name Control method called
accessibilityActivated OnAccessibilityActivated()

Definition at line 71 of file control.h.

Member Typedef Documentation

Key Event signal type;.

Definition at line 145 of file control.h.

Key InputFocusType signal type;.

Definition at line 148 of file control.h.

Member Enumeration Documentation

The start and end property ranges for control.

.0

Enumerator
PROPERTY_START_INDEX 

Start index is used by the property registration macro. .0.

CONTROL_PROPERTY_START_INDEX 

Start index of Control properties. .0.

CONTROL_PROPERTY_END_INDEX 

Reserving 1000 property indices. .0.

Definition at line 79 of file control.h.

Constructor & Destructor Documentation

Dali::Toolkit::Control::Control ( )

Create an uninitialized Control handle.

Only derived versions can be instantiated. Calling member functions with an uninitialized Dali::Object is not allowed. .0

Definition at line 35 of file control.cpp.

Referenced by Dali::Toolkit::Internal::Control::New().

Here is the caller graph for this function:

Dali::Toolkit::Control::Control ( const Control uiControl)

Copy constructor.

Creates another handle that points to the same real object. .0

Parameters
[in]uiControlHandle to copy

Definition at line 39 of file control.cpp.

Dali::Toolkit::Control::~Control ( )

Dali::Control is intended as a base class.

This is non-virtual since derived Handle types must not contain data or virtual methods. .0

Definition at line 44 of file control.cpp.

Dali::Toolkit::Control::Control ( Internal::Control implementation)
explicit

Create an initialised Control.

.0

Parameters
[in]implementationThe implementation for this control.
Returns
A handle to a newly allocated Dali resource.
Note
Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.

Definition at line 142 of file control.cpp.

Dali::Toolkit::Control::Control ( Dali::Internal::CustomActor internal)
explicit

This constructor is used by CustomActor within Dali core to create additional Control handles using an Internal CustomActor pointer.

.0

Parameters
[in]internalA pointer to a newly allocated Dali resource

Definition at line 147 of file control.cpp.

Member Function Documentation

void Dali::Toolkit::Control::ClearBackground ( )

Clears the background.

.0

Definition at line 122 of file control.cpp.

References Dali::Toolkit::Internal::Control::ClearBackground(), and Dali::Toolkit::Internal::GetImplementation().

Referenced by UtcDaliControlBackgroundProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Control::ClearKeyInputFocus ( )

Once an actor is Set to receive key input focus this function is called to stop it receiving key events.

A check is performed to ensure it was previously set, if this check fails then nothing is done. .0

Precondition
The Actor has been initialized.

Definition at line 72 of file control.cpp.

References Dali::Toolkit::Internal::Control::ClearKeyInputFocus(), and Dali::Toolkit::Internal::GetImplementation().

Referenced by UtcDaliControlImplKeyInputFocusLost(), UtcDaliControlImplKeyInputFocusLostSignal(), UtcDaliControlKeyInputFocus(), UtcDaliControlKeyProperties(), and UtcDaliKeyInputFocusManagerIsKeyboardListener().

Here is the call graph for this function:

Here is the caller graph for this function:

Control Dali::Toolkit::Control::DownCast ( BaseHandle  handle)
static

Downcast a handle to Control handle.

If handle points to a Control the downcast produces valid handle. If not the returned handle is left uninitialized.

.0

Parameters
[in]handleHandle to an object
Returns
A handle to a Control or an uninitialized handle

Definition at line 57 of file control.cpp.

Referenced by Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionDown(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageDown(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageLeft(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageRight(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionPageUp(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionScrollDown(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionScrollUp(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionTouch(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionUp(), Dali::Toolkit::Internal::AccessibilityManager::AccessibilityActionZoom(), Dali::Toolkit::Internal::Popup::AddFocusableChildren(), Dali::Toolkit::Internal::Popup::AddFocusableChildrenRecursive(), Dali::Toolkit::Internal::Control::ClearKeyInputFocus(), Dali::Toolkit::Text::Decorator::Impl::CreateGrabHandle(), Dali::Toolkit::anonymous_namespace{control-impl.cpp}::DoAction(), Dali::Toolkit::Internal::AccessibilityManager::DoActivate(), Dali::Toolkit::anonymous_namespace{control-impl.cpp}::DoConnectSignal(), Dali::Toolkit::Internal::Builder::DoCreate(), Dali::Toolkit::Internal::KeyboardFocusManager::DoKeyboardEnter(), Dali::Toolkit::Internal::KeyboardFocusManager::DoMoveFocusWithinLayoutControl(), Dali::Toolkit::Internal::KeyInputFocusManager::GetCurrentFocusControl(), Dali::Toolkit::Internal::KeyboardFocusManager::GetParentLayoutControl(), Dali::Toolkit::Internal::Control::Impl::GetProperty(), Dali::Toolkit::Internal::AccessibilityManager::HandlePanGesture(), Dali::Toolkit::Internal::Control::HasKeyInputFocus(), Dali::Toolkit::Internal::KeyboardFocusManager::IsLayoutControl(), Dali::Toolkit::Internal::KeyboardFocusManager::MoveFocus(), Dali::Toolkit::Internal::KeyInputFocusManager::OnFocusControlStageDisconnection(), Dali::Toolkit::Internal::KeyInputFocusManager::OnKeyEvent(), Dali::Toolkit::Internal::Control::SetKeyInputFocus(), Dali::Toolkit::Internal::Control::Impl::SetProperty(), UtcDaliImageViewHeightForWidthBackground(), utcDaliTextEditorEvent02(), and utcDaliTextFieldEvent02().

Here is the caller graph for this function:

template<typename T , typename I >
static DALI_INTERNAL T Dali::Toolkit::Control::DownCast ( BaseHandle  handle)
inlinestatic

Template to allow deriving controls to DownCast handles to deriving handle classes.

Template Parameters
TThe handle class
IThe implementation class .0
Parameters
[in]handleHandle to an object
Returns
Handle to a class T or an uninitialized handle.
See Also
DownCast(BaseHandle)

Definition at line 425 of file control.h.

References Dali::CustomActor::DownCast(), Dali::CustomActor::GetImplementation(), and Dali::CustomActorImpl::GetOwner().

Here is the call graph for this function:

Vector4 Dali::Toolkit::Control::GetBackgroundColor ( ) const

.3

Retrieves the background color of the control.

.0

Returns
The background color of the control.

Definition at line 112 of file control.cpp.

References Dali::Toolkit::Internal::Control::GetBackgroundColor(), and Dali::Toolkit::Internal::GetImplementation().

Referenced by UtcDaliControlBackgroundColor(), UtcDaliControlBackgroundImage(), and UtcDaliControlBackgroundProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

LongPressGestureDetector Dali::Toolkit::Control::GetLongPressGestureDetector ( ) const

Retrieves the long press gesture detector of the control.

.0

Returns
The long press gesture detector.
Note
Will return an empty handle if the control does not handle the gesture itself.

Definition at line 92 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::GetLongPressGestureDetector().

Referenced by UtcDaliControlGestureSignals().

Here is the call graph for this function:

Here is the caller graph for this function:

PanGestureDetector Dali::Toolkit::Control::GetPanGestureDetector ( ) const

Retrieves the pan gesture detector of the control.

.0

Returns
The pan gesture detector.
Note
Will return an empty handle if the control does not handle the gesture itself.

Definition at line 82 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::GetPanGestureDetector().

Referenced by UtcDaliControlGestureSignals().

Here is the call graph for this function:

Here is the caller graph for this function:

PinchGestureDetector Dali::Toolkit::Control::GetPinchGestureDetector ( ) const

Retrieves the pinch gesture detector of the control.

.0

Returns
The pinch gesture detector.
Note
Will return an empty handle if the control does not handle the gesture itself.

Definition at line 77 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::GetPinchGestureDetector().

Referenced by UtcDaliControlGestureSignals().

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string & Dali::Toolkit::Control::GetStyleName ( ) const

Retrieves the name of the style to be applied to the control (if any).

.0

Returns
A string matching a style or an empty string.

Definition at line 102 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::GetStyleName().

Referenced by Dali::Toolkit::Internal::StyleManager::ApplyStyle(), and UtcDaliControlImplSetStyleName().

Here is the call graph for this function:

Here is the caller graph for this function:

TapGestureDetector Dali::Toolkit::Control::GetTapGestureDetector ( ) const

Retrieves the tap gesture detector of the control.

.0

Returns
The tap gesture detector.
Note
Will return an empty handle if the control does not handle the gesture itself.

Definition at line 87 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::GetTapGestureDetector().

Referenced by UtcDaliControlGestureSignals().

Here is the call graph for this function:

Here is the caller graph for this function:

bool Dali::Toolkit::Control::HasKeyInputFocus ( )

Quries whether the control has key input focus.

.0

Returns
true if this control has keyboard input focus
Precondition
The Control has been initialized.
The Control should be on the stage before setting keyboard focus.
Note
The control can be set to have the focus and still not receive all the key events if another control has over ridden it. As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more controls above it in the focus stack. To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().

Definition at line 67 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::HasKeyInputFocus().

Referenced by UtcDaliControlImplKeyInputFocusGainedSignal(), UtcDaliControlImplKeyInputFocusLostSignal(), UtcDaliControlKeyInputFocus(), UtcDaliControlKeyProperties(), UtcDaliKeyInputFocusManagerSetFocus01(), and UtcDaliKeyInputFocusManagerSetFocus02().

Here is the call graph for this function:

Here is the caller graph for this function:

Control::KeyEventSignalType & Dali::Toolkit::Control::KeyEventSignal ( )

This signal is emitted when key event is received.

A callback of the following type may be connected:

bool YourCallbackName(Control control, const KeyEvent& event);

The return value of True, indicates that the event should be consumed. Otherwise the signal will be emitted on the next parent of the actor. .0

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

Definition at line 127 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::KeyEventSignal().

Referenced by UtcDaliControlTestParameters().

Here is the call graph for this function:

Here is the caller graph for this function:

Control::KeyInputFocusSignalType & Dali::Toolkit::Control::KeyInputFocusGainedSignal ( )

This signal is emitted when the control gets Key Input Focus.

A callback of the following type may be connected:

bool YourCallbackName( Control control );

The return value of True, indicates that the event should be consumed. Otherwise the signal will be emitted on the next parent of the actor. .0

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

Definition at line 132 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::KeyInputFocusGainedSignal().

Referenced by UtcDaliControlImplKeyInputFocusGainedSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

Control::KeyInputFocusSignalType & Dali::Toolkit::Control::KeyInputFocusLostSignal ( )

This signal is emitted when the control loses Key Input Focus which could be due to it being gained by another Control or Actor or just cleared from this control as no longer required.

A callback of the following type may be connected:

bool YourCallbackName( Control control );

The return value of True, indicates that the event should be consumed. Otherwise the signal will be emitted on the next parent of the actor. .0

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

Definition at line 137 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::KeyInputFocusLostSignal().

Referenced by UtcDaliControlImplKeyInputFocusLostSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

Control Dali::Toolkit::Control::New ( void  )
static

Create a new instance of a Control.

.0

Returns
A handle to a new Control.

Definition at line 30 of file control.cpp.

References Dali::Toolkit::Internal::Control::New().

Referenced by Dali::Toolkit::Internal::ToolBar::AddControl(), Dali::Toolkit::Internal::TextSelectionPopup::AddOption(), Dali::Toolkit::Internal::anonymous_namespace{alignment-impl.cpp}::Create(), Dali::Toolkit::Internal::anonymous_namespace{text-selection-popup-impl.cpp}::Create(), Dali::Toolkit::Internal::anonymous_namespace{super-blur-view-impl.cpp}::Create(), Dali::Toolkit::Internal::anonymous_namespace{scroll-bar-impl.cpp}::Create(), Dali::Toolkit::Internal::anonymous_namespace{table-view-impl.cpp}::Create(), Dali::Toolkit::Text::Decorator::Impl::CreateCursor(), Dali::Toolkit::Text::Decorator::Impl::CreateGrabHandle(), Dali::Toolkit::Internal::ToolBar::OnInitialize(), Dali::Toolkit::Internal::Popup::OnInitialize(), Dali::Toolkit::Text::Decorator::SetEnabledPopupButtons(), Dali::Toolkit::Internal::TextSelectionToolbar::SetUp(), anonymous_namespace{utc-Dali-TableView.cpp}::SetupTableViewAndActors(), UtcDaliItemLayoutSetAndGetOrientation(), UtcDaliItemViewActivateLayoutAndGetActiveLayout(), UtcDaliItemViewAddAndGetLayout(), UtcDaliItemViewAddAndRemoveLayout(), UtcDaliItemViewDeactivateCurrentLayout(), UtcDaliItemViewDownCast(), UtcDaliItemViewGetCurrentLayoutPosition(), UtcDaliItemViewGetItemAndGetItemId(), UtcDaliItemViewGetItemsRangeP(), UtcDaliItemViewInsertItemP(), UtcDaliItemViewInsertItemsP(), UtcDaliItemViewLayoutActivatedSignalP(), UtcDaliItemViewNew(), UtcDaliItemViewRemoveItem(), UtcDaliItemViewReplaceItemP(), UtcDaliItemViewReplaceItemsP(), UtcDaliItemViewScrollToItem(), UtcDaliItemViewSetAndGetAnchoring(), UtcDaliItemViewSetAndGetAnchoringDuration(), UtcDaliItemViewSetAndGetMinimumSwipeDistance(), UtcDaliItemViewSetAndGetMinimumSwipeSpeed(), UtcDaliItemViewSetAndGetRefreshInterval(), UtcDaliItemViewSetAndGetWheelScrollDistanceStep(), UtcDaliItemViewSetGetProperty(), UtcDaliItemViewSetItemsAnchorPointP(), UtcDaliItemViewSetItemsParentOriginP(), UtcDaliKeyInputFocusManagerDestroyObject01(), UtcDaliKeyInputFocusManagerDestroyObject02(), UtcDaliKeyInputFocusManagerGetCurrentFocusControl(), UtcDaliKeyInputFocusManagerRemoveFocus01(), UtcDaliKeyInputFocusManagerRemoveFocus02(), UtcDaliKeyInputFocusManagerRemoveFocus03(), UtcDaliKeyInputFocusManagerSetFocus01(), UtcDaliKeyInputFocusManagerSetFocus02(), UtcDaliTableViewAdd(), UtcDaliTableViewAddChildN(), UtcDaliTableViewCells(), UtcDaliTableViewChild(), UtcDaliTableViewChildAssert(), UtcDaliTableViewCtorCopyP(), UtcDaliTableViewCustomProperties(), UtcDaliTableViewDeleteColumnAtZero(), UtcDaliTableViewDeleteRowAtZero(), UtcDaliTableViewGetChildAtN(), UtcDaliTableViewInsertColumnAtZero(), UtcDaliTableViewInsertRowAtZero(), UtcDaliTableViewKeyboardFocus(), UtcDaliTableViewMetricsAssert(), UtcDaliTableViewNew(), UtcDaliTableViewSetGetProperty(), UtcDaliToolkitScrollBarAssignmentOperatorP(), UtcDaliToolkitScrollBarCopyConstructorP(), UtcDaliToolkitScrollBarDownCastP(), UtcDaliToolkitScrollBarGetIndicatorFixedHeightP(), UtcDaliToolkitScrollBarGetIndicatorHeightPolicyP(), UtcDaliToolkitScrollBarGetIndicatorHideDurationP(), UtcDaliToolkitScrollBarGetIndicatorShowDurationP(), UtcDaliToolkitScrollBarGetScrollDirectionP(), UtcDaliToolkitScrollBarGetScrollIndicatorN(), UtcDaliToolkitScrollBarGetScrollIndicatorP(), UtcDaliToolkitScrollBarGetScrollPositionIntervalsP(), UtcDaliToolkitScrollBarHideIndicatorN(), UtcDaliToolkitScrollBarHideIndicatorP(), UtcDaliToolkitScrollBarNewP(), UtcDaliToolkitScrollBarPanFinishedSignalN(), UtcDaliToolkitScrollBarPanFinishedSignalP(), UtcDaliToolkitScrollBarScrollPositionIntervalReachedSignalN(), UtcDaliToolkitScrollBarScrollPositionIntervalReachedSignalP(), UtcDaliToolkitScrollBarSetIndicatorFixedHeightP(), UtcDaliToolkitScrollBarSetIndicatorHeightPolicyP(), UtcDaliToolkitScrollBarSetIndicatorHideDurationN(), UtcDaliToolkitScrollBarSetIndicatorHideDurationP(), UtcDaliToolkitScrollBarSetIndicatorShowDurationN(), UtcDaliToolkitScrollBarSetIndicatorShowDurationP(), UtcDaliToolkitScrollBarSetScrollIndicatorN(), UtcDaliToolkitScrollBarSetScrollIndicatorP(), UtcDaliToolkitScrollBarSetScrollPositionIntervalsP(), UtcDaliToolkitScrollBarSetScrollPropertySourceN(), UtcDaliToolkitScrollBarSetScrollPropertySourceP(), UtcDaliToolkitScrollBarShowIndicatorN(), UtcDaliToolkitScrollBarShowIndicatorP(), UtcDaliToolkitTextSelectionPopupAssignmentOperatorP(), UtcDaliToolkitTextSelectionPopupCopyConstructorP(), UtcDaliToolkitTextSelectionPopupDownCastP(), and UtcDaliToolkitTextSelectionPopupNewP().

Here is the call graph for this function:

Control & Dali::Toolkit::Control::operator= ( const Control handle)
void Dali::Toolkit::Control::SetBackgroundColor ( const Vector4 color)

Sets the background color of the control.

.0

Parameters
[in]colorThe required background color of the control
Note
if SetBackgroundImage is called later, this background color is removed.
The background color fully blends with the actor color.

Definition at line 107 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::SetBackgroundColor().

Referenced by Dali::Toolkit::Internal::TextSelectionPopup::AddOption(), Dali::Toolkit::Internal::Popup::CreateBacking(), Dali::Toolkit::Text::Decorator::Impl::CreateCursor(), Dali::Toolkit::Text::Decorator::Impl::CreateGrabHandle(), Dali::Toolkit::Internal::Control::SetBackground(), Dali::Toolkit::Internal::Popup::SetBackingColor(), and UtcDaliControlBackgroundColor().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Control::SetBackgroundImage ( Image  image)

Sets an image as the background of the control.

.0

Parameters
[in]imageThe image to set as the background.

Definition at line 117 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::SetBackgroundImage().

Referenced by UtcDaliControlBackgroundImage(), UtcDaliImageViewHeightForWidthBackground(), UtcDaliImageViewHeightForWidthBackgroundAndImage(), UtcDaliImageViewSizeWithBackground(), and UtcDaliImageViewSizeWithBackgroundAndImage().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Control::SetKeyInputFocus ( )

This sets the control to receive key events.

The key event can originate from a virtual or physical keyboard. .0

Precondition
The Control has been initialized.
The Control should be on the stage before setting keyboard focus.

Definition at line 62 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::SetKeyInputFocus().

Referenced by UtcDaliAlignmentOnKeyEvent(), UtcDaliControlImplKeyEvent(), UtcDaliControlImplKeyInputFocusGained(), UtcDaliControlImplKeyInputFocusGainedSignal(), UtcDaliControlImplKeyInputFocusLost(), UtcDaliControlImplKeyInputFocusLostSignal(), UtcDaliControlKeyInputFocus(), UtcDaliControlKeyProperties(), UtcDaliPopupOnKeyEvent(), utcDaliTextEditorTextChangedP(), utcDaliTextFieldMaxCharactersReachedN(), utcDaliTextFieldMaxCharactersReachedP(), and utcDaliTextFieldTextChangedP().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Toolkit::Control::SetStyleName ( const std::string &  styleName)

Sets the name of the style to be applied to the control.

.0

Parameters
[in]styleNameA string matching a style described in a stylesheet.

Definition at line 97 of file control.cpp.

References Dali::Toolkit::Internal::GetImplementation(), and Dali::Toolkit::Internal::Control::SetStyleName().

Referenced by UtcDaliControlImplSetStyleName().

Here is the call graph for this function:

Here is the caller graph for this function:

template<typename I >
DALI_INTERNAL void Dali::Toolkit::Control::VerifyCustomActorPointer ( Dali::Internal::CustomActor internal)
inline

Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an implementation of their class.

Template Parameters
IThe implementation class .0
Parameters
[in]internalPointer to the Internal::CustomActor

Definition at line 454 of file control.h.

References DALI_ASSERT_DEBUG, and Dali::Toolkit::GetImplementation().

Here is the call graph for this function:


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