1 #ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
2 #define __DALI_TOOLKIT_CONTROL_IMPL_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/adaptor-framework/style-change.h>
23 #include <dali/public-api/events/long-press-gesture.h>
24 #include <dali/public-api/events/pan-gesture.h>
25 #include <dali/public-api/events/pinch-gesture.h>
26 #include <dali/public-api/events/tap-gesture.h>
27 #include <dali/public-api/object/property-index-ranges.h>
28 #include <dali/public-api/object/type-info.h>
31 #include <dali-toolkit/public-api/controls/control.h>
41 namespace Internal DALI_INTERNAL
43 class KeyInputFocusManager;
50 * @brief This is the internal base class for all controls.
52 * It will provide some common functionality required by all controls.
53 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
54 * be disconnected automatically when the control is destroyed.
56 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
60 // Creation & Destruction
63 * @brief Create a new ControlImpl instance that does not require touch by default.
65 * If touch is required then the user can connect to this class' touch signal.
66 * @return A handle to the ControlImpl instance.
68 static Toolkit::Control New();
71 * @brief Virtual destructor.
78 * @copydoc Dali::CustomActorImpl::GetHeightForWidth()
80 virtual float GetHeightForWidth( float width );
83 * @copydoc Dali::CustomActorImpl::GetWidthForHeight()
85 virtual float GetWidthForHeight( float height );
88 * @copydoc Toolkit::CustomActorImpl::GetNaturalSize()
90 virtual Vector3 GetNaturalSize();
95 * @copydoc Toolkit::Control::SetKeyInputFocus()
97 void SetKeyInputFocus();
100 * @copydoc Toolkit::Control::HasKeyInputFocus()
102 bool HasKeyInputFocus();
105 * @copydoc Toolkit::Control::ClearKeyInputFocus()
107 void ClearKeyInputFocus();
112 * @brief If deriving classes wish to fine tune pinch gesture
113 * detection then they can access the gesture detector through this
114 * API and modify the detection.
116 * @return The pinch gesture detector.
117 * @pre Pinch detection should have been enabled via EnableGestureDetection().
118 * @see EnableGestureDetection
120 PinchGestureDetector GetPinchGestureDetector() const;
123 * @brief If deriving classes wish to fine tune pan gesture
124 * detection then they can access the gesture detector through this
125 * API and modify the detection.
127 * @return The pan gesture detector.
128 * @pre Pan detection should have been enabled via EnableGestureDetection().
129 * @see EnableGestureDetection
131 PanGestureDetector GetPanGestureDetector() const;
134 * @brief If deriving classes wish to fine tune tap gesture
135 * detection then they can access the gesture detector through this
136 * API and modify the detection.
138 * @return The tap gesture detector.
139 * @pre Tap detection should have been enabled via EnableGestureDetection().
140 * @see EnableGestureDetection
142 TapGestureDetector GetTapGestureDetector() const;
145 * @brief If deriving classes wish to fine tune long press gesture
146 * detection then they can access the gesture detector through this
147 * API and modify the detection.
149 * @return The long press gesture detector.
150 * @pre Long press detection should have been enabled via EnableGestureDetection().
151 * @see EnableGestureDetection
153 LongPressGestureDetector GetLongPressGestureDetector() const;
158 * @copydoc Dali::Toolkit::Control::SetStyleName
160 void SetStyleName( const std::string& styleName );
163 * @copydoc Dali::Toolkit::Control::GetStyleName
165 const std::string& GetStyleName() const;
168 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
170 void SetBackgroundColor( const Vector4& color );
173 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
175 Vector4 GetBackgroundColor() const;
178 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
180 void SetBackgroundImage( Image image );
183 * @copydoc Dali::Toolkit::Control::ClearBackground
185 void ClearBackground();
188 * @copydoc Dali::Toolkit::Control::GetBackgroundActor
190 Actor GetBackgroundActor() const;
192 // Keyboard Navigation
195 * @brief Sets whether this control supports two dimensional
196 * keyboard navigation (i.e. whether it knows how to handle the
197 * keyboard focus movement between its child actors).
199 * The control doesn't support it by default.
200 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
202 void SetKeyboardNavigationSupport(bool isSupported);
205 * @brief Gets whether this control supports two dimensional keyboard navigation.
207 * @return true if this control supports two dimensional keyboard navigation.
209 bool IsKeyboardNavigationSupported();
211 // Called by Focus Managers
214 * @brief Called by the focus manager and keyboard focus manager to Activate the Control
216 DALI_INTERNAL void Activate();
219 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
222 * @param[in] gesture The pan gesture.
223 * @return true if the pan gesture has been consumed by this control
225 virtual bool OnAccessibilityPan(PanGesture gesture);
228 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
231 * @param[in] touchEvent The touch event.
232 * @return true if the touch event has been consumed by this control
234 virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
237 * @brief This method should be overridden by deriving classes when they wish to respond
238 * the accessibility up and down action (i.e. value change of slider control).
240 * @param[in] isIncrease Whether the value should be increased or decreased
241 * @return true if the value changed action has been consumed by this control
243 virtual bool OnAccessibilityValueChange(bool isIncrease);
248 * @brief Sets whether this control is a focus group for keyboard navigation.
250 * (i.e. the scope of keyboard focus movement
251 * can be limitied to its child actors). The control is not a focus group by default.
252 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
254 void SetAsKeyboardFocusGroup(bool isFocusGroup);
257 * @brief Gets whether this control is a focus group for keyboard navigation.
259 * @return true if this control is set as a focus group for keyboard navigation.
261 bool IsKeyboardFocusGroup();
264 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
266 * A control needs to override this function in order to support two dimensional keyboard navigation.
267 * @param[in] currentFocusedActor The current focused actor.
268 * @param[in] direction The direction to move the focus towards.
269 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
270 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
272 virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
275 * @brief Informs this control that its chosen focusable actor will be focused.
277 * This allows the application to preform any actions if wishes
278 * before the focus is actually moved to the chosen actor.
280 * @param[in] commitedFocusableActor The commited focusable actor.
282 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
285 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
287 * Should be called last by the control after it acts on the Input Focus change.
289 * @param[in] focusGained True if gained, False if lost
291 void EmitKeyInputFocusSignal( bool focusGained );
296 * @brief Performs actions as requested using the action name.
298 * @param[in] object The object on which to perform the action.
299 * @param[in] actionName The action to perform.
300 * @param[in] attributes The attributes with which to perfrom this action.
301 * @return true if action has been accepted by this control
303 static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes);
306 * Connects a callback function with the object's signals.
307 * @param[in] object The object providing the signal.
308 * @param[in] tracker Used to disconnect the signal.
309 * @param[in] signalName The signal to connect to.
310 * @param[in] functor A newly allocated FunctorDelegate.
311 * @return True if the signal was connected.
312 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
314 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
317 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
319 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
322 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
324 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
327 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
329 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
332 * @brief Called by the KeyInputFocusManager to emit key event signals.
334 * @param[in] event The key event.
335 * @return True if the event was consumed.
337 DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
343 // Flags for the constructor
344 enum ControlBehaviour
346 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
347 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
349 LAST_CONTROL_BEHAVIOUR_FLAG
352 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
355 * @brief Create a Control.
357 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
359 Control(ControlBehaviour behaviourFlags);
362 * @brief Second phase initialization.
369 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
371 * Gesture detection can be enabled one at a time or in bitwise format as shown:
373 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
375 * @param[in] type The gesture type(s) to enable.
377 void EnableGestureDetection(Gesture::Type type);
380 * @brief Allows deriving classes to disable any of the gesture detectors.
382 * Like EnableGestureDetection, this can also be called using bitwise or.
383 * @param[in] type The gesture type(s) to disable.
384 * @see EnableGetureDetection
386 void DisableGestureDetection(Gesture::Type type);
389 * @copydoc Dali::CustomActorImpl::RelayoutDependentOnChildren()
391 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
395 // For derived classes to override
398 * @brief This method is called after the Control has been initialized.
400 * Derived classes should do any second phase initialization by overriding this method.
402 virtual void OnInitialize();
405 * @brief This method is called when the control is activated.
407 * Derived classes should override this if they wish to be notified when they are activated.
409 virtual void OnActivated();
412 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
414 * @param[in] styleManager The StyleManager object.
415 * @param[in] change Information denoting what has changed.
417 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange change );
420 * @brief Called whenever a pinch gesture is detected on this control.
422 * This can be overridden by deriving classes when pinch detection
423 * is enabled. The default behaviour is to scale the control by the
426 * @note If overridden, then the default behaviour will not occur.
427 * @note Pinch detection should be enabled via EnableGestureDetection().
428 * @param[in] pinch The pinch gesture.
429 * @see EnableGestureDetection
431 virtual void OnPinch(const PinchGesture& pinch);
434 * @brief Called whenever a pan gesture is detected on this control.
436 * This should be overridden by deriving classes when pan detection
439 * @note There is no default behaviour with panning.
440 * @note Pan detection should be enabled via EnableGestureDetection().
441 * @param[in] pan The pan gesture.
442 * @see EnableGestureDetection
444 virtual void OnPan( const PanGesture& pan );
447 * @brief Called whenever a tap gesture is detected on this control.
449 * This should be overridden by deriving classes when tap detection
452 * @note There is no default behaviour with a tap.
453 * @note Tap detection should be enabled via EnableGestureDetection().
454 * @param[in] tap The tap gesture.
455 * @see EnableGestureDetection
457 virtual void OnTap( const TapGesture& tap );
460 * @brief Called whenever a long press gesture is detected on this control.
462 * This should be overridden by deriving classes when long press
463 * detection is enabled.
465 * @note There is no default behaviour associated with a long press.
466 * @note Long press detection should be enabled via EnableGestureDetection().
467 * @param[in] longPress The long press gesture.
468 * @see EnableGestureDetection
470 virtual void OnLongPress( const LongPressGesture& longPress );
473 * @brief Called whenever the control is added to the stage.
475 * Could be overridden by derived classes.
477 virtual void OnControlStageConnection();
480 * @brief Called whenever the control is removed from the stage.
482 * Could be overridden by derived classes.
484 virtual void OnControlStageDisconnection();
487 * @brief Called whenever an Actor is added to the control.
489 * Could be overridden by derived classes.
491 * @param[in] child The added actor.
493 virtual void OnControlChildAdd( Actor& child );
496 * @brief Called whenever an Actor is removed from the control.
498 * Could be overridden by derived classes.
500 * @param[in] child The removed actor.
502 virtual void OnControlChildRemove( Actor& child );
505 * @brief Called whenever the Control's size is set.
507 * Could be overridden by derived classes.
509 * @param[in] size The new size.
511 virtual void OnControlSizeSet( const Vector3& size );
514 * @brief Called when the control gains key input focus.
516 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
518 virtual void OnKeyInputFocusGained();
521 * @brief Called when the control loses key input focus.
523 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
525 virtual void OnKeyInputFocusLost();
527 // From CustomActorImpl, derived classes can override these.
530 * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
532 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
535 * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
537 virtual bool OnTouchEvent(const TouchEvent& event);
540 * @copydoc Dali::CustomActorImpl::OnHoverEvent(const HoverEvent&)
542 virtual bool OnHoverEvent(const HoverEvent& event);
545 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
547 virtual bool OnKeyEvent(const KeyEvent& event);
550 * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
552 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
555 * @copydoc Dali::CustomActorImpl::OnCalculateRelayoutSize()
557 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
560 * @copydoc Dali::CustomActorImpl::OnLayoutNegotiated()
562 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
565 * @copydoc Dali::CustomActorImpl::OnRelayout()
567 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
570 * @copydoc Dali::CustomActorImpl::OnSetResizePolicy()
572 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
575 * @copydoc Dali::CustomActorImpl::CalculateChildSize()
577 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
579 // From CustomActorImpl, derived classes should NOT override these.
582 * @brief Sends a request to relayout this control.
584 * The control will be relaid out after the
585 * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
587 * It calls OnControlStageConnection() to notify derived classes.
589 * @see Dali::CustomActorImpl::OnStageConnection()
591 virtual void OnStageConnection();
594 * @copydoc Dali::CustomActorImpl::OnStageDisconnection()
596 virtual void OnStageDisconnection();
599 * @copydoc Dali::CustomActorImpl::OnChildAdd(Actor&)
601 virtual void OnChildAdd(Actor& child);
604 * @copydoc Dali::CustomActorImpl::OnChildRemove(Actor&)
606 virtual void OnChildRemove(Actor& child);
609 * @copydoc Dali::CustomActorImpl::OnSizeSet(const Vector3&)
611 virtual void OnSizeSet(const Vector3& targetSize);
613 // From ConnectionTrackerInterface
616 * @copydoc ConnectionTrackerInterface::SignalConnected
618 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
621 * @copydoc ConnectionTrackerInterface::SignalDisconnected
623 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
628 DALI_INTERNAL Control(const Control&);
629 DALI_INTERNAL Control& operator=(const Control&);
634 friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call several methods which are private. // TODO: Remove
637 } // namespace Internal
639 } // namespace Toolkit
643 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__