1 #ifndef __DALI_TOOLKIT_CONTROL_H__
2 #define __DALI_TOOLKIT_CONTROL_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/actors/custom-actor.h>
23 #include <dali/public-api/common/dali-common.h>
24 #include <dali/public-api/events/long-press-gesture-detector.h>
25 #include <dali/public-api/events/pan-gesture-detector.h>
26 #include <dali/public-api/events/pinch-gesture-detector.h>
27 #include <dali/public-api/events/tap-gesture-detector.h>
28 #include <dali/public-api/events/tap-gesture-detector.h>
29 #include <dali/public-api/images/image.h>
37 //Forward declarations.
44 * @addtogroup dali_toolkit_controls
49 * @brief Control is the base class for all controls.
51 * The implementation of the control must be supplied; see Internal::Control for more details.
53 * @see Internal::Control
56 * | %Signal Name | Method |
57 * |------------------------|-----------------------------------------------------|
58 * | keyEvent | @ref KeyEventSignal() |
59 * | keyInputFocusGained | @ref KeyInputFocusGainedSignal() |
60 * | keyInputFocusLost | @ref KeyInputFocusLostSignal() |
61 * | tapped | @ref GetTapGestureDetector().DetectedSignal() |
62 * | panned | @ref GetPanGestureDetector().DetectedSignal() |
63 * | pinched | @ref GetPinchGestureDetector().DetectedSignal() |
64 * | longPressed | @ref GetLongPressGestureDetector().DetectedSignal() |
67 * | %Action Name | %Control method called |
68 * |------------------------|----------------------------------------------------|
69 * | accessibilityActivated | %OnAccessibilityActivated() |
71 class DALI_IMPORT_API Control : public CustomActor
76 * @brief The start and end property ranges for control.
81 PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro. @SINCE_1_0.0
82 CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties. @SINCE_1_0.0
83 CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0
87 * @brief An enumeration of properties belonging to the Control class.
93 * @brief An enumeration of properties belonging to the Control class.
99 * @brief name "styleName", type std::string
103 STYLE_NAME = PROPERTY_START_INDEX,
106 * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4
113 * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map
118 * @brief name "keyInputFocus", type bool
120 * @see SetKeyInputFocus
124 * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL
132 * @brief Describes the direction to move the keyboard focus towards.
138 * @brief Keyboard focus direction
143 LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
144 RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0
145 UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0
146 DOWN ///< Move keyboard focus towards the down direction @SINCE_1_0.0
152 /// @brief Key Event signal type;
153 typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
155 /// @brief Key InputFocusType signal type;
156 typedef Signal<void ( Control ) > KeyInputFocusSignalType;
158 public: // Creation & Destruction
161 * @brief Create a new instance of a Control.
164 * @return A handle to a new Control.
166 static Control New();
169 * @brief Create an uninitialized Control handle.
171 * Only derived versions can be instantiated. Calling member
172 * functions with an uninitialized Dali::Object is not allowed.
178 * @brief Copy constructor.
180 * Creates another handle that points to the same real object.
182 * @param[in] uiControl Handle to copy
184 Control(const Control& uiControl);
187 * @brief Dali::Control is intended as a base class.
189 * This is non-virtual since derived Handle types must not contain data or virtual methods.
197 * @brief Assignment operator.
199 * Changes this handle to point to another real object.
201 * @param[in] handle Object to assign this to
202 * @return reference to this
204 Control& operator=( const Control& handle );
209 * @brief Downcast a handle to Control handle.
211 * If handle points to a Control the downcast produces valid
212 * handle. If not the returned handle is left uninitialized.
215 * @param[in] handle Handle to an object
216 * @return A handle to a Control or an uninitialized handle
218 static Control DownCast( BaseHandle handle );
223 * @brief This sets the control to receive key events.
225 * The key event can originate from a virtual or physical keyboard.
227 * @pre The Control has been initialized.
228 * @pre The Control should be on the stage before setting keyboard focus.
230 void SetKeyInputFocus();
233 * @brief Quries whether the control has key input focus.
236 * @return true if this control has keyboard input focus
237 * @pre The Control has been initialized.
238 * @pre The Control should be on the stage before setting keyboard focus.
239 * @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.
240 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
241 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
242 * controls above it in the focus stack.
243 * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
245 bool HasKeyInputFocus();
248 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
250 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
252 * @pre The Actor has been initialized.
254 void ClearKeyInputFocus();
259 * @brief Retrieves the pinch gesture detector of the control.
262 * @return The pinch gesture detector.
263 * @note Will return an empty handle if the control does not handle the gesture itself.
265 PinchGestureDetector GetPinchGestureDetector() const;
268 * @brief Retrieves the pan gesture detector of the control.
271 * @return The pan gesture detector.
272 * @note Will return an empty handle if the control does not handle the gesture itself.
274 PanGestureDetector GetPanGestureDetector() const;
277 * @brief Retrieves the tap gesture detector of the control.
280 * @return The tap gesture detector.
281 * @note Will return an empty handle if the control does not handle the gesture itself.
283 TapGestureDetector GetTapGestureDetector() const;
286 * @brief Retrieves the long press gesture detector of the control.
289 * @return The long press gesture detector.
290 * @note Will return an empty handle if the control does not handle the gesture itself.
292 LongPressGestureDetector GetLongPressGestureDetector() const;
297 * @brief Sets the name of the style to be applied to the control.
300 * @param[in] styleName A string matching a style described in a stylesheet.
302 void SetStyleName( const std::string& styleName );
305 * @brief Retrieves the name of the style to be applied to the control (if any).
307 * @return A string matching a style or an empty string.
309 const std::string& GetStyleName() const;
314 * @brief Sets the background color of the control.
317 * @param[in] color The required background color of the control
319 * @note if SetBackgroundImage is called later, this background color is removed.
321 * @note The background color fully blends with the actor color.
323 void SetBackgroundColor( const Vector4& color );
328 * @brief Retrieves the background color of the control.
331 * @return The background color of the control.
333 Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
336 * @DEPRECATED_1_2_8, use Property::BACKGROUND instead
338 * @brief Sets an image as the background of the control.
341 * @param[in] image The image to set as the background.
343 void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
346 * @brief Clears the background.
349 void ClearBackground();
354 * @brief This signal is emitted when key event is received.
356 * A callback of the following type may be connected:
358 * bool YourCallbackName(Control control, const KeyEvent& event);
360 * The return value of True, indicates that the event should be consumed.
361 * Otherwise the signal will be emitted on the next parent of the actor.
363 * @return The signal to connect to.
364 * @pre The Control has been initialized.
366 KeyEventSignalType& KeyEventSignal();
369 * @brief This signal is emitted when the control gets Key Input Focus.
371 * A callback of the following type may be connected:
373 * bool YourCallbackName( Control control );
375 * The return value of True, indicates that the event should be consumed.
376 * Otherwise the signal will be emitted on the next parent of the actor.
378 * @return The signal to connect to.
379 * @pre The Control has been initialized.
381 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
384 * @brief This signal is emitted when the control loses Key Input Focus
385 * which could be due to it being gained by another Control or Actor or just cleared from
386 * this control as no longer required.
388 * A callback of the following type may be connected:
390 * bool YourCallbackName( Control control );
392 * The return value of True, indicates that the event should be consumed.
393 * Otherwise the signal will be emitted on the next parent of the actor.
395 * @return The signal to connect to.
396 * @pre The Control has been initialized.
398 KeyInputFocusSignalType& KeyInputFocusLostSignal();
400 public: // Intended for control developers
403 * @brief Create an initialised Control.
406 * @param[in] implementation The implementation for this control.
407 * @return A handle to a newly allocated Dali resource.
409 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
411 explicit Control(Internal::Control& implementation);
414 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
415 * using an Internal CustomActor pointer.
418 * @param [in] internal A pointer to a newly allocated Dali resource
420 explicit Control(Dali::Internal::CustomActor* internal);
422 public: // Templates for Deriving Classes
425 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
427 * @tparam T The handle class
428 * @tparam I The implementation class
430 * @param[in] handle Handle to an object
431 * @return Handle to a class T or an uninitialized handle.
432 * @see DownCast(BaseHandle)
434 template<typename T, typename I>
435 DALI_INTERNAL static T DownCast( BaseHandle handle )
439 CustomActor custom = Dali::CustomActor::DownCast( handle );
442 CustomActorImpl& customImpl = custom.GetImplementation();
444 I* impl = dynamic_cast<I*>(&customImpl);
448 result = T(customImpl.GetOwner());
456 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
457 * implementation of their class.
459 * @tparam I The implementation class
461 * @param[in] internal Pointer to the Internal::CustomActor
464 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
466 // Can have a NULL pointer so we only need to check if the internal implementation is our class
467 // when there is a value.
470 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
479 } // namespace Toolkit
483 #endif // __DALI_TOOLKIT_CONTROL_H__