X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Fcontrol.h;h=86ea6078b4f2b296984aa15aa4cf9cb6b4ffc19e;hp=01c1c75d75243c646deee4f4024cd4762c8f152f;hb=c6eb78824e08f7a863c55b3599d37b641c0313ba;hpb=ee3bdc95f623f41feb37be10f21bef1d9da1e805 diff --git a/dali-toolkit/public-api/controls/control.h b/dali-toolkit/public-api/controls/control.h index 01c1c75..86ea607 100644 --- a/dali-toolkit/public-api/controls/control.h +++ b/dali-toolkit/public-api/controls/control.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_CONTROL_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -40,73 +40,107 @@ namespace Internal { class Control; } +/** + * @addtogroup dali_toolkit_controls + * @{ + */ /** * @brief Control is the base class for all controls. * * The implementation of the control must be supplied; see Internal::Control for more details. + * @SINCE_1_0.0 * @see Internal::Control * * Signals - * | %Signal Name | Method | - * |-------------------|-----------------------------------------------------| - * | key-event | @ref KeyEventSignal() | - * | tapped | @ref GetTapGestureDetector().DetectedSignal() | - * | panned | @ref GetPanGestureDetector().DetectedSignal() | - * | pinched | @ref GetPinchGestureDetector().DetectedSignal() | - * | long-pressed | @ref GetLongPressGestureDetector().DetectedSignal() | + * | %Signal Name | Method | + * |------------------------|-----------------------------------------------------| + * | keyEvent | @ref KeyEventSignal() | + * | keyInputFocusGained | @ref KeyInputFocusGainedSignal() | + * | keyInputFocusLost | @ref KeyInputFocusLostSignal() | + * | tapped | @ref GetTapGestureDetector().DetectedSignal() | + * | panned | @ref GetPanGestureDetector().DetectedSignal() | + * | pinched | @ref GetPinchGestureDetector().DetectedSignal() | + * | longPressed | @ref GetLongPressGestureDetector().DetectedSignal() | * * Actions - * | %Action Name | %Control method called | - * |-------------------|-----------------------------------------------------| - * | control-activated | %OnActivated() | + * | %Action Name | %Control method called | + * |------------------------|----------------------------------------------------| + * | accessibilityActivated | %OnAccessibilityActivated() | */ class DALI_IMPORT_API Control : public CustomActor { public: - /// @name Properties - /** @{ */ - static const Property::Index PROPERTY_BACKGROUND_COLOR; ///< name "background-color", @see SetBackgroundColor, type VECTOR4 - static const Property::Index PROPERTY_BACKGROUND; ///< name "background", @see SetBackground, type MAP - static const Property::Index PROPERTY_WIDTH_POLICY; ///< name "width-policy", @see SetSizePolicy, type STRING - static const Property::Index PROPERTY_HEIGHT_POLICY; ///< name "height-policy", @see SetSizePolicy, type STRING - static const Property::Index PROPERTY_MINIMUM_SIZE; ///< name "minimum-size", @see SetMinimumSize, type VECTOR3 - static const Property::Index PROPERTY_MAXIMUM_SIZE; ///< name "maximum-size", @see SetMaximumSize, type VECTOR3 - static const Property::Index PROPERTY_KEY_INPUT_FOCUS; ///< name "key-input-focus", @see SetKeyInputFocus, type BOOLEAN - /** @} */ - /** - * @brief Describes how a control could be resized. + * @brief The start and end property ranges for control. + * @SINCE_1_0.0 */ - enum SizePolicy + enum PropertyRange { - Fixed, ///< Size can't grow or shrink. - Minimum, ///< Size can grow but shrink up to a minimum level. - Maximum, ///< Size can shrink but grow up to a maximum value. - Range, ///< Size can grow or shrink between a minimum and a maximum values. - Flexible, ///< Size can grow or shrink with no limits. + PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro. @SINCE_1_0.0 + CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties. @SINCE_1_0.0 + CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices. @SINCE_1_0.0 }; /** - * @brief Describes what a control should do when a contained actor/control exceeds the boundary of the control. + * @brief An enumeration of properties belonging to the Control class. + * @SINCE_1_0.0 */ - enum ExceedPolicy + struct Property { - Crop, ///< Control's contents will be cropped. - Shrink, ///< Control's contents will be shrunk. - Scroll ///< Control's contents will be added to a scroll. + enum + { + /** + * @brief name "styleName", type std::string + * @SINCE_1_0.0 + * @see SetStyleName + */ + STYLE_NAME = PROPERTY_START_INDEX, + /** + * @DEPRECATED_1_1.3 + * @brief name "background-color", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 + * @SINCE_1_0.0 + * @see SetStyleName + */ + BACKGROUND_COLOR, + /** + * @DEPRECATED_1_1.3 + * @brief name "background-image", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map + * @SINCE_1_0.0 + */ + BACKGROUND_IMAGE, + /** + * @brief name "keyInputFocus", type bool + * @SINCE_1_0.0 + * @see SetKeyInputFocus + */ + KEY_INPUT_FOCUS, + /** + * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL + * @SINCE_1_1.3 + */ + BACKGROUND, + }; }; /** * @brief Describes the direction to move the keyboard focus towards. + * @SINCE_1_0.0 */ - enum KeyboardFocusNavigationDirection + struct KeyboardFocus { - Left, ///< Move keyboard focus towards the left direction - Right, ///< Move keyboard focus towards the right direction - Up, ///< Move keyboard focus towards the up direction - Down ///< Move keyboard focus towards the down direction + /** + * @brief Keyboard focus direction + * @SINCE_1_0.0 + */ + enum Direction + { + LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0 + RIGHT, ///< Move keyboard focus towards the right direction @SINCE_1_0.0 + UP, ///< Move keyboard focus towards the up direction @SINCE_1_0.0 + DOWN ///< Move keyboard focus towards the down direction @SINCE_1_0.0 + }; }; // Typedefs @@ -114,11 +148,15 @@ public: /// @brief Key Event signal type; typedef Signal KeyEventSignalType; + /// @brief Key InputFocusType signal type; + typedef Signal KeyInputFocusSignalType; + public: // Creation & Destruction /** * @brief Create a new instance of a Control. * + * @SINCE_1_0.0 * @return A handle to a new Control. */ static Control New(); @@ -128,21 +166,24 @@ public: // Creation & Destruction * * Only derived versions can be instantiated. Calling member * functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_0.0 */ Control(); /** * @brief Copy constructor. * - * Creates another handle that points to the same real object + * Creates another handle that points to the same real object. + * @SINCE_1_0.0 * @param[in] uiControl Handle to copy */ Control(const Control& uiControl); /** - * @brief Dali::Control is intended as a base class + * @brief Dali::Control is intended as a base class. * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~Control(); @@ -151,7 +192,8 @@ public: // operators /** * @brief Assignment operator. * - * Changes this handle to point to another real object + * Changes this handle to point to another real object. + * @SINCE_1_0.0 * @param[in] handle Object to assign this to * @return reference to this */ @@ -160,126 +202,41 @@ public: // operators public: /** - * @brief Downcast an Object handle to Control. + * @brief Downcast a handle to Control handle. * * If handle points to a Control the downcast produces valid * handle. If not the returned handle is left uninitialized. * + * @SINCE_1_0.0 * @param[in] handle Handle to an object - * @return handle to a Control or an uninitialized handle + * @return A handle to a Control or an uninitialized handle */ static Control DownCast( BaseHandle handle ); - /** - * @brief Retrieve the Control implementation. - * - * @return The implementation. - */ - Internal::Control& GetImplementation(); - - /** - * @brief Retrieve the Control implementation. - * - * @return The implementation. - */ - const Internal::Control& GetImplementation() const; - - // Size Negotiation - - /** - * @brief Sets the size policies for the width and height dimensions. - * - * @param[in] widthPolicy Size policy for the width dimension. - * @param[in] heightPolicy Size policy for the height dimension. - */ - void SetSizePolicy( SizePolicy widthPolicy, SizePolicy heightPolicy ); - - /** - * @brief Retrieves the size policies for the width and height dimensions. - * - * @param[out] widthPolicy Width's size policy. - * @param[out] heightPolicy Height's size policy. - */ - void GetSizePolicy( SizePolicy& widthPolicy, SizePolicy& heightPolicy ) const; - - /** - * @brief Sets the minimum size for the control. - * - * @param[in] size The minimum size. - */ - void SetMinimumSize( const Vector3& size ); - - /** - * @brief Retrieves the minimum size. - * - * @return The minimum size. - */ - const Vector3& GetMinimumSize() const; - - /** - * @brief Sets the maximum size. - * - * @param[in] size The maximum size. - */ - void SetMaximumSize( const Vector3& size ); - - /** - * @brief Retrieves the maximum size. - * - * @return The maximum size. - */ - const Vector3& GetMaximumSize() const; - - /** - * @brief Works out the natural size. - * - * Natural size is the control's size with any restriction. - * - * @return The natural size. - */ - Vector3 GetNaturalSize(); - - /** - * @brief Works out the control's height for a given width. - * - * @param[in] width The control's width. - * - * @return The control's height for the given width. - */ - float GetHeightForWidth( float width ); - - /** - * @brief Works out the control's width for a given height. - * - * @param[in] height The control's height. - * - * @return The control's width for the given height. - */ - float GetWidthForHeight( float height ); - // Key Input /** * @brief This sets the control to receive key events. * * The key event can originate from a virtual or physical keyboard. + * @SINCE_1_0.0 * @pre The Control has been initialized. * @pre The Control should be on the stage before setting keyboard focus. - * @return True if the control has foucs, False otherwise. */ void SetKeyInputFocus(); /** * @brief Quries whether the control has key input focus. * - * 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. + * @SINCE_1_0.0 + * @return true if this control has keyboard input focus + * @pre The Control has been initialized. + * @pre The Control should be on the stage before setting keyboard focus. + * @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. * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more * controls above it in the focus stack. - * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor() - * @pre The Control has been initialized. - * @pre The Control should be on the stage before setting keyboard focus. - * @return true if this control has keyboard input focus + * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor(). */ bool HasKeyInputFocus(); @@ -287,6 +244,7 @@ public: * @brief Once an actor is Set to receive key input focus this function is called to stop it receiving key events. * * A check is performed to ensure it was previously set, if this check fails then nothing is done. + * @SINCE_1_0.0 * @pre The Actor has been initialized. */ void ClearKeyInputFocus(); @@ -296,6 +254,7 @@ public: /** * @brief Retrieves the pinch gesture detector of the control. * + * @SINCE_1_0.0 * @return The pinch gesture detector. * @note Will return an empty handle if the control does not handle the gesture itself. */ @@ -304,6 +263,7 @@ public: /** * @brief Retrieves the pan gesture detector of the control. * + * @SINCE_1_0.0 * @return The pan gesture detector. * @note Will return an empty handle if the control does not handle the gesture itself. */ @@ -312,6 +272,7 @@ public: /** * @brief Retrieves the tap gesture detector of the control. * + * @SINCE_1_0.0 * @return The tap gesture detector. * @note Will return an empty handle if the control does not handle the gesture itself. */ @@ -320,50 +281,69 @@ public: /** * @brief Retrieves the long press gesture detector of the control. * + * @SINCE_1_0.0 * @return The long press gesture detector. * @note Will return an empty handle if the control does not handle the gesture itself. */ LongPressGestureDetector GetLongPressGestureDetector() const; + // Styling + + /** + * @brief Sets the name of the style to be applied to the control. + * + * @SINCE_1_0.0 + * @param[in] styleName A string matching a style described in a stylesheet. + */ + void SetStyleName( const std::string& styleName ); + + /** + * @brief Retrieves the name of the style to be applied to the control (if any). + * @SINCE_1_0.0 + * @return A string matching a style or an empty string. + */ + const std::string& GetStyleName() const; + // Background /** * @brief Sets the background color of the control. * + * @SINCE_1_0.0 * @param[in] color The required background color of the control * + * @note if SetBackgroundImage is called later, this background color is removed. + * * @note The background color fully blends with the actor color. */ void SetBackgroundColor( const Vector4& color ); /** + * @DEPRECATED_1_1.3 + * * @brief Retrieves the background color of the control. * + * @SINCE_1_0.0 * @return The background color of the control. */ Vector4 GetBackgroundColor() const; /** - * @brief Sets an image as the background of the control. + * @DEPRECATED_1_2.8, use Property::BACKGROUND instead * - * The color of this image is blended with the background color @see SetBackgroundColor + * @brief Sets an image as the background of the control. * + * @SINCE_1_0.0 * @param[in] image The image to set as the background. */ - void SetBackground( Image image ); + void SetBackgroundImage( Image image ); /** * @brief Clears the background. + * @SINCE_1_0.0 */ void ClearBackground(); - /** - * @brief Retrieves the actor used as the background for this control. - * - * @return The actor that used as the background for this control. - */ - Actor GetBackgroundActor() const; - // Signals /** @@ -373,18 +353,52 @@ public: * @code * bool YourCallbackName(Control control, const KeyEvent& event); * @endcode - * The return value of True, indicates that the touch event should be consumed. - * Otherwise the signal will be emitted on the next sensitive parent of the actor. - * @pre The Control has been initialized. + * The return value of True, indicates that the event should be consumed. + * Otherwise the signal will be emitted on the next parent of the actor. + * @SINCE_1_0.0 * @return The signal to connect to. + * @pre The Control has been initialized. */ KeyEventSignalType& KeyEventSignal(); + /** + * @brief This signal is emitted when the control gets Key Input Focus. + * + * A callback of the following type may be connected: + * @code + * bool YourCallbackName( Control control ); + * @endcode + * The return value of True, indicates that the event should be consumed. + * Otherwise the signal will be emitted on the next parent of the actor. + * @SINCE_1_0.0 + * @return The signal to connect to. + * @pre The Control has been initialized. + */ + KeyInputFocusSignalType& KeyInputFocusGainedSignal(); + + /** + * @brief This signal is emitted when the control loses Key Input Focus + * which could be due to it being gained by another Control or Actor or just cleared from + * this control as no longer required. + * + * A callback of the following type may be connected: + * @code + * bool YourCallbackName( Control control ); + * @endcode + * The return value of True, indicates that the event should be consumed. + * Otherwise the signal will be emitted on the next parent of the actor. + * @SINCE_1_0.0 + * @return The signal to connect to. + * @pre The Control has been initialized. + */ + KeyInputFocusSignalType& KeyInputFocusLostSignal(); + public: // Intended for control developers /** * @brief Create an initialised Control. * + * @SINCE_1_0.0 * @param[in] implementation The implementation for this control. * @return A handle to a newly allocated Dali resource. * @@ -396,6 +410,7 @@ public: // Intended for control developers * @brief This constructor is used by CustomActor within Dali core to create additional Control handles * using an Internal CustomActor pointer. * + * @SINCE_1_0.0 * @param [in] internal A pointer to a newly allocated Dali resource */ explicit Control(Dali::Internal::CustomActor* internal); @@ -407,6 +422,7 @@ public: // Templates for Deriving Classes * * @tparam T The handle class * @tparam I The implementation class + * @SINCE_1_0.0 * @param[in] handle Handle to an object * @return Handle to a class T or an uninitialized handle. * @see DownCast(BaseHandle) @@ -437,6 +453,7 @@ public: // Templates for Deriving Classes * implementation of their class. * * @tparam I The implementation class + * @SINCE_1_0.0 * @param[in] internal Pointer to the Internal::CustomActor */ template @@ -452,6 +469,9 @@ public: // Templates for Deriving Classes }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali