1 #ifndef __DALI_TOOLKIT_CONTROL_H__
2 #define __DALI_TOOLKIT_CONTROL_H__
5 * Copyright (c) 2014 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 * @addtogroup CAPI_DALI_TOOLKIT_CONTROLS_MODULE
27 #include <dali/dali.h>
29 namespace Dali DALI_IMPORT_API
35 //Forward declarations.
40 * @brief Control is the base class for all controls.
42 * The implementation of the control must be supplied; see ControlImpl for more details.
45 class Control : public CustomActor, public ConnectionTrackerInterface
51 static const Property::Index PROPERTY_BACKGROUND_COLOR; ///< name "background-color", @see SetBackgroundColor, type VECTOR4
52 static const Property::Index PROPERTY_BACKGROUND; ///< name "background", @see SetBackground, type MAP
57 static const char* const SIGNAL_KEY_EVENT; ///< name "key-event"
62 static const char* const ACTION_CONTROL_ACTIVATED; ///< name "control-activated"
66 * @brief Describes how a control could be resized.
70 Fixed, ///< Size can't grow or shrink.
71 Minimum, ///< Size can grow but shrink up to a minimum level.
72 Maximum, ///< Size can shrink but grow up to a maximum value.
73 Range, ///< Size can grow or shrink between a minimum and a maximum values.
74 Flexible, ///< Size can grow or shrink with no limits.
78 * @brief Describes what a control should do when a contained actor/control exceeds the boundary of the control.
82 Crop, ///< Control's contents will be cropped.
83 Shrink, ///< Control's contents will be shrunk.
84 Scroll ///< Control's contents will be added to a scroll.
88 * @brief Describes the direction to move the keyboard focus towards.
90 enum KeyboardFocusNavigationDirection
92 Left, ///< Move keyboard focus towards the left direction
93 Right, ///< Move keyboard focus towards the right direction
94 Up, ///< Move keyboard focus towards the up direction
95 Down ///< Move keyboard focus towards the down direction
100 /// @brief Key Event signal type;
101 typedef SignalV2<bool ( Control, const KeyEvent& ) > KeyEventSignalV2;
103 public: // Creation & Destruction
106 * @brief Create a new instance of a Control.
108 * @return A handle to a new Control.
110 static Control New();
113 * @brief Create an uninitialized Control handle.
115 * Only derived versions can be instantiated. Calling member
116 * functions with an uninitialized Dali::Object is not allowed.
121 * @brief Copy constructor.
123 * Creates another handle that points to the same real object
124 * @param[in] uiControl Handle to copy
126 Control(const Control& uiControl);
129 * @brief Virtual destructor.
131 * Dali::Object derived classes do not contain member data.
138 * @brief Assignment operator.
140 * Changes this handle to point to another real object
141 * @param[in] handle Object to assign this to
142 * @return reference to this
144 Control& operator=( const Control& handle );
149 * @brief Downcast an Object handle to Control.
151 * If handle points to a Control the downcast produces valid
152 * handle. If not the returned handle is left uninitialized.
154 * @param[in] handle Handle to an object
155 * @return handle to a Control or an uninitialized handle
157 static Control DownCast( BaseHandle handle );
160 * @brief Retrieve the Control implementation.
162 * @return The implementation.
164 ControlImpl& GetImplementation();
167 * @brief Retrieve the Control implementation.
169 * @return The implementation.
171 const ControlImpl& GetImplementation() const;
176 * @brief Sets the size policies for the width and height dimensions.
178 * @param[in] widthPolicy Size policy for the width dimension.
179 * @param[in] heightPolicy Size policy for the height dimension.
181 void SetSizePolicy( SizePolicy widthPolicy, SizePolicy heightPolicy );
184 * @brief Retrieves the size policies for the width and height dimensions.
186 * @param[out] widthPolicy Width's size policy.
187 * @param[out] heightPolicy Height's size policy.
189 void GetSizePolicy( SizePolicy& widthPolicy, SizePolicy& heightPolicy ) const;
192 * @brief Sets the minimum size for the control.
194 * @param[in] size The minimum size.
196 void SetMinimumSize( const Vector3& size );
199 * @brief Retrieves the minimum size.
201 * @return The minimum size.
203 const Vector3& GetMinimumSize() const;
206 * @brief Sets the maximum size.
208 * @param[in] size The maximum size.
210 void SetMaximumSize( const Vector3& size );
213 * @brief Retrieves the maximum size.
215 * @return The maximum size.
217 const Vector3& GetMaximumSize() const;
220 * @brief Works out the natural size.
222 * Natural size is the control's size with any restriction.
224 * @return The natural size.
226 Vector3 GetNaturalSize();
229 * @brief Works out the control's height for a given width.
231 * @param[in] width The control's width.
233 * @return The control's height for the given width.
235 float GetHeightForWidth( float width );
238 * @brief Works out the control's width for a given height.
240 * @param[in] height The control's height.
242 * @return The control's width for the given height.
244 float GetWidthForHeight( float height );
249 * @brief This sets the control to receive key events.
251 * The key event can originate from a virtual or physical keyboard.
252 * @pre The Control has been initialized.
253 * @pre The Control should be on the stage before setting keyboard focus.
254 * @return True if the control has foucs, False otherwise.
256 void SetKeyInputFocus();
259 * @brief Quries whether the control has key input focus.
261 * 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.
262 * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
263 * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
264 * controls above it in the focus stack.
265 * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor()
266 * @pre The Control has been initialized.
267 * @pre The Control should be on the stage before setting keyboard focus.
268 * @return true if this control has keyboard input focus
270 bool HasKeyInputFocus();
273 * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events.
275 * A check is performed to ensure it was previously set, if this check fails then nothing is done.
276 * @pre The Actor has been initialized.
278 void ClearKeyInputFocus();
283 * @brief Retrieves the pinch gesture detector of the control.
285 * @return The pinch gesture detector.
286 * @pre Pinch detection should have been enabled in the control.
288 PinchGestureDetector GetPinchGestureDetector() const;
291 * @brief Retrieves the pan gesture detector of the control.
293 * @return The pan gesture detector.
294 * @pre Pan detection should have been enabled in the control.
296 PanGestureDetector GetPanGestureDetector() const;
299 * @brief Retrieves the tap gesture detector of the control.
301 * @return The tap gesture detector.
302 * @pre Tap detection should have been enabled in the control.
304 TapGestureDetector GetTapGestureDetector() const;
307 * @brief Retrieves the long press gesture detector of the control.
309 * @return The long press gesture detector.
310 * @pre Long press detection should have been enabled in the control.
312 LongPressGestureDetector GetLongPressGestureDetector() const;
317 * @brief Sets the background color of the control.
319 * @param[in] color The required background color of the control
321 void SetBackgroundColor( const Vector4& color );
324 * @brief Retrieves the background color of the control.
326 * @return The background color of the control.
328 Vector4 GetBackgroundColor() const;
331 * @brief Sets an image as the background of the control.
333 * The color of this image is blended with the background color @see SetBackgroundColor
335 * @param[in] image The image to set as the background.
337 void SetBackground( Image image );
340 * @brief Clears the background.
342 void ClearBackground();
345 * @brief Retrieves the actor used as the background for this control.
347 * @return The actor that used as the background for this control.
349 Actor GetBackgroundActor() const;
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 touch event should be consumed.
361 * Otherwise the signal will be emitted on the next sensitive parent of the actor.
362 * @pre The Control has been initialized.
363 * @return The signal to connect to.
365 KeyEventSignalV2& KeyEventSignal();
370 * @copydoc ConnectionTrackerInterface::SignalConnected
372 virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback );
375 * @copydoc ConnectionTrackerInterface::SignalDisconnected
377 virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
380 * @copydoc ConnectionTrackerInterface::GetConnectionCount
382 virtual std::size_t GetConnectionCount() const;
384 public: // Not intended for application developers
387 * @brief Create an initialised Control.
389 * @param[in] implementation The implementation for this control.
390 * @return A handle to a newly allocated Dali resource.
392 Control(ControlImpl& implementation);
395 * @brief This constructor is used by CustomActor within Dali core to create additional Control handles
396 * using an Internal CustomActor pointer.
398 * @param [in] internal A pointer to a newly allocated Dali resource
400 Control(Dali::Internal::CustomActor* internal);
402 public: // Templates for Deriving Classes
405 * @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
407 * @tparam T The handle class
408 * @tparam I The implementation class
409 * @param[in] handle Handle to an object
410 * @return Handle to a class T or an uninitialized handle.
411 * @see DownCast(BaseHandle)
413 template<typename T, typename I>
414 static T DownCast( BaseHandle handle )
418 CustomActor custom = Dali::CustomActor::DownCast( handle );
421 CustomActorImpl& customImpl = custom.GetImplementation();
423 I* impl = dynamic_cast<I*>(&customImpl);
427 result = T(customImpl.GetOwner());
435 * @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
436 * implementation of their class.
438 * @tparam I The implementation class
439 * @param[in] internal Pointer to the Internal::CustomActor
442 void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
444 // Can have a NULL pointer so we only need to check if the internal implementation is our class
445 // when there is a value.
448 DALI_ASSERT_DEBUG(dynamic_cast<I*>(&CustomActor(internal).GetImplementation()));
454 } // namespace Toolkit
461 #endif // __DALI_TOOLKIT_CONTROL_H__