#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.
{
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
{
/**
* @brief The start and end property ranges for control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = PROPERTY_REGISTRATION_START_INDEX, ///< Start index is used by the property registration macro.
- CONTROL_PROPERTY_START_INDEX = PROPERTY_START_INDEX, ///< Start index of Control properties.
- CONTROL_PROPERTY_END_INDEX = CONTROL_PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices.
+ 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 An enumeration of properties belonging to the Control class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- BACKGROUND_COLOR = PROPERTY_START_INDEX, ///< name "background-color", @see SetBackgroundColor, type Vector4
- BACKGROUND_IMAGE, ///< name "background-image", @see SetBackgroundImage, type Map
- KEY_INPUT_FOCUS, ///< name "key-input-focus", @see SetKeyInputFocus, type bool
+ /**
+ * @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
+ * @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
+ 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
/// @brief Key Event signal type;
typedef Signal<bool ( Control, const KeyEvent& ) > KeyEventSignalType;
+ /// @brief Key InputFocusType signal type;
+ typedef Signal<void ( Control ) > 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();
*
* 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();
/**
* @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
*/
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;
-
// 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();
* @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();
/**
* @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.
*/
/**
* @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.
*/
/**
* @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.
*/
/**
* @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.
*
- * The color of this image is blended with the background color @see SetBackgroundColor
- *
+ * @SINCE_1_0.0
* @param[in] image The image to set as the background.
*/
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
/**
* @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.
*
* @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);
*
* @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)
* implementation of their class.
*
* @tparam I The implementation class
+ * @SINCE_1_0.0
* @param[in] internal Pointer to the Internal::CustomActor
*/
template<typename I>
};
+/**
+ * @}
+ */
} // namespace Toolkit
} // namespace Dali
projects / platform / core / uifw / dali-toolkit.git / blobdiff