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.
95 * @brief name "styleName", type std::string
99 STYLE_NAME = PROPERTY_START_INDEX,
102 * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4
109 * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map
114 * @brief name "keyInputFocus", type bool
116 * @see SetKeyInputFocus
120 * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map
128 * @brief Describes the direction to move the keyboard focus towards.
135 LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
136 RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0
137 UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0
138 DOWN ///< Move keyboard focus towards the down direction @SINCE_1_0.0
144 /// @brief Key Event signal type;
145 typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
147 /// @brief Key InputFocusType signal type;
148 typedef Signal<void ( Control ) > KeyInputFocusSignalType;
150 public: // Creation & Destruction
153 * @brief Create a new instance of a Control.
156 * @return A handle to a new Control.
158 static Control New();
161 * @brief Create an uninitialized Control handle.
163 * Only derived versions can be instantiated. Calling member
164 * functions with an uninitialized Dali::Object is not allowed.
170 * @brief Copy constructor.
172 * Creates another handle that points to the same real object
174 * @param[in] uiControl Handle to copy
176 Control(const Control& uiControl);
179 * @brief Dali::Control is intended as a base class
181 * This is non-virtual since derived Handle types must not contain data or virtual methods.
189 * @brief Assignment operator.
191 * Changes this handle to point to another real object
193 * @param[in] handle Object to assign this to
194 * @return reference to this
196 Control& operator=( const Control& handle );
201 * @brief Downcast an Object handle to Control.
203 * If handle points to a Control the downcast produces valid
204 * handle. If not the returned handle is left uninitialized.
207 * @param[in] handle Handle to an object
208 * @return handle to a Control or an uninitialized handle
210 static Control DownCast( BaseHandle handle );
215 * @brief This sets the control to receive key events.
217 * The key event can originate from a virtual or physical keyboard.
219 * @return True if the control has foucs, False otherwise.
220 * @pre The Control has been initialized.
221 * @pre The Control should be on the stage before setting keyboard focus.
223 void SetKeyInputFocus();
226 * @brief Quries whether the control has key input focus.
228 * 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.
229 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
230 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
231 * controls above it in the focus stack.
232 * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor()
234 * @return true if this control has keyboard input focus
235 * @pre The Control has been initialized.
236 * @pre The Control should be on the stage before setting keyboard focus.
238 bool HasKeyInputFocus();
241 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
243 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
245 * @pre The Actor has been initialized.
247 void ClearKeyInputFocus();
252 * @brief Retrieves the pinch gesture detector of the control.
255 * @return The pinch gesture detector.
256 * @note Will return an empty handle if the control does not handle the gesture itself.
258 PinchGestureDetector GetPinchGestureDetector() const;
261 * @brief Retrieves the pan gesture detector of the control.
264 * @return The pan gesture detector.
265 * @note Will return an empty handle if the control does not handle the gesture itself.
267 PanGestureDetector GetPanGestureDetector() const;
270 * @brief Retrieves the tap gesture detector of the control.
273 * @return The tap gesture detector.
274 * @note Will return an empty handle if the control does not handle the gesture itself.
276 TapGestureDetector GetTapGestureDetector() const;
279 * @brief Retrieves the long press gesture detector of the control.
282 * @return The long press gesture detector.
283 * @note Will return an empty handle if the control does not handle the gesture itself.
285 LongPressGestureDetector GetLongPressGestureDetector() const;
290 * @brief Sets the name of the style to be applied to the control.
293 * @param[in] styleName A string matching a style described in a stylesheet.
295 void SetStyleName( const std::string& styleName );
298 * @brief Retrieves the name of the style to be applied to the control (if any).
300 * @return A string matching a style or an empty string.
302 const std::string& GetStyleName() const;
307 * @brief Sets the background color of the control.
310 * @param[in] color The required background color of the control
312 * @note if SetBackgroundImage is called later, this background color is removed.
314 * @note The background color fully blends with the actor color.
316 void SetBackgroundColor( const Vector4& color );
321 * @brief Retrieves the background color of the control.
324 * @return The background color of the control.
326 Vector4 GetBackgroundColor() const;
329 * @brief Sets an image as the background of the control.
332 * @param[in] image The image to set as the background.
334 void SetBackgroundImage( Image image );
337 * @brief Clears the background.
340 void ClearBackground();
345 * @brief This signal is emitted when key event is received.
347 * A callback of the following type may be connected:
349 * bool YourCallbackName(Control control, const KeyEvent& event);
351 * The return value of True, indicates that the event should be consumed.
352 * Otherwise the signal will be emitted on the next parent of the actor.
354 * @return The signal to connect to.
355 * @pre The Control has been initialized.
357 KeyEventSignalType& KeyEventSignal();
360 * @brief This signal is emitted when the control gets Key Input Focus
362 * A callback of the following type may be connected:
364 * bool YourCallbackName( Control control );
366 * The return value of True, indicates that the event should be consumed.
367 * Otherwise the signal will be emitted on the next parent of the actor.
369 * @return The signal to connect to.
370 * @pre The Control has been initialized.
372 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
375 * @brief This signal is emitted when the control loses Key Input Focus
376 * which could be due to it being gained by another Control or Actor or just cleared from
377 * this control as no longer required.
379 * A callback of the following type may be connected:
381 * bool YourCallbackName( Control control );
383 * The return value of True, indicates that the event should be consumed.
384 * Otherwise the signal will be emitted on the next parent of the actor.
386 * @return The signal to connect to.
387 * @pre The Control has been initialized.
389 KeyInputFocusSignalType& KeyInputFocusLostSignal();
391 public: // Intended for control developers
394 * @brief Create an initialised Control.
397 * @param[in] implementation The implementation for this control.
398 * @return A handle to a newly allocated Dali resource.
400 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
402 explicit Control(Internal::Control& implementation);
405 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
406 * using an Internal CustomActor pointer.
409 * @param [in] internal A pointer to a newly allocated Dali resource
411 explicit Control(Dali::Internal::CustomActor* internal);
413 public: // Templates for Deriving Classes
416 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
418 * @tparam T The handle class
419 * @tparam I The implementation class
421 * @param[in] handle Handle to an object
422 * @return Handle to a class T or an uninitialized handle.
423 * @see DownCast(BaseHandle)
425 template<typename T, typename I>
426 DALI_INTERNAL static T DownCast( BaseHandle handle )
430 CustomActor custom = Dali::CustomActor::DownCast( handle );
433 CustomActorImpl& customImpl = custom.GetImplementation();
435 I* impl = dynamic_cast<I*>(&customImpl);
439 result = T(customImpl.GetOwner());
447 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
448 * implementation of their class.
450 * @tparam I The implementation class
452 * @param[in] internal Pointer to the Internal::CustomActor
455 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
457 // Can have a NULL pointer so we only need to check if the internal implementation is our class
458 // when there is a value.
461 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
470 } // namespace Toolkit
474 #endif // __DALI_TOOLKIT_CONTROL_H__