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.
45 * @brief Control is the base class for all controls.
47 * The implementation of the control must be supplied; see Internal::Control for more details.
48 * @see Internal::Control
51 * | %Signal Name | Method |
52 * |------------------------|-----------------------------------------------------|
53 * | key-event | @ref KeyEventSignal() |
54 * | key-input-focus-gained | @ref KeyInputFocusGainedSignal() |
55 * | key-input-focus-lost | @ref KeyInputFocusLostSignal() |
56 * | tapped | @ref GetTapGestureDetector().DetectedSignal() |
57 * | panned | @ref GetPanGestureDetector().DetectedSignal() |
58 * | pinched | @ref GetPinchGestureDetector().DetectedSignal() |
59 * | long-pressed | @ref GetLongPressGestureDetector().DetectedSignal() |
62 * | %Action Name | %Control method called |
63 * |-------------------|-----------------------------------------------------|
64 * | control-activated | %OnActivated() |
66 class DALI_IMPORT_API Control : public CustomActor
71 * @brief The start and end property ranges for control.
75 PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro.
76 CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties.
77 CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices.
81 * @brief An enumeration of properties belonging to the Control class.
87 STYLE_NAME = PROPERTY_START_INDEX, ///< name "style-name", @see SetStyleName, type std::string
88 BACKGROUND_COLOR, ///< name "background-color", @see SetBackgroundColor, type Vector4
89 BACKGROUND_IMAGE, ///< name "background-image", @see SetBackgroundImage, type Map
90 KEY_INPUT_FOCUS, ///< name "key-input-focus", @see SetKeyInputFocus, type bool
95 * @brief Describes the direction to move the keyboard focus towards.
101 LEFT, ///< Move keyboard focus towards the left direction
102 RIGHT, ///< Move keyboard focus towards the right direction
103 UP, ///< Move keyboard focus towards the up direction
104 DOWN ///< Move keyboard focus towards the down direction
110 /// @brief Key Event signal type;
111 typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
113 /// @brief Key InputFocusType signal type;
114 typedef Signal<void ( Control ) > KeyInputFocusSignalType;
116 public: // Creation & Destruction
119 * @brief Create a new instance of a Control.
121 * @return A handle to a new Control.
123 static Control New();
126 * @brief Create an uninitialized Control handle.
128 * Only derived versions can be instantiated. Calling member
129 * functions with an uninitialized Dali::Object is not allowed.
134 * @brief Copy constructor.
136 * Creates another handle that points to the same real object
137 * @param[in] uiControl Handle to copy
139 Control(const Control& uiControl);
142 * @brief Dali::Control is intended as a base class
144 * This is non-virtual since derived Handle types must not contain data or virtual methods.
151 * @brief Assignment operator.
153 * Changes this handle to point to another real object
154 * @param[in] handle Object to assign this to
155 * @return reference to this
157 Control& operator=( const Control& handle );
162 * @brief Downcast an Object handle to Control.
164 * If handle points to a Control the downcast produces valid
165 * handle. If not the returned handle is left uninitialized.
167 * @param[in] handle Handle to an object
168 * @return handle to a Control or an uninitialized handle
170 static Control DownCast( BaseHandle handle );
175 * @brief This sets the control to receive key events.
177 * The key event can originate from a virtual or physical keyboard.
178 * @pre The Control has been initialized.
179 * @pre The Control should be on the stage before setting keyboard focus.
180 * @return True if the control has foucs, False otherwise.
182 void SetKeyInputFocus();
185 * @brief Quries whether the control has key input focus.
187 * 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.
188 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
189 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
190 * controls above it in the focus stack.
191 * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor()
192 * @pre The Control has been initialized.
193 * @pre The Control should be on the stage before setting keyboard focus.
194 * @return true if this control has keyboard input focus
196 bool HasKeyInputFocus();
199 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
201 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
202 * @pre The Actor has been initialized.
204 void ClearKeyInputFocus();
209 * @brief Retrieves the pinch gesture detector of the control.
211 * @return The pinch gesture detector.
212 * @note Will return an empty handle if the control does not handle the gesture itself.
214 PinchGestureDetector GetPinchGestureDetector() const;
217 * @brief Retrieves the pan gesture detector of the control.
219 * @return The pan gesture detector.
220 * @note Will return an empty handle if the control does not handle the gesture itself.
222 PanGestureDetector GetPanGestureDetector() const;
225 * @brief Retrieves the tap gesture detector of the control.
227 * @return The tap gesture detector.
228 * @note Will return an empty handle if the control does not handle the gesture itself.
230 TapGestureDetector GetTapGestureDetector() const;
233 * @brief Retrieves the long press gesture detector of the control.
235 * @return The long press gesture detector.
236 * @note Will return an empty handle if the control does not handle the gesture itself.
238 LongPressGestureDetector GetLongPressGestureDetector() const;
243 * @brief Sets the name of the style to be applied to the control.
245 * @param[in] styleName A string matching a style described in a stylesheet.
247 void SetStyleName( const std::string& styleName );
250 * @brief Retrieves the name of the style to be applied to the control (if any).
252 * @return A string matching a style or an empty string.
254 const std::string& GetStyleName() const;
259 * @brief Sets the background color of the control.
261 * @param[in] color The required background color of the control
263 * @note The background color fully blends with the actor color.
265 void SetBackgroundColor( const Vector4& color );
268 * @brief Retrieves the background color of the control.
270 * @return The background color of the control.
272 Vector4 GetBackgroundColor() const;
275 * @brief Sets an image as the background of the control.
277 * The color of this image is blended with the background color @see SetBackgroundColor
279 * @param[in] image The image to set as the background.
281 void SetBackgroundImage( Image image );
284 * @brief Clears the background.
286 void ClearBackground();
291 * @brief This signal is emitted when key event is received.
293 * A callback of the following type may be connected:
295 * bool YourCallbackName(Control control, const KeyEvent& event);
297 * The return value of True, indicates that the event should be consumed.
298 * Otherwise the signal will be emitted on the next parent of the actor.
299 * @pre The Control has been initialized.
300 * @return The signal to connect to.
302 KeyEventSignalType& KeyEventSignal();
305 * @brief This signal is emitted when the control gets Key Input Focus
307 * A callback of the following type may be connected:
309 * bool YourCallbackName( Control control );
311 * The return value of True, indicates that the event should be consumed.
312 * Otherwise the signal will be emitted on the next parent of the actor.
313 * @pre The Control has been initialized.
314 * @return The signal to connect to.
316 KeyInputFocusSignalType& KeyInputFocusGainedSignal();
319 * @brief This signal is emitted when the control loses Key Input Focus
320 * which could be due to it being gained by another Control or Actor or just cleared from
321 * this control as no longer required.
323 * A callback of the following type may be connected:
325 * bool YourCallbackName( Control control );
327 * The return value of True, indicates that the event should be consumed.
328 * Otherwise the signal will be emitted on the next parent of the actor.
329 * @pre The Control has been initialized.
330 * @return The signal to connect to.
332 KeyInputFocusSignalType& KeyInputFocusLostSignal();
334 public: // Intended for control developers
337 * @brief Create an initialised Control.
339 * @param[in] implementation The implementation for this control.
340 * @return A handle to a newly allocated Dali resource.
342 * @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
344 explicit Control(Internal::Control& implementation);
347 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
348 * using an Internal CustomActor pointer.
350 * @param [in] internal A pointer to a newly allocated Dali resource
352 explicit Control(Dali::Internal::CustomActor* internal);
354 public: // Templates for Deriving Classes
357 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
359 * @tparam T The handle class
360 * @tparam I The implementation class
361 * @param[in] handle Handle to an object
362 * @return Handle to a class T or an uninitialized handle.
363 * @see DownCast(BaseHandle)
365 template<typename T, typename I>
366 DALI_INTERNAL static T DownCast( BaseHandle handle )
370 CustomActor custom = Dali::CustomActor::DownCast( handle );
373 CustomActorImpl& customImpl = custom.GetImplementation();
375 I* impl = dynamic_cast<I*>(&customImpl);
379 result = T(customImpl.GetOwner());
387 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
388 * implementation of their class.
390 * @tparam I The implementation class
391 * @param[in] internal Pointer to the Internal::CustomActor
394 DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
396 // Can have a NULL pointer so we only need to check if the internal implementation is our class
397 // when there is a value.
400 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
406 } // namespace Toolkit
410 #endif // __DALI_TOOLKIT_CONTROL_H__