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>
43 class KeyboardFocusManager;
44 class KeyInputFocusManager;
47 * @brief This is the internal base class for all controls.
49 * It will provide some common functionality required by all controls.
50 * Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
51 * be disconnected automatically when the control is destroyed.
53 class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
57 class Extension; ///< Forward declare future extension interface
59 // Creation & Destruction
62 * @brief Create a new ControlImpl instance that does not require touch by default.
64 * If touch is required then the user can connect to this class' touch signal.
65 * @return A handle to the ControlImpl instance.
67 static Toolkit::Control New();
70 * @brief Virtual destructor.
77 * @copydoc Toolkit::Control::SetKeyInputFocus()
79 void SetKeyInputFocus();
82 * @copydoc Toolkit::Control::HasKeyInputFocus()
84 bool HasKeyInputFocus();
87 * @copydoc Toolkit::Control::ClearKeyInputFocus()
89 void ClearKeyInputFocus();
94 * @brief If deriving classes wish to fine tune pinch gesture
95 * detection then they can access the gesture detector through this
96 * API and modify the detection.
98 * @return The pinch gesture detector.
99 * @pre Pinch detection should have been enabled via EnableGestureDetection().
100 * @see EnableGestureDetection
102 PinchGestureDetector GetPinchGestureDetector() const;
105 * @brief If deriving classes wish to fine tune pan gesture
106 * detection then they can access the gesture detector through this
107 * API and modify the detection.
109 * @return The pan gesture detector.
110 * @pre Pan detection should have been enabled via EnableGestureDetection().
111 * @see EnableGestureDetection
113 PanGestureDetector GetPanGestureDetector() const;
116 * @brief If deriving classes wish to fine tune tap gesture
117 * detection then they can access the gesture detector through this
118 * API and modify the detection.
120 * @return The tap gesture detector.
121 * @pre Tap detection should have been enabled via EnableGestureDetection().
122 * @see EnableGestureDetection
124 TapGestureDetector GetTapGestureDetector() const;
127 * @brief If deriving classes wish to fine tune long press gesture
128 * detection then they can access the gesture detector through this
129 * API and modify the detection.
131 * @return The long press gesture detector.
132 * @pre Long press detection should have been enabled via EnableGestureDetection().
133 * @see EnableGestureDetection
135 LongPressGestureDetector GetLongPressGestureDetector() const;
140 * @copydoc Dali::Toolkit::Control::SetStyleName
142 void SetStyleName( const std::string& styleName );
145 * @copydoc Dali::Toolkit::Control::GetStyleName
147 const std::string& GetStyleName() const;
152 * @copydoc Dali::Toolkit::Control::SetBackgroundColor
154 void SetBackgroundColor( const Vector4& color );
157 * @copydoc Dali::Toolkit::Control::GetBackgroundColor
159 Vector4 GetBackgroundColor() const;
162 * @copydoc Dali::Toolkit::Control::SetBackgroundImage
164 void SetBackgroundImage( Image image );
167 * @copydoc Dali::Toolkit::Control::ClearBackground
169 void ClearBackground();
171 // Keyboard Navigation
174 * @brief Sets whether this control supports two dimensional
175 * keyboard navigation (i.e. whether it knows how to handle the
176 * keyboard focus movement between its child actors).
178 * The control doesn't support it by default.
179 * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
181 void SetKeyboardNavigationSupport(bool isSupported);
184 * @brief Gets whether this control supports two dimensional keyboard navigation.
186 * @return true if this control supports two dimensional keyboard navigation.
188 bool IsKeyboardNavigationSupported();
190 // Called by Focus Managers
193 * @brief Called by the focus manager and keyboard focus manager to Activate the Control
195 DALI_INTERNAL void Activate();
200 * @brief Sets whether this control is a focus group for keyboard navigation.
202 * (i.e. the scope of keyboard focus movement
203 * can be limitied to its child actors). The control is not a focus group by default.
204 * @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
206 void SetAsKeyboardFocusGroup(bool isFocusGroup);
209 * @brief Gets whether this control is a focus group for keyboard navigation.
211 * @return true if this control is set as a focus group for keyboard navigation.
213 bool IsKeyboardFocusGroup();
216 * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
218 * Should be called last by the control after it acts on the Input Focus change.
220 * @param[in] focusGained True if gained, False if lost
222 void EmitKeyInputFocusSignal( bool focusGained );
227 * @brief Performs actions as requested using the action name.
229 * @param[in] object The object on which to perform the action.
230 * @param[in] actionName The action to perform.
231 * @param[in] attributes The attributes with which to perfrom this action.
232 * @return true if action has been accepted by this control
234 static bool DoAction(BaseObject* object, const std::string& actionName, const PropertyValueContainer& attributes);
237 * Connects a callback function with the object's signals.
238 * @param[in] object The object providing the signal.
239 * @param[in] tracker Used to disconnect the signal.
240 * @param[in] signalName The signal to connect to.
241 * @param[in] functor A newly allocated FunctorDelegate.
242 * @return True if the signal was connected.
243 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
245 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
248 * @copydoc Dali::Toolkit::Control::KeyEventSignal()
250 Toolkit::Control::KeyEventSignalType& KeyEventSignal();
253 * @copydoc Dali::Toolkit::Control::KeyInputFocusGainedSignal()
255 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusGainedSignal();
258 * @copydoc Dali::Toolkit::Control::KeyInputFocusLostSignal()
260 Toolkit::Control::KeyInputFocusSignalType& KeyInputFocusLostSignal();
263 * @brief Called by the KeyInputFocusManager to emit key event signals.
265 * @param[in] event The key event.
266 * @return True if the event was consumed.
268 DALI_INTERNAL bool EmitKeyEventSignal(const KeyEvent& event);
270 protected: // From CustomActorImpl, not to be used by application developers
273 * @copydoc CustomActorImpl::OnStageConnection()
275 virtual void OnStageConnection();
278 * @copydoc CustomActorImpl::OnStageDisconnection()
280 virtual void OnStageDisconnection();
283 * @copydoc CustomActorImpl::OnChildAdd()
285 virtual void OnChildAdd(Actor& child);
288 * @copydoc CustomActorImpl::OnChildRemove()
290 virtual void OnChildRemove(Actor& child);
293 * @copydoc CustomActorImpl::OnSizeSet()
295 virtual void OnSizeSet(const Vector3& targetSize);
298 * @copydoc CustomActorImpl::OnSizeAnimation()
300 virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize);
303 * @copydoc CustomActorImpl::OnTouchEvent()
305 virtual bool OnTouchEvent(const TouchEvent& event);
308 * @copydoc CustomActorImpl::OnHoverEvent()
310 virtual bool OnHoverEvent(const HoverEvent& event);
313 * @copydoc CustomActorImpl::OnKeyEvent()
315 virtual bool OnKeyEvent(const KeyEvent& event);
318 * @copydoc CustomActorImpl::OnMouseWheelEvent()
320 virtual bool OnMouseWheelEvent(const MouseWheelEvent& event);
323 * @copydoc CustomActorImpl::OnRelayout()
325 virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
328 * @copydoc CustomActorImpl::OnSetResizePolicy()
330 virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
333 * @copydoc CustomActorImpl::GetNaturalSize()
335 virtual Vector3 GetNaturalSize();
338 * @copydoc CustomActorImpl::CalculateChildSize()
340 virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension );
343 * @copydoc CustomActorImpl::GetHeightForWidth()
345 virtual float GetHeightForWidth( float width );
348 * @copydoc CustomActorImpl::GetWidthForHeight()
350 virtual float GetWidthForHeight( float height );
353 * @copydoc CustomActorImpl::RelayoutDependentOnChildren()
355 virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
358 * @copydoc CustomActorImpl::OnCalculateRelayoutSize()
360 virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
363 * @copydoc CustomActorImpl::OnLayoutNegotiated()
365 virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
367 protected: // Helpers for deriving classes
371 // Flags for the constructor
372 enum ControlBehaviour
374 REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
375 REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
377 LAST_CONTROL_BEHAVIOUR_FLAG
380 static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
383 * @brief Control constructor
385 * @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
387 Control( ControlBehaviour behaviourFlags );
390 * @brief Second phase initialization.
397 * @brief Allows deriving classes to enable any of the gesture detectors that are available.
399 * Gesture detection can be enabled one at a time or in bitwise format as shown:
401 * EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
403 * @param[in] type The gesture type(s) to enable.
405 void EnableGestureDetection( Gesture::Type type );
408 * @brief Allows deriving classes to disable any of the gesture detectors.
410 * Like EnableGestureDetection, this can also be called using bitwise or.
411 * @param[in] type The gesture type(s) to disable.
412 * @see EnableGetureDetection
414 void DisableGestureDetection( Gesture::Type type );
416 public: // API for derived classes to override
421 * @brief This method is called after the Control has been initialized.
423 * Derived classes should do any second phase initialization by overriding this method.
425 virtual void OnInitialize();
428 * @brief Called whenever the control is added to the stage.
430 * Could be overridden by derived classes.
432 virtual void OnControlStageConnection();
435 * @brief Called whenever the control is removed from the stage.
437 * Could be overridden by derived classes.
439 virtual void OnControlStageDisconnection();
442 * @brief Called whenever an Actor is added to the control.
444 * Could be overridden by derived classes.
446 * @param[in] child The added actor.
448 virtual void OnControlChildAdd( Actor& child );
451 * @brief Called whenever an Actor is removed from the control.
453 * Could be overridden by derived classes.
455 * @param[in] child The removed actor.
457 virtual void OnControlChildRemove( Actor& child );
462 * @brief This method should be overridden by deriving classes requiring notifications when the style changes.
464 * @param[in] styleManager The StyleManager object.
465 * @param[in] change Information denoting what has changed.
467 virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
472 * @brief Called whenever the Control's size is set.
474 * @param[in] size The new size.
476 virtual void OnControlSizeSet( const Vector3& size );
481 * @brief This method is called when the control is accessibility activated.
483 * Derived classes should override this to perform custom accessibility activation.
485 virtual void OnAccessibilityActivated();
488 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
491 * @param[in] gesture The pan gesture.
492 * @return true if the pan gesture has been consumed by this control
494 virtual bool OnAccessibilityPan(PanGesture gesture);
497 * @brief This method should be overridden by deriving classes when they wish to respond the accessibility
500 * @param[in] touchEvent The touch event.
501 * @return true if the touch event has been consumed by this control
503 virtual bool OnAccessibilityTouch(const TouchEvent& touchEvent);
506 * @brief This method should be overridden by deriving classes when they wish to respond
507 * the accessibility up and down action (i.e. value change of slider control).
509 * @param[in] isIncrease Whether the value should be increased or decreased
510 * @return true if the value changed action has been consumed by this control
512 virtual bool OnAccessibilityValueChange(bool isIncrease);
517 * @brief Called when the control gains key input focus.
519 * Should be overridden by derived classes if they need to customize what happens when focus is gained.
521 virtual void OnKeyInputFocusGained();
524 * @brief Called when the control loses key input focus.
526 * Should be overridden by derived classes if they need to customize what happens when focus is lost.
528 virtual void OnKeyInputFocusLost();
531 * @brief Gets the next keyboard focusable actor in this control towards the given direction.
533 * A control needs to override this function in order to support two dimensional keyboard navigation.
534 * @param[in] currentFocusedActor The current focused actor.
535 * @param[in] direction The direction to move the focus towards.
536 * @param[in] loopEnabled Whether the focus movement should be looped within the control.
537 * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
539 virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
542 * @brief Informs this control that its chosen focusable actor will be focused.
544 * This allows the application to preform any actions if wishes
545 * before the focus is actually moved to the chosen actor.
547 * @param[in] commitedFocusableActor The commited focusable actor.
549 virtual void OnKeyboardFocusChangeCommitted(Actor commitedFocusableActor);
554 * @brief Called whenever a pinch gesture is detected on this control.
556 * This can be overridden by deriving classes when pinch detection
557 * is enabled. The default behaviour is to scale the control by the
560 * @note If overridden, then the default behaviour will not occur.
561 * @note Pinch detection should be enabled via EnableGestureDetection().
562 * @param[in] pinch The pinch gesture.
563 * @see EnableGestureDetection
565 virtual void OnPinch(const PinchGesture& pinch);
568 * @brief Called whenever a pan gesture is detected on this control.
570 * This should be overridden by deriving classes when pan detection
573 * @note There is no default behaviour with panning.
574 * @note Pan detection should be enabled via EnableGestureDetection().
575 * @param[in] pan The pan gesture.
576 * @see EnableGestureDetection
578 virtual void OnPan( const PanGesture& pan );
581 * @brief Called whenever a tap gesture is detected on this control.
583 * This should be overridden by deriving classes when tap detection
586 * @note There is no default behaviour with a tap.
587 * @note Tap detection should be enabled via EnableGestureDetection().
588 * @param[in] tap The tap gesture.
589 * @see EnableGestureDetection
591 virtual void OnTap( const TapGesture& tap );
594 * @brief Called whenever a long press gesture is detected on this control.
596 * This should be overridden by deriving classes when long press
597 * detection is enabled.
599 * @note There is no default behaviour associated with a long press.
600 * @note Long press detection should be enabled via EnableGestureDetection().
601 * @param[in] longPress The long press gesture.
602 * @see EnableGestureDetection
604 virtual void OnLongPress( const LongPressGesture& longPress );
606 // From ConnectionTrackerInterface
609 * @copydoc ConnectionTrackerInterface::SignalConnected
611 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
614 * @copydoc ConnectionTrackerInterface::SignalDisconnected
616 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
619 * Retrieve the extension for this control
621 * @return The extension if available, NULL otherwise
623 virtual Extension* GetControlExtension()
631 DALI_INTERNAL Control(const Control&);
632 DALI_INTERNAL Control& operator=(const Control&);
640 * @brief Get implementation from the handle
642 * @pre handle is initialized and points to a control
644 * @return implementation
646 Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
649 * @brief Get implementation from the handle
651 * @pre handle is initialized and points to a control
653 * @return implementation
655 const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
657 } // namespace Internal
659 } // namespace Toolkit
663 #endif // __DALI_TOOLKIT_CONTROL_IMPL_H__