1 #ifndef __DALI_TOOLKIT_CONTROL_IMPL_H__
2 #define __DALI_TOOLKIT_CONTROL_IMPL_H__
5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
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.
21 * @addtogroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
26 #include <dali-toolkit/public-api/controls/control.h>
28 namespace Dali DALI_IMPORT_API
34 namespace Internal DALI_INTERNAL
36 class StyleChangeProcessor;
37 class RelayoutControllerImpl;
38 class KeyInputFocusManager;
41 typedef std::pair< Actor, Vector2 > ActorSizePair; ///< Pair of actor and size
42 typedef std::vector< ActorSizePair > ActorSizeContainer; ///< Container of actors and their sizes
48 * @brief This is the internal base class for all controls.
50 * It will provide some common functionality required by all controls.
51 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
52 * be disconnected automatically when the control is destroyed.
54 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
61 CONTROL_PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX,
62 CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
68 * @brief Create a new ControlImpl instance that does not require touch by default.
70 * If touch is required then the user can connect to this class' touch signal.
71 * @return A handle to the ConntrolImpl instance.
73 static Toolkit::Control New();
78 * @brief Virtual destructor.
85 * @brief This method should be overridden by deriving classes when they wish to be notified when they
88 virtual void OnActivated() { }
91 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
94 * @param[in] gesture The pan gesture.
95 * @return true if the pan gesture has been consumed by this control
97 virtual bool OnAccessibilityPan(PanGesture gesture);
100 * @brief This method should be overridden by deriving classes when they wish to respond
101 * the accessibility up and down action (i.e. value change of slider control).
103 * @param[in] isIncrease Whether the value should be increased or decreased
104 * @return true if the value changed action has been consumed by this control
106 virtual bool OnAccessibilityValueChange(bool isIncrease);
109 * @brief Sets whether this control supports two dimensional
110 * keyboard navigation (i.e. whether it knows how to handle the
111 * keyboardn focus movement between its child actors).
113 * The control doesn't support it by default.
114 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
116 void SetKeyboardNavigationSupport(bool isSupported);
119 * @brief Gets whether this control supports two dimensional keyboard navigation.
121 * @return true if this control supports two dimensional keyboard navigation.
123 bool IsKeyboardNavigationSupported();
126 * @brief Sets whether this control is a focus group for keyboard navigation.
128 * (i.e. the scope of keyboard focus movement
129 * can be limitied to its child actors). The control is not a focus group by default.
130 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
132 void SetAsKeyboardFocusGroup(bool isFocusGroup);
135 * @brief Gets whether this control is a focus group for keyboard navigation.
137 * @return true if this control is set as a focus group for keyboard navigation.
139 bool IsKeyboardFocusGroup();
142 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
144 * A control needs to override this function in order to support two dimensional keyboard navigation.
145 * @param[in] currentFocusedActor The current focused actor.
146 * @param[in] direction The direction to move the focus towards.
147 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
148 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
150 virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
153 * @brief Informs this control that its chosen focusable actor will be focused.
155 * This allows the application to preform any actions if wishes
156 * before the focus is actually moved to the chosen actor.
158 * @param[in] commitedFocusableActor The commited focusable actor.
160 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor) { }
163 * @brief Performs actions as requested using the action name.
165 * @param[in] object The object on which to perform the action.
166 * @param[in] actionName The action to perform.
167 * @param[in] attributes The attributes with which to perfrom this action.
168 * @return true if action has been accepted by this control
170 static bool DoAction(BaseObject* object, const std::string& actionName, const std::vector<Property::Value>& attributes);
173 * @brief If deriving classes wish to fine tune pinch gesture
174 * detection then they can access the gesture detector through this
175 * API and modify the detection.
177 * @return The pinch gesture detector.
178 * @pre Pinch detection should have been enabled via EnableGestureDetection().
179 * @see EnableGestureDetection
181 PinchGestureDetector GetPinchGestureDetector() const;
184 * @brief If deriving classes wish to fine tune pan gesture
185 * detection then they can access the gesture detector through this
186 * API and modify the detection.
188 * @return The pan gesture detector.
189 * @pre Pan detection should have been enabled via EnableGestureDetection().
190 * @see EnableGestureDetection
192 PanGestureDetector GetPanGestureDetector() const;
195 * @brief If deriving classes wish to fine tune tap gesture
196 * detection then they can access the gesture detector through this
197 * API and modify the detection.
199 * @return The tap gesture detector.
200 * @pre Tap detection should have been enabled via EnableGestureDetection().
201 * @see EnableGestureDetection
203 TapGestureDetector GetTapGestureDetector() const;
206 * @brief If deriving classes wish to fine tune long press gesture
207 * detection then they can access the gesture detector through this
208 * API and modify the detection.
210 * @return The long press gesture detector.
211 * @pre Long press detection should have been enabled via EnableGestureDetection().
212 * @see EnableGestureDetection
214 LongPressGestureDetector GetLongPressGestureDetector() const;
219 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
221 void SetBackgroundColor( const Vector4& color );
224 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
226 Vector4 GetBackgroundColor() const;
229 * @copydoc Dali::Toolkit::Control::SetBackground
231 void SetBackground( Image image );
234 * @copydoc Dali::Toolkit::Control::ClearBackground
236 void ClearBackground();
239 * @copydoc Dali::Toolkit::Control::GetBackgroundActor
241 Actor GetBackgroundActor() const;
246 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
248 Toolkit::Control::KeyEventSignalV2& KeyEventSignal();
255 * @brief Second phase initialization.
262 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
264 * Gesture detection can be enabled one at a time or in bitwise format as shown:
266 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
268 * @param[in] type The gesture type(s) to enable.
270 void EnableGestureDetection(Gesture::Type type);
273 * @brief Allows deriving classes to disable any of the gesture detectors.
275 * Like EnableGestureDetection, this can also be called using bitwise or.
276 * @param[in] type The gesture type(s) to disable.
277 * @see EnableGetureDetection
279 void DisableGestureDetection(Gesture::Type type);
281 private: // For derived classes to override
284 * @brief This method is called after the Control has been initialized.
286 * Derived classes should do any second phase initialization by
287 * overriding this method.
289 virtual void OnInitialize() { }
292 * @brief This method should be overridden by deriving classes when
293 * they wish to be notified when the style changes.
295 * @param[in] change Information denoting what has changed.
297 virtual void OnStyleChange(StyleChange change) { }
300 * @brief Called whenever a pinch gesture is detected on this control.
302 * This can be overridden by deriving classes when pinch detection
303 * is enabled. The default behaviour is to scale the control by the
306 * @note If overridden, then the default behaviour will not occur.
307 * @note Pinch detection should be enabled via EnableGestureDetection().
308 * @param[in] pinch The pinch gesture.
309 * @see EnableGestureDetection
311 virtual void OnPinch(PinchGesture pinch);
314 * @brief Called whenever a pan gesture is detected on this control.
316 * This should be overridden by deriving classes when pan detection
319 * @note There is no default behaviour with panning.
320 * @note Pan detection should be enabled via EnableGestureDetection().
321 * @param[in] pan The pan gesture.
322 * @see EnableGestureDetection
324 virtual void OnPan(PanGesture pan) { }
327 * @brief Called whenever a tap gesture is detected on this control.
329 * This should be overridden by deriving classes when tap detection
332 * @note There is no default behaviour with a tap.
333 * @note Tap detection should be enabled via EnableGestureDetection().
334 * @param[in] tap The tap gesture.
335 * @see EnableGestureDetection
337 virtual void OnTap(TapGesture tap) { }
340 * @brief Called whenever a long press gesture is detected on this control.
342 * This should be overridden by deriving classes when long press
343 * detection is enabled.
345 * @note There is no default behaviour associated with a long press.
346 * @note Long press detection should be enabled via EnableGestureDetection().
347 * @param[in] longPress The long press gesture.
348 * @see EnableGestureDetection
350 virtual void OnLongPress(LongPressGesture longPress) { }
353 * @brief Called whenever the control is added to the stage.
355 * Could be overridden by derived classes.
357 virtual void OnControlStageConnection() { }
360 * @brief Called whenever the control is removed from the stage.
362 * Could be overridden by derived classes.
364 virtual void OnControlStageDisconnection() { }
367 * @brief Called whenever an Actor is added to the control.
369 * Could be overridden by derived classes.
371 * @param[in] child The added actor.
373 virtual void OnControlChildAdd( Actor& child ) { }
376 * @brief Called whenever an Actor is removed from the control.
378 * Could be overridden by derived classes.
380 * @param[in] child The removed actor.
382 virtual void OnControlChildRemove( Actor& child ) { }
385 * @brief Called whenever the Control's size is set.
387 * Could be overridden by derived classes.
389 * @param[in] size The new size.
391 virtual void OnControlSizeSet( const Vector3& size ) { }
394 * @brief Called after the Dali::Stage::SignalMessageQueueFlushed()
395 * signal is emitted if this control requested to be relaid-out.
397 * Should be overridden by derived classes if they need to layout
398 * actors differently after certain operations like add or remove
399 * actors, resize or after changing especific properties.
401 * @param[in] size The allocated size.
402 * @param[in,out] container The control should add actors to this container that it is not able
403 * to allocate a size for.
405 virtual void OnRelaidOut( Vector2 size, ActorSizeContainer& container );
407 private: // From CustomActorImpl, derived classes can override these.
410 * @brief Sends a request to relayout this control.
412 * The control will be relaid out after the
413 * Dali::Stage::SignalMessageQueueFlushed() signal is emitted.
415 * It calls OnControlStageConnection() to notify derived classes.
417 * @see Dali::CustomActorImpl::OnStageConnection()
419 virtual void OnStageConnection();
422 * @brief Calls OnControlStageDisconnection() to notify derived classed.
424 * @see Dali::CustomActorImpl::OnStageDisconnection()
426 virtual void OnStageDisconnection();
429 * @brief Sends a request to relayout this control.
431 * The control will be relaid out after the
432 * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It
433 * calls OnControlChildAdd() to notify derived classes.
435 * @note This method shouldn't be overridden by derived classes.
437 * @param[in] child The added actor.
439 * @see Dali::CustomActorImpl::OnChildAdd(Actor&)
441 virtual void OnChildAdd(Actor& child);
444 * @brief Sends a request to relayout this control.
446 * The control will be relaid out after the
447 * Dali::Stage::SignalMessageQueueFlushed() signal is emitted. It
448 * calls OnControlChildRemove() to notify derived classes.
450 * @note This method shouldn't be overridden by derived classes.
452 * @param[in] child The removed actor.
454 * @see Dali::CustomActorImpl::OnChildRemove(Actor&)
456 virtual void OnChildRemove(Actor& child);
459 * @brief It stores the size set by size negotiation and relayout.
461 * It also keeps a backup of the size set through the Actor's API used in the size negotiation.
462 * It calls the OnControlSizeSet() to notify derived classes.
464 * @param[in] targetSize The new size.
466 * @see Dali::CustomActorImpl::OnSizeSet(const Vector3&)
468 virtual void OnSizeSet(const Vector3& targetSize);
471 * @copydoc Dali::CustomActorImpl::OnSizeAnimation(Animation&, const Vector3&)
473 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
476 * @copydoc Dali::CustomActorImpl::OnTouchEvent(const TouchEvent&)
478 virtual bool OnTouchEvent(const TouchEvent& event);
481 * @copydoc Dali::CustomActorImpl::OnKeyEvent(const KeyEvent&)
483 virtual bool OnKeyEvent(const KeyEvent& event);
486 * @copydoc Dali::CustomActorImpl::OnMouseWheelEvent(const MouseWheelEvent&)
488 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
491 * @copydoc Dali::CustomActorImpl::OnKeyInputFocusGained()
493 virtual void OnKeyInputFocusGained();
496 * @copydoc Dali::CustomActorImpl::OnKeyInputFocusLost()
498 virtual void OnKeyInputFocusLost();
501 * @copydoc Dali::CustomActorImpl::GetChildByAlias(const std::string& actorAlias)
503 virtual Actor GetChildByAlias(const std::string& actorAlias);
508 * @brief Perform the activated action.
510 * @param[in] attributes The attributes to perfrom this action.
512 void DoActivatedAction(const PropertyValueContainer& attributes);
514 protected: // Construction
517 * @brief Create a Control.
519 * @param[in] requiresTouchEvents True if the OnTouchEvent() callback is required.
521 Control(bool requiresTouchEvents);
528 * @copydoc Toolkit::Control::SetSizePolicy()
530 void SetSizePolicy( Toolkit::Control::SizePolicy widthPolicy, Toolkit::Control::SizePolicy heightPolicy );
533 * @copydoc Toolkit::Control::GetSizePolicy()
535 void GetSizePolicy( Toolkit::Control::SizePolicy& widthPolicy, Toolkit::Control::SizePolicy& heightPolicy ) const;
538 * @copydoc Toolkit::Control::SetMinimumSize()
540 void SetMinimumSize( const Vector3& size );
543 * @copydoc Toolkit::Control::GetMinimumSize()
545 const Vector3& GetMinimumSize() const;
548 * @copydoc Toolkit::Control::SetMaximumSize()
550 void SetMaximumSize( const Vector3& size );
553 * @copydoc Toolkit::Control::GetMaximumSize()
555 const Vector3& GetMaximumSize() const;
558 * @copydoc Toolkit::Control::GetNaturalSize()
560 virtual Vector3 GetNaturalSize();
563 * @copydoc Toolkit::Control::GetHeightForWidth()
565 virtual float GetHeightForWidth( float width );
568 * @copydoc Toolkit::Control::GetWidthForHeight()
570 virtual float GetWidthForHeight( float height );
573 * @brief Retrieves the current Control's size.
575 * @return The control's size.
577 const Vector3& GetControlSize() const;
580 * @brief Retrieves the Control's size set by the Application / Control.
582 * @return The control's size.
584 const Vector3& GetSizeSet() const;
589 * @copydoc Toolkit::Control::SetKeyInputFocus()
591 void SetKeyInputFocus();
594 * @copydoc Toolkit::Control::HasKeyInputFocus()
596 bool HasKeyInputFocus();
599 * @copydoc Toolkit::Control::ClearKeyInputFocus()
601 void ClearKeyInputFocus();
604 * @copydoc ConnectionTrackerInterface::SignalConnected
606 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
609 * @copydoc ConnectionTrackerInterface::SignalDisconnected
611 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
614 * @copydoc ConnectionTrackerInterface::GetConnectionCount
616 virtual std::size_t GetConnectionCount() const;
621 * @brief Sends a request to be relaid-out.
623 * This method is called from OnStageConnection(), OnChildAdd(),
624 * OnChildRemove(), SetSizePolicy(), SetMinimumSize() and
627 * This method could also be called from derived classes every time
628 * a control's poperty change and it needs to be relaid-out. After
629 * the Dali::Stage::SignalMessageQueueFlushed() is emitted a
630 * relayout process starts and all controls which called this method
631 * will be relaid-out.
633 * @note RelayoutRequest() only sends a request per Control before
634 * the Dali::Stage::SignalMessageQueueFlushed() signal is
635 * emitted. That means a control will be relaid-out only once, even
636 * if more than one request is sent between two consecutive signals.
638 void RelayoutRequest();
641 * @brief Helper method for controls to Relayout their children if
642 * they do not know whether that child is a control or not.
644 * @param[in] actor The actor to relayout.
645 * @param[in] size The size to allocate to the actor.
646 * @param[in,out] container The container that holds actors that have not been allocated a size yet.
648 static void Relayout( Actor actor, Vector2 size, ActorSizeContainer& container );
650 private: // Used by the RelayoutController
653 * @brief Called by the RelayoutController to negotiate the size of a control.
655 * The size allocated by the the algorithm is passed in which the
656 * control must adhere to. A container is passed in as well which
657 * the control should populate with actors it has not / or does not
658 * need to handle in its size negotiation.
660 * @param[in] size The allocated size.
661 * @param[in,out] container The container that holds actors that are fed back into the
662 * RelayoutController algorithm.
664 void NegotiateSize( Vector2 size, ActorSizeContainer& container );
669 * @brief Called by NegotiateSize when the size to allocate to the control has been calculated.
671 * It calls the OnRelaidOut() method which can be overridden by derived classes.
673 * @param[in] size The allocated size.
674 * @param[in,out] container The control should add actors to this container that it is not able
675 * to allocate a size for.
677 void Relayout( Vector2 size, ActorSizeContainer& container );
680 * @brief Used by the KeyInputFocusManager to emit key event signals.
682 * @param[in] event The key event.
683 * @return True if the event was consumed.
685 bool EmitKeyEventSignal(const KeyEvent& event);
692 Control(const Control&);
693 Control& operator=(const Control&);
698 friend class Internal::StyleChangeProcessor;
699 friend class Internal::RelayoutControllerImpl; ///< Relayout controller needs to call Relayout() which is private.
700 friend class Internal::KeyInputFocusManager; ///< KeyInputFocusManager needs to call which is private.
703 } // namespace Internal
705 typedef Internal::Control ControlImpl; ///< @deprecated, Use Internal::Control
707 } // namespace Toolkit
714 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__