- Change @since 1.1.x to @SINCE_1_1.x to follow the new doxygen tagging rule.
- Add @SINCE_1_0.0 for all symbols not having @since tag.
- Sort the order of doxygen tags as guided by the Tizen guideline.
('platform','deprecated','brief','details','since_tizen','privlevel',
'privilege', 'remarks','param','return','retval','exception','pre','post',
'note','see')
Change-Id: I99ce2a063f1d28130bc7951de212c47b5af06509
* | focusChanged | @ref FocusChangedSignal() |
* | focusOvershot | @ref FocusOvershotSignal() |
* | focusedActorActivated | @ref FocusedActorActivatedSignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API AccessibilityManager : public BaseHandle
{
*
* The connected signal callback should return true if handled.
*/
- typedef Signal< bool ( AccessibilityManager& ) > AccessibilityActionSignalType; ///< Generic signal type
- typedef Signal< bool ( AccessibilityManager&, const Dali::TouchEvent& )> AccessibilityActionScrollSignalType; ///< Scroll signal type
+ typedef Signal< bool ( AccessibilityManager& ) > AccessibilityActionSignalType; ///< Generic signal type @SINCE_1_0.0
+ typedef Signal< bool ( AccessibilityManager&, const Dali::TouchEvent& )> AccessibilityActionScrollSignalType; ///< Scroll signal type @SINCE_1_0.0
/**
* @brief Accessibility needs four information which will be read by screen-reader.
*
* Reading order : Label -> Trait -> Optional (Value and Hint)
+ * @SINCE_1_0.0
*/
enum AccessibilityAttribute
{
- ACCESSIBILITY_LABEL = 0, ///< Simple text which contained in ui-control
- ACCESSIBILITY_TRAIT, ///< Description of ui-control trait
- ACCESSIBILITY_VALUE, ///< Current value of ui-control (Optional)
- ACCESSIBILITY_HINT, ///< Hint for action (Optional)
- ACCESSIBILITY_ATTRIBUTE_NUM ///< Number of attributes
+ ACCESSIBILITY_LABEL = 0, ///< Simple text which contained in ui-control @SINCE_1_0.0
+ ACCESSIBILITY_TRAIT, ///< Description of ui-control trait @SINCE_1_0.0
+ ACCESSIBILITY_VALUE, ///< Current value of ui-control (Optional) @SINCE_1_0.0
+ ACCESSIBILITY_HINT, ///< Hint for action (Optional) @SINCE_1_0.0
+ ACCESSIBILITY_ATTRIBUTE_NUM ///< Number of attributes @SINCE_1_0.0
};
/**
* @brief Overshoot direction.
+ * @SINCE_1_0.0
*/
enum FocusOvershotDirection
{
- OVERSHOT_PREVIOUS = -1, ///< Try to move previous of the first actor
- OVERSHOT_NEXT = 1, ///< Try to move next of the last actor
+ OVERSHOT_PREVIOUS = -1, ///< Try to move previous of the first actor @SINCE_1_0.0
+ OVERSHOT_NEXT = 1, ///< Try to move next of the last actor @SINCE_1_0.0
};
public:
* @brief Create a AccessibilityManager handle; this can be initialised with AccessibilityManager::New().
*
* Calling member functions with an uninitialised handle is not allowed.
+ * @SINCE_1_0.0
*/
AccessibilityManager();
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~AccessibilityManager();
/**
* @brief Get the singleton of AccessibilityManager object.
*
+ * @SINCE_1_0.0
* @return A handle to the AccessibilityManager control.
*/
static AccessibilityManager Get();
/**
* @brief Set the information of the specified actor's accessibility attribute.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor the text to be set with
* @param type The attribute type the text to be set with
* @param text The text for the actor's accessibility information
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
void SetAccessibilityAttribute(Actor actor, AccessibilityAttribute type, const std::string& text);
/**
* @brief Get the text of the specified actor's accessibility attribute.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be queried
* @param type The attribute type to be queried
* @return The text of the actor's accessibility information
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
std::string GetAccessibilityAttribute(Actor actor, AccessibilityAttribute type) const;
* description but with no focus order being set yet) and therefore
* that actor is not focusable.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor the focus order to be set with
* @param order The focus order of the actor
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
void SetFocusOrder(Actor actor, const unsigned int order);
* When the focus order is 0, it means the focus order of the actor
* is undefined.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be queried
* @return The focus order of the actor
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
unsigned int GetFocusOrder(Actor actor) const;
* 1 where FOLast is the focus order of the very last control in the
* focus chain.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return The focus order of the actor
+ * @pre The AccessibilityManager has been initialized.
*/
unsigned int GenerateNewFocusOrder() const;
* It will return an empty handle if the actor is not in the stage
* or has a focus order of 0.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @param order The focus order of the actor
*
* @return The actor that has the specified focus order or an empty
* handle if no actor in the stage has the specified focus order.
+ * @pre The AccessibilityManager has been initialized.
*/
Actor GetActorByFocusOrder(const unsigned int order);
* have a defined focus order and must be focusable, visible and in
* the stage.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be focused
* @return Whether the focus is successful or not
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
bool SetCurrentFocusActor(Actor actor);
/**
* @brief Get the current focused actor.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return A handle to the current focused actor or an empty handle if no actor is focused.
+ * @pre The AccessibilityManager has been initialized.
*/
Actor GetCurrentFocusActor();
/**
* @brief Get the focus group of current focused actor.
*
- * @pre The AccessibilityManager has been initialized.
- *
+ * @SINCE_1_0.0
* @return A handle to the immediate parent of the current focused
* actor which is also a focus group, or an empty handle if no actor
* is focused.
+ * @pre The AccessibilityManager has been initialized.
+ *
*/
Actor GetCurrentFocusGroup();
/**
* @brief Get the focus order of currently focused actor.
- * @pre The AccessibilityManager has been initialized.
- *
+ * @SINCE_1_0.0
* @return The focus order of the currently focused actor or 0 if no
* actor is in focus.
+ * @pre The AccessibilityManager has been initialized.
+ *
*/
unsigned int GetCurrentFocusOrder();
* When the focus movement is wrapped around, the focus will be moved
* to the first focusable actor when it reaches the end of the focus chain.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return true if the moving was successful
+ * @pre The AccessibilityManager has been initialized.
*/
bool MoveFocusForward();
* moved to the last focusable actor when it reaches the beginning
* of the focus chain.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return true if the moving was successful
+ * @pre The AccessibilityManager has been initialized.
*/
bool MoveFocusBackward();
* that no actor is focused in the focus chain.
*
* It will emit focus changed signal without current focused actor
+ * @SINCE_1_0.0
* @pre The AccessibilityManager has been initialized.
*/
void ClearFocus();
/**
* @brief Clear the every registered focusable actor from focus-manager.
+ * @SINCE_1_0.0
* @pre The AccessibilityManager has been initialized.
*/
void Reset();
* @brief Set whether an actor is a focus group that can limit the
* scope of focus movement to its child actors in the focus chain.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be set as a focus group.
* @param isFocusGroup Whether to set the actor to be a focus group or not.
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
void SetFocusGroup(Actor actor, bool isFocusGroup);
/**
* @brief Check whether the actor is set as a focus group or not.
*
- * @pre The AccessibilityManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be checked.
* @return Whether the actor is set as a focus group.
+ * @pre The AccessibilityManager has been initialized.
+ * @pre The Actor has been initialized.
*/
bool IsFocusGroup(Actor actor) const;
* When the group mode is enabled, the focus movement will be limited to the child actors
* of the current focus group including the current focus group itself. The current focus
* group is the closest ancestor of the current focused actor that set as a focus group.
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @param enabled Whether the group mode is enabled or not
+ * @pre The AccessibilityManager has been initialized.
*/
void SetGroupMode(bool enabled);
/**
* @brief Get whether the group mode is enabled or not.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return Whether the group mode is enabled or not.
+ * @pre The AccessibilityManager has been initialized.
*/
bool GetGroupMode() const;
*
* When both the wrap mode and the group mode are enabled, focus will be
* wrapped within the current focus group. Focus will not be wrapped in default.
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @param wrapped Whether the focus movement is wrapped around or not
+ * @pre The AccessibilityManager has been initialized.
*/
void SetWrapMode(bool wrapped);
/**
* @brief Get whether the wrap mode is enabled or not.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return Whether the wrap mode is enabled or not.
+ * @pre The AccessibilityManager has been initialized.
*/
bool GetWrapMode() const;
* AccessibilityManager and will be added to the focused actor as a
* highlight.
*
+ * @SINCE_1_0.0
+ * @param indicator The indicator actor to be added
* @pre The AccessibilityManager has been initialized.
* @pre The indicator actor has been initialized.
- * @param indicator The indicator actor to be added
*/
void SetFocusIndicatorActor(Actor indicator);
/**
* @brief Get the focus indicator actor.
*
- * @pre The AccessibilityManager has been initialized.
+ * @SINCE_1_0.0
* @return A handle to the focus indicator actor
+ * @pre The AccessibilityManager has been initialized.
*/
Actor GetFocusIndicatorActor();
/**
* @brief Returns the closest ancestor of the given actor that is a focus group.
*
+ * @SINCE_1_0.0
* @param actor The actor to be checked for its focus group
* @return The focus group the given actor belongs to or an empty handle if the given actor doesn't belong to any focus group
*/
/**
* @brief Returns the current position of the read action.
+ * @SINCE_1_0.0
* @return The current event position.
*/
Vector2 GetReadPosition() const;
* @code
* void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
FocusChangedSignalType& FocusChangedSignal();
* @code
* void YourCallbackName(Actor currentFocusedActor, FocusOvershotDirection direction);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
FocusOvershotSignalType& FocusOvershotSignal();
* @code
* void YourCallbackName(Actor activatedActor);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
FocusedActorActivatedSignalType& FocusedActorActivatedSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& StatusChangedSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionNextSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionPreviousSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionActivateSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionOverSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadNextSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadPreviousSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionUpSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionDownSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionClearFocusSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionBackSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionScrollUpSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionScrollDownSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionPageLeftSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionPageRightSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionPageUpSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionPageDownSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionMoveToFirstSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionMoveToLastSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadFromTopSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadFromNextSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionZoomSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadIndicatorInformationSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionReadPauseResumeSignal();
* @code
* bool YourCallback( AccessibilityManager& manager );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionSignalType& ActionStartStopSignal();
* @code
* bool YourCallback( AccessibilityManager& manager, const TouchEvent& event );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
AccessibilityActionScrollSignalType& ActionScrollSignal();
* @brief Alignment is a container which provides an easy way to align other actors inside its boundary.
*
* Additionaly it provides a scaling property to resize the contained actors @see Scaling.
+ * @SINCE_1_0.0
* @note The use of scaling property will override all constraints applied to actors.
*
* All actors added to an alignment are going to be set with the same anchor point and parent origin. And, if the scaling property is set to a value
public:
/**
* @brief Different types of alignment.
+ * @SINCE_1_0.0
*/
enum Type
{
/**
* @brief Scaling determines how actors are scaled, to match the alignment's boundary.
+ * @SINCE_1_0.0
*/
enum Scaling
{
- ScaleNone, ///< The original size is kept.
- ScaleToFill, ///< Scale added actors to fill alignment's boundary. Aspect ratio is not maintained.
- ScaleToFitKeepAspect, ///< Scale added actors to fit within the alignment's boundary. Aspect ratio is maintained.
- ScaleToFillKeepAspect, ///< Scale added actors to fill the alignment's boundary. Aspect ratio is maintained, and the actor may exceed the alignment's boundary.
- ShrinkToFit, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is not maintained
- ShrinkToFitKeepAspect, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is maintained
+ ScaleNone, ///< The original size is kept. @SINCE_1_0.0
+ ScaleToFill, ///< Scale added actors to fill alignment's boundary. Aspect ratio is not maintained. @SINCE_1_0.0
+ ScaleToFitKeepAspect, ///< Scale added actors to fit within the alignment's boundary. Aspect ratio is maintained. @SINCE_1_0.0
+ ScaleToFillKeepAspect, ///< Scale added actors to fill the alignment's boundary. Aspect ratio is maintained, and the actor may exceed the alignment's boundary. @SINCE_1_0.0
+ ShrinkToFit, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is not maintained @SINCE_1_0.0
+ ShrinkToFitKeepAspect, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is maintained @SINCE_1_0.0
};
/**
* @brief Structure describing the padding values.
+ * @SINCE_1_0.0
*/
struct Padding
{
/**
* @brief Constructor
+ * @SINCE_1_0.0
*/
Padding()
: left( 0.f ),
/**
* @brief Constructor
*
+ * @SINCE_1_0.0
* @param[in] l Left padding
* @param[in] r Right padding
* @param[in] t Top padding
* @brief Create an Alignment handle; this can be initialised with Alignment::New().
*
* Calling member functions with an uninitialised handle is not allowed.
+ * @SINCE_1_0.0
*/
Alignment();
/**
* @brief Creates an alignment control.
*
+ * @SINCE_1_0.0
* @param [in] horizontal Specifies how to align actors horizontally. Could be HorizontalLeft, HorizontalCenter or HorizontalRight. By default HorizontalCenter.
* @param [in] vertical Specifies how to align actors vertically. Could be VerticalTop, VerticalCenter or VerticalBottom. By default VerticalCenter.
* @return A handle to the Alignment control.
/**
* @brief Copy constructor. Creates another handle that points to the same real object.
*
+ * @SINCE_1_0.0
* @param[in] alignment Object to copy.
*/
Alignment(const Alignment& alignment);
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Alignment();
* If handle points to a Alignment 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 Alignment or an uninitialized handle
*/
/**
* @brief Sets the new alignment. By default ( HorizontalCenter | VerticalCenter ).
*
- * @note there should only be one horizontal and one vertical policy
+ * @SINCE_1_0.0
* @param [in] type The new alignment option.
+ * @note there should only be one horizontal and one vertical policy
*/
void SetAlignmentType( Type type );
* }
* @endcode
*
+ * @SINCE_1_0.0
* @return the alignment value.
*/
Type GetAlignmentType() const;
/**
* @brief Sets how added actors scale to fit the alignment's boundary.
*
- * @see Scaling.
+ * @SINCE_1_0.0
* @param[in] scaling The scaling property.
+ * @see Scaling.
*/
void SetScaling( Scaling scaling );
/**
* @brief Retrieves the scaling property.
*
- * @see Scaling.
+ * @SINCE_1_0.0
* @return The scaling.
+ * @see Scaling.
*/
Scaling GetScaling() const;
/**
* @brief Set a padding value.
*
+ * @SINCE_1_0.0
* @param [in] padding The left, right, top, bottom padding values.
*/
void SetPadding( const Padding& padding );
/**
* @brief Get the padding values.
*
+ * @SINCE_1_0.0
* @return The left, right, top, bottom padding values.
*/
const Padding& GetPadding() const;
* @brief Assignment operator.
*
* Changes this handle to point to another real object.
+ * @SINCE_1_0.0
* @param[in] alignment Object to copy
* @return A reference to this
*/
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL Alignment( Internal::Alignment& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal );
* | %Action Name | %Button method called |
* |------------------|-----------------------------|
* | buttonClick | %DoClickAction() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Button : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the Button class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- DISABLED = PROPERTY_START_INDEX, ///< name "disabled", @see SetDisabled(), type bool
- AUTO_REPEATING, ///< name "autoRepeating", @see SetAutoRepeating(), type bool
- INITIAL_AUTO_REPEATING_DELAY, ///< name "initialAutoRepeatingDelay", @see SetInitialAutoRepeatingDelay(), type float
- NEXT_AUTO_REPEATING_DELAY, ///< name "nextAutoRepeatingDelay", @see SetNextAutoRepeatingDelay(), type float
- TOGGLABLE, ///< name "togglable", @see SetTogglableButton(), type bool
- SELECTED, ///< name "selected", @see SetSelected(), type bool
- UNSELECTED_STATE_IMAGE, ///< name "unselectedStateImage", @see SetUnselectedImage(), type std::string
- SELECTED_STATE_IMAGE, ///< name "selectedStateImage", @see SetSelectedImage(), type std::string
- DISABLED_STATE_IMAGE, ///< name "disabledStateImage", @see SetDisabledImage(), type std::string
- UNSELECTED_COLOR, ///< name "unselectedColor", type Vector4
- SELECTED_COLOR, ///< name "selectedColor", type Vector4
- LABEL, ///< name "label", type Property::Map
+ DISABLED = PROPERTY_START_INDEX, ///< name "disabled", @see SetDisabled(), type bool @SINCE_1_0.0
+ AUTO_REPEATING, ///< name "autoRepeating", @see SetAutoRepeating(), type bool @SINCE_1_0.0
+ INITIAL_AUTO_REPEATING_DELAY, ///< name "initialAutoRepeatingDelay", @see SetInitialAutoRepeatingDelay(), type float @SINCE_1_0.0
+ NEXT_AUTO_REPEATING_DELAY, ///< name "nextAutoRepeatingDelay", @see SetNextAutoRepeatingDelay(), type float @SINCE_1_0.0
+ TOGGLABLE, ///< name "togglable", @see SetTogglableButton(), type bool @SINCE_1_0.0
+ SELECTED, ///< name "selected", @see SetSelected(), type bool @SINCE_1_0.0
+ UNSELECTED_STATE_IMAGE, ///< name "unselectedStateImage", @see SetUnselectedImage(), type std::string @SINCE_1_0.0
+ SELECTED_STATE_IMAGE, ///< name "selectedStateImage", @see SetSelectedImage(), type std::string @SINCE_1_0.0
+ DISABLED_STATE_IMAGE, ///< name "disabledStateImage", @see SetDisabledImage(), type std::string @SINCE_1_0.0
+ UNSELECTED_COLOR, ///< name "unselectedColor", type Vector4 @SINCE_1_0.0
+ SELECTED_COLOR, ///< name "selectedColor", type Vector4 @SINCE_1_0.0
+ LABEL, ///< name "label", type Property::Map @SINCE_1_0.0
// Deprecated properties:
- LABEL_TEXT, ///< name "labelText", @see SetLabelText(), type std::string
+ LABEL_TEXT, ///< name "labelText", @see SetLabelText(), type std::string @SINCE_1_0.0
};
};
*
* Only derived versions can be instantiated. Calling member
* functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
Button();
/**
* @brief Copy constructor.
+ * @SINCE_1_0.0
*/
Button( const Button& button );
/**
* @brief Assignment operator.
+ * @SINCE_1_0.0
*/
Button& operator=( const Button& button );
* If handle points to a Button 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 Button or an uninitialized handle
*/
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Button();
*
* No signals are emitted when the \e disabled property is set.
*
+ * @SINCE_1_0.0
* @param[in] disabled property.
*/
void SetDisabled( bool disabled );
/**
+ * @SINCE_1_0.0
* @return \e true if the button is \e disabled.
*/
bool IsDisabled() const;
* If the \e autorepeating property is set to \e true, then the \e togglable property is set to false
* but no signal is emitted.
*
+ * @SINCE_1_0.0
* @param[in] autoRepeating \e autorepeating property.
*/
void SetAutoRepeating( bool autoRepeating );
/**
+ * @SINCE_1_0.0
* @return \e true if the \e autorepeating property is set.
*/
bool IsAutoRepeating() const;
*
* By default this value is set to 0.15 seconds.
*
- * @pre initialAutoRepeatingDelay must be greater than zero.
+ * @SINCE_1_0.0
* @param[in] initialAutoRepeatingDelay in seconds.
+ * @pre initialAutoRepeatingDelay must be greater than zero.
*/
void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
/**
+ * @SINCE_1_0.0
* @return the initial autorepeating delay in seconds.
*/
float GetInitialAutoRepeatingDelay() const;
*
* By default this value is set to 0.05 seconds.
*
- * @pre nextAutoRepeatingDelay must be greater than zero.
+ * @SINCE_1_0.0
* @param[in] nextAutoRepeatingDelay in seconds.
+ * @pre nextAutoRepeatingDelay must be greater than zero.
*/
void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
/**
+ * @SINCE_1_0.0
* @return the next autorepeating delay in seconds.
*/
float GetNextAutoRepeatingDelay() const;
*
* If the \e togglable property is set to \e true, then the \e autorepeating property is set to false.
*
+ * @SINCE_1_0.0
* @param[in] togglable property.
*/
void SetTogglableButton( bool togglable );
/**
+ * @SINCE_1_0.0
* @return \e true if the \e togglable property is set.
*/
bool IsTogglableButton() const;
/**
- * Sets the button as selected or unselected.
+ * @brief Sets the button as selected or unselected.
*
* \e togglable property must be set to \e true.
*
* Emits a Button::StateChangedSignal() signal.
*
+ * @SINCE_1_0.0
* @param[in] selected property.
*/
void SetSelected( bool selected );
/**
+ * @SINCE_1_0.0
* @return \e true if the \e selected property is set and the button is togglable.
*/
bool IsSelected() const;
/**
* @brief Sets the animation time.
*
+ * @SINCE_1_0.0
* @param[in] animationTime The animation time in seconds.
*/
void SetAnimationTime( float animationTime );
/**
* @brief Retrieves button's animation time.
*
+ * @SINCE_1_0.0
* @return The animation time in seconds.
*/
float GetAnimationTime() const;
/**
* @brief Sets the button's label.
*
+ * @SINCE_1_0.0
* @param[in] label The label text.
*/
void SetLabelText( const std::string& label );
/**
* @brief Gets the label.
*
+ * @SINCE_1_0.0
* @return The label text.
*/
std::string GetLabelText() const;
/**
* @brief Sets the unselected button image.
*
+ * @SINCE_1_0.0
* @param[in] filename The button image.
*/
void SetUnselectedImage( const std::string& filename );
/**
* @brief Sets the background image.
*
+ * @SINCE_1_0.0
* @param[in] filename The background image.
*/
void SetBackgroundImage( const std::string& filename );
/**
* @brief Sets the selected image.
*
+ * @SINCE_1_0.0
* @param[in] filename The selected image.
*/
void SetSelectedImage( const std::string& filename );
/**
* @brief Sets the selected background image.
*
+ * @SINCE_1_0.0
* @param[in] filename The selected background image.
*/
void SetSelectedBackgroundImage( const std::string& filename );
/**
* @brief Sets the disabled background image.
*
+ * @SINCE_1_0.0
* @param[in] filename The disabled background image.
*/
void SetDisabledBackgroundImage( const std::string& filename );
/**
* @brief Sets the disabled button image.
*
+ * @SINCE_1_0.0
* @param[in] filename The disabled button image.
*/
void SetDisabledImage( const std::string& filename );
/**
* @brief Sets the disabled selected button image.
*
+ * @SINCE_1_0.0
* @param[in] filename The disabled selected button image.
*/
void SetDisabledSelectedImage( const std::string& filename );
*
* @brief Sets the label with an actor.
*
+ * @SINCE_1_0.0
* @param[in] label The actor to use as a label
*/
void SetLabel( Actor label );
*
* @brief Sets the button image.
*
+ * @SINCE_1_0.0
* @param[in] image The button image.
*/
void SetButtonImage( Image image );
*
* @brief Sets the selected image.
*
+ * @SINCE_1_0.0
* @param[in] image The selected image.
*/
void SetSelectedImage( Image image );
*
* @brief Gets the button image.
*
+ * @SINCE_1_0.0
* @return An actor with the button image.
*/
Actor GetButtonImage() const;
*
* @brief Gets the selected image.
*
+ * @SINCE_1_0.0
* @return An actor with the selected image.
*/
Actor GetSelectedImage() const;
/**
* @brief Button signal type
+ * @SINCE_1_0.0
*/
typedef Signal< bool ( Button ) > ButtonSignalType;
* @code
* bool YourCallbackName( Button button );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
ButtonSignalType& PressedSignal();
* @code
* bool YourCallbackName( Button button );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
ButtonSignalType& ReleasedSignal();
* @code
* bool YourCallbackName( Button button );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
ButtonSignalType& ClickedSignal();
* @code
* bool YourCallbackName( Button button );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
ButtonSignalType& StateChangedSignal();
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL Button( Internal::Button& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
*/
/**
- * CheckBoxButton provides a check box button which user can check or uncheck.
+ * @brief CheckBoxButton provides a check box button which user can check or uncheck.
*
* By default a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
*
*
* CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
* and a CheckBoxButton could be used instead.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API CheckBoxButton : public Button
{
public:
/**
- * Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
+ * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
CheckBoxButton();
/**
- * Copy constructor.
+ * @brief Copy constructor.
+ * @SINCE_1_0.0
*/
CheckBoxButton( const CheckBoxButton& checkBox );
/**
- * Assignment operator.
+ * @brief Assignment operator.
+ * @SINCE_1_0.0
*/
CheckBoxButton& operator=( const CheckBoxButton& checkBox );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~CheckBoxButton();
/**
- * Create an initialized CheckBoxButton.
+ * @brief Create an initialized CheckBoxButton.
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali resource.
*/
static CheckBoxButton New();
/**
- * Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
+ * @brief Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton 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 CheckBoxButton or an uninitialized handle
*/
public: // Not intended for application developers
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& implementation );
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
* and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button.
*
* See Button for more detail on signals and modifying appearance via properties.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API PushButton : public Button
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices
+ PROPERTY_START_INDEX = Button::PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserving 1000 property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the PushButton class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string
- SELECTED_ICON, ///< Property, name "selectedIcon", type std::string
- ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string
- LABEL_PADDING, ///< Property, name "labelPadding", type Vector4
- ICON_PADDING, ///< Property, name "iconPadding", type Vector4
+ UNSELECTED_ICON = PROPERTY_START_INDEX, ///< Property, name "unselectedIcon", type std::string @SINCE_1_0.0
+ SELECTED_ICON, ///< Property, name "selectedIcon", type std::string @SINCE_1_0.0
+ ICON_ALIGNMENT, ///< Property, name "iconAlignment", type std::string @SINCE_1_0.0
+ LABEL_PADDING, ///< Property, name "labelPadding", type Vector4 @SINCE_1_0.0
+ ICON_PADDING, ///< Property, name "iconPadding", type Vector4 @SINCE_1_0.0
};
};
* @brief Create an uninitialized PushButton; this can be initialized with PushButton::New().
*
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
PushButton();
/**
* @brief Copy constructor.
+ * @SINCE_1_0.0
*/
PushButton( const PushButton& pushButton );
/**
* @brief Assignment operator.
+ * @SINCE_1_0.0
*/
PushButton& operator=( const PushButton& pushButton );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~PushButton();
/**
* @brief Create an initialized PushButton.
*
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali resource.
*/
static PushButton New();
* If handle points to a PushButton 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 PushButton or an uninitialized handle
*/
*
* @brief Sets the unselected image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetButtonImage( Actor image );
*
* @brief Sets the background image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetBackgroundImage( Actor image );
*
* @brief Sets the selected image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetSelectedImage( Actor image );
*
* @brief Sets the selected background image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetSelectedBackgroundImage( Actor image );
*
* @brief Sets the disabled background image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetDisabledBackgroundImage( Actor image );
*
* @brief Sets the disabled image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetDisabledImage( Actor image );
*
* @brief Sets the disabled selected image with an Actor.
*
+ * @SINCE_1_0.0
* @param[in] image The Actor to use.
*/
void SetDisabledSelectedImage( Actor image );
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL PushButton( Internal::PushButton& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal );
* When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected.
*
* A Button::StateChangedSignal() is emitted when the RadioButton change its state to \e selected or \e unselected.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API RadioButton: public Button
{
* @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New().
*
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
RadioButton();
/**
* @brief Copy constructor.
+ * @SINCE_1_0.0
*/
RadioButton( const RadioButton& radioButton );
/**
* @brief Assignment operator.
+ * @SINCE_1_0.0
*/
RadioButton& operator=( const RadioButton& radioButton );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~RadioButton();
/**
* @brief Create an initialized RadioButton.
*
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali resource.
*/
static RadioButton New();
/**
* @brief Create an initialized RadioButton with given label.
*
+ * @SINCE_1_0.0
* @param[in] label The button label.
*
* @return A handle to a newly allocated Dali resource.
* If handle points to a RadioButton 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 RadioButton or an uninitialized handle
*/
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL RadioButton( Internal::RadioButton& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
* @deprecated DALi 1.1.16
*
* @brief These depth indices should not be used.
+ * @SINCE_1_0.0
*/
enum DepthIndexRanges
{
- BACKGROUND_DEPTH_INDEX = static_cast<int>( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), ///< @deprecated DALi 1.1.16
- CONTENT_DEPTH_INDEX = 0, ///< @deprecated DALi 1.1.16
- DECORATION_DEPTH_INDEX = static_cast<int>( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) ///< @deprecated DALi 1.1.16
+ BACKGROUND_DEPTH_INDEX = static_cast<int>( -Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ), ///< @deprecated DALi 1.1.16 @SINCE_1_0.0
+ CONTENT_DEPTH_INDEX = 0, ///< @deprecated DALi 1.1.16 @SINCE_1_0.0
+ DECORATION_DEPTH_INDEX = static_cast<int>( Dali::Layer::TREE_DEPTH_MULTIPLIER * 0.1f ) ///< @deprecated DALi 1.1.16 @SINCE_1_0.0
};
/**
* It will provide some common functionality required by all controls.
* Implements ConnectionTrackerInterface so that signals (typically connected to member functions) will
* be disconnected automatically when the control is destroyed.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Control : public CustomActorImpl, public ConnectionTrackerInterface
{
* @brief Create a new ControlImpl instance that does not require touch by default.
*
* If touch is required then the user can connect to this class' touch signal.
+ * @SINCE_1_0.0
* @return A handle to the ControlImpl instance.
*/
static Toolkit::Control New();
/**
* @brief Virtual destructor.
+ * @SINCE_1_0.0
*/
virtual ~Control();
/**
* @brief Set the background with a property map.
*
+ * @SINCE_1_0.0
* @param[in] map The background property map.
*/
void SetBackground(const Property::Map& map);
* @code
* EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
* @endcode
+ * @SINCE_1_0.0
* @param[in] type The gesture type(s) to enable.
*/
void EnableGestureDetection( Gesture::Type type );
* @brief Allows deriving classes to disable any of the gesture detectors.
*
* Like EnableGestureDetection, this can also be called using bitwise or.
+ * @SINCE_1_0.0
* @param[in] type The gesture type(s) to disable.
* @see EnableGetureDetection
*/
* detection then they can access the gesture detector through this
* API and modify the detection.
*
+ * @SINCE_1_0.0
* @return The pinch gesture detector.
* @pre Pinch detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
* detection then they can access the gesture detector through this
* API and modify the detection.
*
+ * @SINCE_1_0.0
* @return The pan gesture detector.
* @pre Pan detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
* detection then they can access the gesture detector through this
* API and modify the detection.
*
+ * @SINCE_1_0.0
* @return The tap gesture detector.
* @pre Tap detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
* detection then they can access the gesture detector through this
* API and modify the detection.
*
+ * @SINCE_1_0.0
* @return The long press gesture detector.
* @pre Long press detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
* keyboard focus movement between its child actors).
*
* The control doesn't support it by default.
+ * @SINCE_1_0.0
* @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
*/
void SetKeyboardNavigationSupport( bool isSupported );
/**
* @brief Gets whether this control supports two dimensional keyboard navigation.
*
+ * @SINCE_1_0.0
* @return true if this control supports two dimensional keyboard navigation.
*/
bool IsKeyboardNavigationSupported();
*
* (i.e. the scope of keyboard focus movement
* can be limitied to its child actors). The control is not a focus group by default.
+ * @SINCE_1_0.0
* @param[in] isFocusGroup Whether this control is set as a focus group for keyboard navigation.
*/
void SetAsKeyboardFocusGroup( bool isFocusGroup );
/**
* @brief Gets whether this control is a focus group for keyboard navigation.
*
+ * @SINCE_1_0.0
* @return true if this control is set as a focus group for keyboard navigation.
*/
bool IsKeyboardFocusGroup();
/**
* @brief Called by the AccessibilityManager to activate the Control.
+ * @SINCE_1_0.0
*/
DALI_INTERNAL void AccessibilityActivate();
/**
* @brief Called by the KeyboardFocusManager.
+ * @SINCE_1_0.0
*/
DALI_INTERNAL void KeyboardEnter();
/**
* @brief Called by the KeyInputFocusManager to emit key event signals.
*
+ * @SINCE_1_0.0
* @param[in] event The key event.
* @return True if the event was consumed.
*/
*
* Should be called last by the control after it acts on the Input Focus change.
*
+ * @SINCE_1_0.0
* @param[in] focusGained True if gained, False if lost
*/
void EmitKeyInputFocusSignal( bool focusGained );
// Flags for the constructor
enum ControlBehaviour
{
- REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change
- REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation
+ REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0
+ REQUIRES_KEYBOARD_NAVIGATION_SUPPORT = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 1 ), ///< True if needs to support keyboard navigation @SINCE_1_0.0
LAST_CONTROL_BEHAVIOUR_FLAG
};
/**
* @brief Control constructor
*
+ * @SINCE_1_0.0
* @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
*/
Control( ControlBehaviour behaviourFlags );
/**
* @brief Second phase initialization.
+ * @SINCE_1_0.0
*/
void Initialize();
* @brief This method is called after the Control has been initialized.
*
* Derived classes should do any second phase initialization by overriding this method.
+ * @SINCE_1_0.0
*/
virtual void OnInitialize();
*
* Could be overridden by derived classes.
*
+ * @SINCE_1_0.0
* @param[in] child The added actor.
*/
virtual void OnControlChildAdd( Actor& child );
*
* Could be overridden by derived classes.
*
+ * @SINCE_1_0.0
* @param[in] child The removed actor.
*/
virtual void OnControlChildRemove( Actor& child );
/**
* @brief This method should be overridden by deriving classes requiring notifications when the style changes.
*
+ * @SINCE_1_0.0
* @param[in] styleManager The StyleManager object.
* @param[in] change Information denoting what has changed.
*/
* @brief This method is called when the control is accessibility activated.
*
* Derived classes should override this to perform custom accessibility activation.
+ * @SINCE_1_0.0
* @return true if this control can perform accessibility activation.
*/
virtual bool OnAccessibilityActivated();
* @brief This method should be overridden by deriving classes when they wish to respond the accessibility
* pan gesture.
*
+ * @SINCE_1_0.0
* @param[in] gesture The pan gesture.
* @return true if the pan gesture has been consumed by this control
*/
* @brief This method should be overridden by deriving classes when they wish to respond the accessibility
* touch event.
*
+ * @SINCE_1_0.0
* @param[in] touchEvent The touch event.
* @return true if the touch event has been consumed by this control
*/
* @brief This method should be overridden by deriving classes when they wish to respond
* the accessibility up and down action (i.e. value change of slider control).
*
+ * @SINCE_1_0.0
* @param[in] isIncrease Whether the value should be increased or decreased
* @return true if the value changed action has been consumed by this control
*/
* @brief This method should be overridden by deriving classes when they wish to respond
* the accessibility zoom action
*
+ * @SINCE_1_0.0
* @return true if the zoom action has been consumed by this control
*/
virtual bool OnAccessibilityZoom();
* @brief Called when the control gains key input focus.
*
* Should be overridden by derived classes if they need to customize what happens when focus is gained.
+ * @SINCE_1_0.0
*/
virtual void OnKeyInputFocusGained();
* @brief Called when the control loses key input focus.
*
* Should be overridden by derived classes if they need to customize what happens when focus is lost.
+ * @SINCE_1_0.0
*/
virtual void OnKeyInputFocusLost();
* @brief Gets the next keyboard focusable actor in this control towards the given direction.
*
* A control needs to override this function in order to support two dimensional keyboard navigation.
+ * @SINCE_1_0.0
* @param[in] currentFocusedActor The current focused actor.
* @param[in] direction The direction to move the focus towards.
* @param[in] loopEnabled Whether the focus movement should be looped within the control.
* This allows the application to preform any actions if wishes
* before the focus is actually moved to the chosen actor.
*
+ * @SINCE_1_0.0
* @param[in] commitedFocusableActor The commited focusable actor.
*/
virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
* @brief This method is called when the control has enter pressed on it.
*
* Derived classes should override this to perform custom actions.
+ * @SINCE_1_0.0
* @return true if this control supported this action.
*/
virtual bool OnKeyboardEnter();
* is enabled. The default behaviour is to scale the control by the
* pinch scale.
*
+ * @SINCE_1_0.0
+ * @param[in] pinch The pinch gesture.
* @note If overridden, then the default behaviour will not occur.
* @note Pinch detection should be enabled via EnableGestureDetection().
- * @param[in] pinch The pinch gesture.
* @see EnableGestureDetection
*/
virtual void OnPinch( const PinchGesture& pinch );
* This should be overridden by deriving classes when pan detection
* is enabled.
*
+ * @SINCE_1_0.0
+ * @param[in] pan The pan gesture.
* @note There is no default behaviour with panning.
* @note Pan detection should be enabled via EnableGestureDetection().
- * @param[in] pan The pan gesture.
* @see EnableGestureDetection
*/
virtual void OnPan( const PanGesture& pan );
* This should be overridden by deriving classes when tap detection
* is enabled.
*
+ * @SINCE_1_0.0
+ * @param[in] tap The tap gesture.
* @note There is no default behaviour with a tap.
* @note Tap detection should be enabled via EnableGestureDetection().
- * @param[in] tap The tap gesture.
* @see EnableGestureDetection
*/
virtual void OnTap( const TapGesture& tap );
* This should be overridden by deriving classes when long press
* detection is enabled.
*
+ * @SINCE_1_0.0
+ * @param[in] longPress The long press gesture.
* @note There is no default behaviour associated with a long press.
* @note Long press detection should be enabled via EnableGestureDetection().
- * @param[in] longPress The long press gesture.
* @see EnableGestureDetection
*/
virtual void OnLongPress( const LongPressGesture& longPress );
virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
/**
- * Retrieve the extension for this control
+ * @brief Retrieve the extension for this control
*
+ * @SINCE_1_0.0
* @return The extension if available, NULL otherwise
*/
virtual Extension* GetControlExtension()
/**
* @brief Get implementation from the handle
*
- * @pre handle is initialized and points to a control
+ * @SINCE_1_0.0
* @param handle
* @return implementation
+ * @pre handle is initialized and points to a control
*/
DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
/**
* @brief Get implementation from the handle
*
- * @pre handle is initialized and points to a control
+ * @SINCE_1_0.0
* @param handle
* @return implementation
+ * @pre handle is initialized and points to a control
*/
DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
* @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
/**
* @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
{
- STYLE_NAME = PROPERTY_START_INDEX, ///< name "styleName", @see SetStyleName, type std::string
- BACKGROUND_COLOR, ///< name "background-color", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4
- BACKGROUND_IMAGE, ///< name "background-image", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map
- KEY_INPUT_FOCUS, ///< name "keyInputFocus", @see SetKeyInputFocus, type bool
- BACKGROUND, ///< name "background", @since DALi 1.1.3 mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map
+ STYLE_NAME = PROPERTY_START_INDEX, ///< name "styleName", @see SetStyleName, type std::string @SINCE_1_0.0
+ BACKGROUND_COLOR, ///< name "background-color", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4 @SINCE_1_0.0
+ BACKGROUND_IMAGE, ///< name "background-image", @deprecated DALi 1.1.3 mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map @SINCE_1_0.0
+ KEY_INPUT_FOCUS, ///< name "keyInputFocus", @see SetKeyInputFocus, type bool @SINCE_1_0.0
+ BACKGROUND, ///< name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map @SINCE_1_1.3
};
};
/**
* @brief Describes the direction to move the keyboard focus towards.
+ * @SINCE_1_0.0
*/
struct KeyboardFocus
{
enum Direction
{
- 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
+ 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
};
};
/**
* @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
+ * @SINCE_1_0.0
* @param[in] uiControl Handle to copy
*/
Control(const Control& uiControl);
* @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
+ * @SINCE_1_0.0
* @param[in] handle Object to assign this to
* @return reference to this
*/
* 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
*/
* @brief This sets the control to receive key events.
*
* The key event can originate from a virtual or physical keyboard.
+ * @SINCE_1_0.0
+ * @return True if the control has foucs, False otherwise.
* @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();
* 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()
+ * @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.
- * @return true if this control has keyboard input focus
*/
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.
*/
/**
* @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;
/**
* @brief Sets the background color of the control.
*
- * @note if SetBackgroundImage is called later, this background color is removed.
- *
+ * @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 );
/**
- * @brief Retrieves the background color of the control.
- *
* @deprecated DALi 1.1.3 API removed.
*
+ * @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.
*
+ * @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();
* @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.
- * @pre The Control has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Control has been initialized.
*/
KeyEventSignalType& KeyEventSignal();
* @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.
- * @pre The Control has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Control has been initialized.
*/
KeyInputFocusSignalType& KeyInputFocusGainedSignal();
* @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.
- * @pre The Control has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Control has been initialized.
*/
KeyInputFocusSignalType& KeyInputFocusLostSignal();
/**
* @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>
*
* If the \e border parameter is set to \e true, the Dali::ImageActor's style is set to Dali::ImageActor::STYLE_NINE_PATCH.
*
+ * @SINCE_1_0.0
* @param[in] color The ImageActor's color.
* @param[in] border If \e true, a border is created. By default, the value is set to \e false.
* @param[in] borderColor The color for the ImageActor's border. By default, the value is set to Color::WHITE.
*/
/**
- *
+ * @brief
* GaussianBlurView is a class for applying a render process that blurs an image.
*
* Basic idea:-
* // Stop rendering the GaussianBlurView\n
* Stage::GetCurrent().Remove(gaussianBlurView);\n
* gaussianBlurView.Deactivate();\n
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API GaussianBlurView : public Control
{
public:
/**
- * Signal type for notifications
+ * @brief Signal type for notifications
+ * @SINCE_1_0.0
*/
typedef Signal< void (GaussianBlurView source) > GaussianBlurViewSignal;
/**
- * Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New()
+ * @brief Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New()
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
GaussianBlurView();
/**
- * Copy constructor. Creates another handle that points to the same real object
+ * @brief Copy constructor. Creates another handle that points to the same real object
+ * @SINCE_1_0.0
*/
GaussianBlurView(const GaussianBlurView& handle);
/**
- * Assignment operator. Changes this handle to point to another real object
+ * @brief Assignment operator. Changes this handle to point to another real object
+ * @SINCE_1_0.0
*/
GaussianBlurView& operator=(const GaussianBlurView& ZoomView);
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~GaussianBlurView();
/**
- * Downcast an Object handle to GaussianBlurView. If handle points to a GaussianBlurView the
+ * @brief Downcast an Object handle to GaussianBlurView. If handle points to a GaussianBlurView 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 GaussianBlurView or an uninitialized handle
*/
static GaussianBlurView DownCast( BaseHandle handle );
/**
- * Create an initialized GaussianBlurView, using default settings. The default settings are:-\n
+ * @brief Create an initialized GaussianBlurView, using default settings. The default settings are:-\n
*
* numSamples = 5\n
* blurBellCurveWidth = 1.5\n
* downsampleWidthScale = 0.5\n
* downsampleHeightScale = 0.5\n
* blurUserImage = false
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali resource
*/
static GaussianBlurView New();
/**
- * Create an initialized GaussianBlurView.
+ * @brief Create an initialized GaussianBlurView.
+ * @SINCE_1_0.0
* @param numSamples The size of the Gaussian blur kernel (number of samples in horizontal / vertical blur directions).
* @param blurBellCurveWidth The constant controlling the Gaussian function, must be > 0.0. Controls the width of the bell curve, i.e. the look of the blur and also indirectly
* the amount of blurriness Smaller numbers for a tighter curve. Useful values in the range [0.5..3.0] - near the bottom of that range the curve is weighted heavily towards
bool blurUserImage = false);
/**
- * Adds a child Actor to this Actor.
+ * @brief Adds a child Actor to this Actor.
* NOTE! if the child already has a parent, it will be removed from old parent
* and reparented to this actor. This may change childs position, color, shader effect,
* scale etc as it now inherits them from this actor
+ * @SINCE_1_0.0
+ * @param [in] child The child.
* @pre This Actor (the parent) has been initialized.
* @pre The child actor has been initialized.
* @pre The child actor is not the same as the parent actor.
* @pre The actor is not the Root actor
- * @param [in] child The child.
* @post The child will be referenced by its parent. This means that the child will be kept alive,
* even if the handle passed into this method is reset or destroyed.
*/
void Add(Actor child);
/**
- * Removes a child Actor from this Actor.
+ * @brief Removes a child Actor from this Actor.
* If the actor was not a child of this actor, this is a no-op.
+ * @SINCE_1_0.0
+ * @param [in] child The child.
* @pre This Actor (the parent) has been initialized.
* @pre The child actor is not the same as the parent actor.
- * @param [in] child The child.
*/
void Remove(Actor child);
/**
- * Start rendering the GaussianBlurView. Must be called after you Add() it to the stage.
+ * @brief Start rendering the GaussianBlurView. Must be called after you Add() it to the stage.
+ * @SINCE_1_0.0
*/
void Activate();
/**
- * Render the GaussianBlurView once. Must be called after you Add() it to the stage.
+ * @brief Render the GaussianBlurView once. Must be called after you Add() it to the stage.
* Only works with a gaussian blur view created with blurUserImage = true.
* Listen to the Finished signal to determine when the rendering has completed.
+ * @SINCE_1_0.0
*/
void ActivateOnce();
/**
- * Stop rendering the GaussianBlurView. Must be called after you Remove() it from the stage.
+ * @brief Stop rendering the GaussianBlurView. Must be called after you Remove() it from the stage.
+ * @SINCE_1_0.0
*/
void Deactivate();
/**
- * Sets a custom image to be blurred and a render target to receive the blurred result. If this is called the children of the GaussianBlurObject will not be rendered blurred,
+ * @brief Sets a custom image to be blurred and a render target to receive the blurred result. If this is called the children of the GaussianBlurObject will not be rendered blurred,
* instead the inputImage will get blurred.
* To retrieve the blurred image the user can either pass a handle on a render target they own as the second parameter to SetUserImageAndOutputRenderTarget( ... ), or they
* can pass NULL for this parameter and instead call GetBlurredRenderTarget() which will return a handle on a render target created internally to the GaussianBlurView object.
- * @pre This object was created with a New( ... ) call where the blurUserImage argument was set to true. If this was not the case an exception will be thrown.
+ * @SINCE_1_0.0
* @param inputImage The image that the user wishes to blur.
* @param outputRenderTarget A render target to receive the blurred result. Passing NULL is allowed. See also GetBlurredRenderTarget().
+ * @pre This object was created with a New( ... ) call where the blurUserImage argument was set to true. If this was not the case an exception will be thrown.
*/
void SetUserImageAndOutputRenderTarget(Image inputImage, FrameBufferImage outputRenderTarget);
/**
- * Get the index of the property that can be used to fade the blur in / out. This is the overall strength of the blur.
+ * @brief Get the index of the property that can be used to fade the blur in / out. This is the overall strength of the blur.
* User can use this to animate the blur. A value of 0.0 is zero blur and 1.0 is full blur. Default is 1.0.
* Note that if you set the blur to 0.0, the result will be no blur BUT the internal rendering will still be happening. If you wish to turn the blur off, you should remove
* the GaussianBlurView object from the stage also.
+ * @SINCE_1_0.0
* @return Index of the property that can be used to fade the blur in / out
*/
Dali::Property::Index GetBlurStrengthPropertyIndex() const;
/**
- * Get the final blurred image.
+ * @brief Get the final blurred image.
* Use can call this function to get the blurred result as an image, to use as they wish. It is not necessary to call this unless you specifically require it.
- * @pre The user must call Activate() before the render target will be returned.
+ * @SINCE_1_0.0
* @return A handle on the blurred image, contained in a render target.
+ * @pre The user must call Activate() before the render target will be returned.
*/
FrameBufferImage GetBlurredRenderTarget() const;
/**
- * Set background color for the view. The background will be filled with this color.
+ * @brief Set background color for the view. The background will be filled with this color.
+ * @SINCE_1_0.0
* @param[in] color The background color.
*/
void SetBackgroundColor( const Vector4& color );
/**
- * Get the background color.
+ * @brief Get the background color.
+ * @SINCE_1_0.0
* @return The background color.
*/
Vector4 GetBackgroundColor() const;
public: // Signals
/**
- * If ActivateOnce has been called, then connect to this signal to be notified when the
+ * @brief If ActivateOnce has been called, then connect to this signal to be notified when the
* target actor has been rendered.
+ * @SINCE_1_0.0
* @return The Finished signal
*/
GaussianBlurViewSignal& FinishedSignal();
public:
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_0.0
* @param[in] implementation The UI Control implementation.
*/
DALI_INTERNAL GaussianBlurView( Internal::GaussianBlurView& implementation );
/**
- * Allows the creation of this UI Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this UI Control from an Internal::CustomActor pointer.
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL GaussianBlurView( Dali::Internal::CustomActor* internal );
*/
/**
- *
* @brief ImageView is a class for displaying an Image.
+ * @SINCE_1_0.0
+ *
*/
class DALI_IMPORT_API ImageView : public Control
{
public:
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0
- ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @since DALi 1.1.18
- ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices, @since DALi 1.1.18
+ ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.18
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices, @SINCE_1_1.18
};
/**
* @brief An enumeration of properties belonging to the ImageView class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
// Event side properties
- RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resourceUrl", @deprecated DALi 1.1.16 Use IMAGE instead. type string
- IMAGE, ///< name "image", @see SetImage(), type string if it is a url, map otherwise
- PRE_MULTIPLIED_ALPHA, ///< name "preMultipliedAlpha", @since DALi 1.1.18 type Boolean @pre image must be initialized.
+ RESOURCE_URL = PROPERTY_START_INDEX, ///< name "resourceUrl", @deprecated DALi 1.1.16 Use IMAGE instead. type string @SINCE_1_0.0
+ IMAGE, ///< name "image", @see SetImage(), type string if it is a url, map otherwise @SINCE_1_0.0
+ PRE_MULTIPLIED_ALPHA, ///< name "preMultipliedAlpha", type Boolean @pre image must be initialized. @SINCE_1_1.18
// Animatable properties
- PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, ///< name "pixelArea", @since DALi 1.1.18 type Vector4, Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
+ PIXEL_AREA = ANIMATABLE_PROPERTY_START_INDEX, ///< name "pixelArea", type Vector4, Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0]. @SINCE_1_1.18
};
};
/**
* @brief Create an uninitialized ImageView.
+ * @SINCE_1_0.0
*/
ImageView();
/**
* @brief Create an initialized ImageView.
*
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali ImageView.
*
* @note ImageView will not display anything.
*
* If the handle is empty, ImageView will not display anything.
*
+ * @SINCE_1_0.0
* @param[in] image The Image to display.
* @return A handle to a newly allocated ImageView.
*/
*
* If the string is empty, ImageView will not display anything.
*
+ * @SINCE_1_0.0
* @param[in] url The url of the image resource to display.
* @return A handle to a newly allocated ImageView.
*/
*
* If the string is empty, ImageView will not display anything.
*
- * @since DALi 1.1.10
- *
+ * @SINCE_1_1.10
* @param[in] url The url of the image resource to display.
* @param [in] size The width and height to fit the loaded image to.
* @return A handle to a newly allocated ImageView.
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~ImageView();
/**
* @brief Copy constructor.
*
+ * @SINCE_1_0.0
* @param[in] imageView ImageView to copy. The copied ImageView will point at the same implementation
*/
ImageView( const ImageView& imageView );
/**
* @brief Assignment operator.
*
+ * @SINCE_1_0.0
* @param[in] imageView The ImageView to assign from.
* @return The updated ImageView.
*/
* If handle points to a ImageView 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 ImageView or an uninitialized handle
*/
* @brief Sets this ImageView from an Image
*
* If the handle is empty, ImageView will display nothing
+ * @SINCE_1_0.0
* @param[in] image The Image to display.
*/
void SetImage( Image image );
*
* If the URL is empty, ImageView will not display anything.
*
- * @since DALi 1.1.4
- *
+ * @SINCE_1_1.4
* @param[in] url The Image resource to display.
*/
void SetImage( const std::string& url );
*
* If the URL is empty, ImageView will not display anything.
*
- * @since DALi 1.1.10
- *
+ * @SINCE_1_1.10
* @param[in] url A URL to the image resource to display.
* @param [in] size The width and height to fit the loaded image to.
*/
/**
* @deprecated Gets the Image
*
+ * @SINCE_1_0.0
* @return The Image currently set to this ImageView
*/
Image GetImage() const;
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The ImageView implementation.
*/
DALI_INTERNAL ImageView( Internal::ImageView& implementation );
/**
* @brief Allows the creation of this ImageView from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
* All the geometry loaded with the control is automatically centered and scaled to fit
* the size of all the other controls. So the max is (0.5,0.5) and the min is (-0.5,-0.5)
*
- * @since DALi 1.1.4
+ * @SINCE_1_1.4
*/
class DALI_IMPORT_API Model3dView : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_1.4
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_1.4
- ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX,
- ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices
+ ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.4
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_1.4
};
/**
* @brief An enumeration of properties belonging to the TextLabel class.
+ * @SINCE_1_1.4
*/
struct Property
{
enum
{
- GEOMETRY_URL = PROPERTY_START_INDEX, ///< name "geometryUrl", The path to the geometry file, type STRING
- MATERIAL_URL, ///< name "materialUrl", The path to the material file, type STRING
- IMAGES_URL, ///< name "imagesUrl", The path to the images directory, type STRING
- ILLUMINATION_TYPE, ///< name "illuminationType", The type of illumination, type INTEGER
- TEXTURE0_URL, ///< name "texture0Url", The path to first texture, type STRING
- TEXTURE1_URL, ///< name "texture1Url", The path to second texture, type STRING
- TEXTURE2_URL, ///< name "texture2Url", The path to third texture, type STRING
-
- LIGHT_POSITION = ANIMATABLE_PROPERTY_START_INDEX ///< name "lightPosition", The coordinates of the light, type Vector3
+ GEOMETRY_URL = PROPERTY_START_INDEX, ///< name "geometryUrl", The path to the geometry file, type STRING @SINCE_1_1.4
+ MATERIAL_URL, ///< name "materialUrl", The path to the material file, type STRING @SINCE_1_1.4
+ IMAGES_URL, ///< name "imagesUrl", The path to the images directory, type STRING @SINCE_1_1.4
+ ILLUMINATION_TYPE, ///< name "illuminationType", The type of illumination, type INTEGER @SINCE_1_1.4
+ TEXTURE0_URL, ///< name "texture0Url", The path to first texture, type STRING @SINCE_1_1.4
+ TEXTURE1_URL, ///< name "texture1Url", The path to second texture, type STRING @SINCE_1_1.4
+ TEXTURE2_URL, ///< name "texture2Url", The path to third texture, type STRING @SINCE_1_1.4
+
+ LIGHT_POSITION = ANIMATABLE_PROPERTY_START_INDEX ///< name "lightPosition", The coordinates of the light, type Vector3 @SINCE_1_1.4
};
};
/**
* @brief Create a new instance of a Model3dView control.
*
+ * @SINCE_1_1.4
* @return A handle to the new Model3dView control.
*/
static Model3dView New();
/**
* @brief Create a new instance of a Model3dView control.
*
+ * @SINCE_1_1.4
* @return A handle to the new Model3dView control.
*/
static Model3dView New( const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl );
*
* Only derived versions can be instantiated. Calling member
* functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_1.4
*/
Model3dView();
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_1.4
*/
~Model3dView();
/**
* @brief Copy constructor.
+ * @SINCE_1_1.4
*/
Model3dView( const Model3dView& model3dView );
/**
* @brief Assignment operator.
+ * @SINCE_1_1.4
*/
Model3dView& operator=( const Model3dView& model3dView );
* If handle points to a Model3dView the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
+ * @SINCE_1_1.4
* @param[in] handle Handle to an object
* @return handle to a Model3dView or an uninitialized handle
*/
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_1.4
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL Model3dView( Internal::Model3dView& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_1.4
* @param[in] internal A pointer to the internal CustomActor.
*/
DALI_INTERNAL Model3dView( Dali::Internal::CustomActor* internal );
{
/**
- * PageFactory is an abstract interface for providing image actors to PageTurnView
+ * @brief PageFactory is an abstract interface for providing image actors to PageTurnView
* Each image actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1
*
- * @since DALi 1.1.4
+ * @SINCE_1_1.4
*/
class DALI_IMPORT_API PageFactory
{
public:
/**
- * Virtual destructor
+ * @brief Virtual destructor
+ * @SINCE_1_1.4
*/
virtual ~PageFactory(){};
/**
- * Query the number of pages available from the factory.
+ * @brief Query the number of pages available from the factory.
* The maximum available page has an ID of GetNumberOfPages()-1.
+ * @SINCE_1_1.4
*/
virtual unsigned int GetNumberOfPages() = 0;
/**
- * Create an actor to represent the page content.
+ * @brief Create an actor to represent the page content.
+ * @SINCE_1_1.4
* @param[in] pageId The ID of the page to create.
* @return An actor, or an uninitialized pointer if the ID is out of range.
*/
}
/**
- * PageTurnLandscapeView provides a page turn view in landscape mode
+ * @brief PageTurnLandscapeView provides a page turn view in landscape mode
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API PageTurnLandscapeView : public PageTurnView
{
public:
/**
- * Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New()
+ * @brief Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New()
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
PageTurnLandscapeView();
/**
- * Copy constructor.
+ * @brief Copy constructor.
+ * @SINCE_1_0.0
*/
PageTurnLandscapeView( const PageTurnLandscapeView& pageTurnLandscapeView );
/**
- * Assignment operator.
+ * @brief Assignment operator.
+ * @SINCE_1_0.0
*/
PageTurnLandscapeView& operator=( const PageTurnLandscapeView& pageTurnLandscapeView );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~PageTurnLandscapeView();
/**
- * Create an initialized PageTurnLandscapeView control
+ * @brief Create an initialized PageTurnLandscapeView control
+ * @SINCE_1_0.0
* @param[in] pageFactory The factory which provides PageTurnView with pages.
* @param[in] pageSize The size of the page
* @return A handle to the PageTurnLandscapeView control.
static PageTurnLandscapeView New( PageFactory& pageFactory, const Vector2& pageSize );
/**
- * Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView the
+ * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView 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 PageTurnLandscapeView or an uninitialized handle
*/
public: // Not intended for application developers
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL PageTurnLandscapeView( Internal::PageTurnLandscapeView& implementation );
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL PageTurnLandscapeView( Dali::Internal::CustomActor* internal );
}
/**
- * PageTurnLandscapeView provides a page turn view in portrait mode
+ * @brief PageTurnPortraitView provides a page turn view in portrait mode
*
- * @since DALi 1.1.4
+ * @SINCE_1_1.4
*/
class DALI_IMPORT_API PageTurnPortraitView : public PageTurnView
{
public:
/**
- * Create an uninitialized PageTurnPortraitView; this can be initialized with PageTurnPortraitView::New()
+ * @brief Create an uninitialized PageTurnPortraitView; this can be initialized with PageTurnPortraitView::New()
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_1.4
*/
PageTurnPortraitView();
/**
- * Copy constructor.
+ * @brief Copy constructor.
+ * @SINCE_1_1.4
*/
PageTurnPortraitView( const PageTurnPortraitView& pageTurnPortraitView );
/**
- * Assignment operator.
+ * @brief Assignment operator.
+ * @SINCE_1_1.4
*/
PageTurnPortraitView& operator=( const PageTurnPortraitView& pageTurnPortraitView );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_1.4
*/
~PageTurnPortraitView();
/**
- * Create an initialized PageTurnPortraitView control
+ * @brief Create an initialized PageTurnPortraitView control
+ * @SINCE_1_1.4
* @param[in] pageFactory The factory which provides PageTurnView with pages.
* @param[in] pageSize The size of the page
* @return A handle to the PageTurnPortraitView control.
static PageTurnPortraitView New( PageFactory& pageFactory, const Vector2& pageSize );
/**
- * Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnPortraitView the
+ * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnPortraitView the
* downcast produces valid handle. If not the returned handle is left uninitialized.
+ * @SINCE_1_1.4
* @param[in] handle Handle to an object
* @return handle to a PageTurnPortraitView or an uninitialized handle
*/
public: // Not intended for application developers
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_1.4
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL PageTurnPortraitView( Internal::PageTurnPortraitView& implementation );
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @SINCE_1_1.4
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL PageTurnPortraitView( Dali::Internal::CustomActor* internal );
* | pagePanStarted | @ref PagePanStartedSignal() |
* | pagePanFinished | @ref PagePanFinishedSignal() |
*
- * @since DALi 1.1.4
+ * @SINCE_1_1.4
*/
class DALI_IMPORT_API PageTurnView : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_1.4
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.4
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_1.4
};
struct Property
{
enum
{
- PAGE_SIZE = PROPERTY_START_INDEX, ///< name "pageSize", type Vector2
- CURRENT_PAGE_ID, ///< name "currentPageId", type Integer
+ PAGE_SIZE = PROPERTY_START_INDEX, ///< name "pageSize", type Vector2 @SINCE_1_1.4
+ CURRENT_PAGE_ID, ///< name "currentPageId", type Integer @SINCE_1_1.4
/**
* The two values are the major&minor radius (in pixels) to form an ellipse shape.
* The top-left quarter of this ellipse is used to calculate spine normal for simulating shadow.
*/
- SPINE_SHADOW, ///< name "spineShadow", type Vector2
+ SPINE_SHADOW, ///< name "spineShadow", type Vector2 @SINCE_1_1.4
};
};
/**
- * Creates an empty PageTurnView handle. Only derived versions can be instantiated.
+ * @brief Creates an empty PageTurnView handle. Only derived versions can be instantiated.
* Calling member function with an uninitialized handle is not allowed.
+ * @SINCE_1_1.4
*/
PageTurnView();
/**
- * Copy constructor. Creates another handle that points to the same real object
+ * @brief Copy constructor. Creates another handle that points to the same real object
+ * @SINCE_1_1.4
* @param[in] handle Handle to copy from
*/
PageTurnView( const PageTurnView& handle );
/**
- * Assignment operator. Changes this handle to point to another real object
+ * @brief Assignment operator. Changes this handle to point to another real object
+ * @SINCE_1_1.4
*/
PageTurnView& operator=( const PageTurnView& handle );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_1.4
*/
~PageTurnView();
/**
- * Downcast an Object handle to PageTurnView.
+ * @brief Downcast an Object handle to PageTurnView.
* If handle points to an PageTurnView the downcast produces valid handle.
* If not the returned handle is left uninitialized.
+ * @SINCE_1_1.4
* @param[in] handle Handle to an object
* @return handle to a PageTurnView or an uninitialized handle
*/
typedef Signal< void ( PageTurnView ) > PagePanSignal;
/**
- * Signal emitted when a page has started to turn over.
+ * @brief Signal emitted when a page has started to turn over.
* A callback of the following type may be connected:
* @code
* void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward );
* @endcode
+ * @SINCE_1_1.4
* @return The signal to connect to
*/
PageTurnSignal& PageTurnStartedSignal();
/**
- * Signal emitted when a page has finished turning over.
+ * @brief Signal emitted when a page has finished turning over.
* A callback of the following type may be connected:
* @code
* void YourCallBackName( PageTurnView pageTurnView, unsigned int pageIndex, bool isTurningForward );
* @endcode
+ * @SINCE_1_1.4
* @return The signal to connect to
*/
PageTurnSignal& PageTurnFinishedSignal();
/**
- * Signal emitted when a page pan has commenced
+ * @brief Signal emitted when a page pan has commenced
* A callback of the following type may be connected:
* @code
* void YourCallBackName( PageTurnView pageTurnView );
* @endcode
+ * @SINCE_1_1.4
* @return The signal to connect to
*/
PagePanSignal& PagePanStartedSignal();
/**
- * Signal emitted when a page pan has finished
+ * @brief Signal emitted when a page pan has finished
* A callback of the following type may be connected:
* @code
* void YourCallBackName( PageTurnView pageTurnView );
* @endcode
+ * @SINCE_1_1.4
* @return The signal to connect to
*/
PagePanSignal& PagePanFinishedSignal();
public: // Not intended for application developers
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_1.4
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL PageTurnView(Internal::PageTurnView& implementation);
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @SINCE_1_1.4
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL PageTurnView(Dali::Internal::CustomActor* internal);
*/
/**
- * ScrollBar is a UI component that can be linked to the scrollable objects
+ * @brief ScrollBar is a UI component that can be linked to the scrollable objects
* indicating the current scroll position of the scrollable object.
*
* Signals
* |-------------------------------|--------------------------------------------|
* | panFinished | @ref PanFinishedSignal() |
* | scrollPositionIntervalReached | @ref ScrollPositionIntervalReachedSignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ScrollBar : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the ScrollBar class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- SCROLL_DIRECTION = PROPERTY_START_INDEX, ///< name "scrollDirection", @see SetScrollDirection(), type std::string
- INDICATOR_HEIGHT_POLICY, ///< name "indicatorHeightPolicy", @see SetIndicatorHeightPolicy(), type std::string
- INDICATOR_FIXED_HEIGHT, ///< name "indicatorFixedHeight", @see SetIndicatorFixedHeight(), type float
- INDICATOR_SHOW_DURATION, ///< name "indicatorShowDuration", @see SetIndicatorShowDuration(), type float
- INDICATOR_HIDE_DURATION, ///< name "indicatorHideDuration", @see SetIndicatorHideDuration(), type float
- SCROLL_POSITION_INTERVALS ///< name "scrollPositionIntervals", @see SetScrollPositionIntervals() type Property::Array
+ SCROLL_DIRECTION = PROPERTY_START_INDEX, ///< name "scrollDirection", @see SetScrollDirection(), type std::string @SINCE_1_0.0
+ INDICATOR_HEIGHT_POLICY, ///< name "indicatorHeightPolicy", @see SetIndicatorHeightPolicy(), type std::string @SINCE_1_0.0
+ INDICATOR_FIXED_HEIGHT, ///< name "indicatorFixedHeight", @see SetIndicatorFixedHeight(), type float @SINCE_1_0.0
+ INDICATOR_SHOW_DURATION, ///< name "indicatorShowDuration", @see SetIndicatorShowDuration(), type float @SINCE_1_0.0
+ INDICATOR_HIDE_DURATION, ///< name "indicatorHideDuration", @see SetIndicatorHideDuration(), type float @SINCE_1_0.0
+ SCROLL_POSITION_INTERVALS ///< name "scrollPositionIntervals", @see SetScrollPositionIntervals() type Property::Array @SINCE_1_0.0
};
};
/**
* @brief Direction.
+ * @SINCE_1_0.0
*/
enum Direction
{
- Vertical = 0, ///< Scroll in the vertical direction
- Horizontal ///< Scroll in the horizontal direction
+ Vertical = 0, ///< Scroll in the vertical direction @SINCE_1_0.0
+ Horizontal ///< Scroll in the horizontal direction @SINCE_1_0.0
};
/**
* @brief Indicator height policy.
+ * @SINCE_1_0.0
*/
enum IndicatorHeightPolicy
{
- Variable = 0, ///< Variable height changed dynamically according to the length of scroll content
- Fixed ///< Fixed height regardless of the length of scroll content
+ Variable = 0, ///< Variable height changed dynamically according to the length of scroll content @SINCE_1_0.0
+ Fixed ///< Fixed height regardless of the length of scroll content @SINCE_1_0.0
};
/**
* @brief Create an uninitialized ScrollBar; this can be initialized with ScrollBar::New()
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
ScrollBar();
/**
* @brief Copy constructor.
+ * @SINCE_1_0.0
*/
ScrollBar( const ScrollBar& scrollBar );
/**
* @brief Assignment operator.
+ * @SINCE_1_0.0
*/
ScrollBar& operator=( const ScrollBar& scrollBar );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~ScrollBar();
/**
* @brief Create an initialized ScrollBar
+ * @SINCE_1_0.0
* @param[in] direction The direction of scroll bar (either vertically or horizontally).
* @return A pointer to the created ScrollBar.
*/
/**
* @brief Downcast an Object handle to ScrollBar. If handle points to a ScrollBar 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 ScrollBar or an uninitialized handle
*/
*
* * @pre The handle to the object owing the scroll properties has been initialised and the property index must be vaild.
*
+ * @SINCE_1_0.0
* @param[in] handle The handle of the object owing the scroll properties.
* @param[in] propertyScrollPosition The index of the scroll position property (The scroll position, type float).
* @param[in] propertyMinScrollPosition The index of the minimum scroll position property (The minimum scroll position, type float).
/**
* @brief Sets the indicator of scroll bar.
*
+ * @SINCE_1_0.0
+ * @param[in] indicator The indicator that moves to indicate the current scroll position.
* @pre The scroll bar actor has been initialised.
*
- * @param[in] indicator The indicator that moves to indicate the current scroll position.
*/
void SetScrollIndicator( Actor indicator );
/**
* @brief Gets the indicator of scroll bar.
*
+ * @SINCE_1_0.0
+ * @return The indicator indicates the current scroll position of the scrollable content.
* @pre The scroll bar actor has been initialised.
*
- * @return The indicator indicates the current scroll position of the scrollable content.
*/
Actor GetScrollIndicator();
* @brief Sets the list of values to get notification when the current scroll position of the scrollable
* object goes above or below any of these values.
*
+ * @SINCE_1_0.0
+ * @param[in] positions List of values to receive notifications for when the current scroll position crosses them
* @pre The scroll bar actor has been initialised.
*
- * @param[in] positions List of values to receive notifications for when the current scroll position crosses them
*/
void SetScrollPositionIntervals( const Dali::Vector<float>& positions );
* @brief Gets the list of values to receive notifications when the current scroll position of the scrollable
* object goes above or below any of these values.
*
+ * @SINCE_1_0.0
+ * @return The list of values to receive notifications for when the current scroll position crosses them
* @pre The scroll bar actor has been initialised.
*
- * @return The list of values to receive notifications for when the current scroll position crosses them
*/
Dali::Vector<float> GetScrollPositionIntervals() const;
/**
* @brief Sets the direction of scroll bar to scroll either vertically or horizontally.
*
+ * @SINCE_1_0.0
+ * @param[in] direction The direction of scroll bar (either vertically or horizontally).
* @pre The scroll bar actor has been initialised.
*
- * @param[in] direction The direction of scroll bar (either vertically or horizontally).
*/
void SetScrollDirection( Direction direction );
/**
* @brief Gets the direction of scroll bar.
*
+ * @SINCE_1_0.0
* @return The direction of scroll bar.
*/
Direction GetScrollDirection() const;
/**
* @brief Sets the height policy of scroll indicator to have either variable or fixed height.
*
+ * @SINCE_1_0.0
+ * @param[in] policy The height policy of scroll indicator
* @pre The scroll bar actor has been initialised.
*
- * @param[in] policy The height policy of scroll indicator
*/
void SetIndicatorHeightPolicy( IndicatorHeightPolicy policy );
/**
* @brief Gets the height policy of scroll indicator.
*
+ * @SINCE_1_0.0
* @return The height policy of scroll indicator
*/
IndicatorHeightPolicy GetIndicatorHeightPolicy() const;
* However, when the height policy of scroll indicator is set to be fixed, the height will keep fixed
* regardless of the length of scroll content.
*
+ * @SINCE_1_0.0
+ * @param[in] height The fixed height of the scroll indicator
* @pre The scroll bar actor has been initialised.
*
- * @param[in] height The fixed height of the scroll indicator
*/
void SetIndicatorFixedHeight( float height );
/**
* @brief Gets the fix height of scroll indicator.
+ * @SINCE_1_0.0
* @return The fixed height of the scroll indicator
*/
float GetIndicatorFixedHeight() const;
/**
* @brief Sets the duration in second for the scroll indicator to become fully visible
*
+ * @SINCE_1_0.0
+ * @param[in] durationSeconds The duration for the scroll indicator to become fully visible
* @pre The scroll bar actor has been initialised; durationSeconds must be zero or greater; zero means the indicator will be shown instantly.
*
- * @param[in] durationSeconds The duration for the scroll indicator to become fully visible
*/
void SetIndicatorShowDuration( float durationSeconds );
/**
* @brief Gets the duration in second for the scroll indicator to become fully visible
+ * @SINCE_1_0.0
* @return The duration for the scroll indicator to become fully visible
*/
float GetIndicatorShowDuration() const;
/**
* @brief Sets the duration in second for the scroll indicator to become fully invisible
*
+ * @SINCE_1_0.0
+ * @param[in] durationSeconds The duration for the scroll indicator to become fully invisible
* @pre The scroll bar actor has been initialised; durationSeconds must be zero or greater; zero means the indicator will be hidden instantly.
*
- * @param[in] durationSeconds The duration for the scroll indicator to become fully invisible
*/
void SetIndicatorHideDuration( float durationSeconds );
/**
* @brief Gets the duration in second for the scroll indicator to become fully invisible
+ * @SINCE_1_0.0
* @return The duration for the scroll indicator to become fully invisible
*/
float GetIndicatorHideDuration() const;
/**
* @brief Shows the scroll indicator
+ * @SINCE_1_0.0
*/
void ShowIndicator();
/**
* @brief Hides the scroll indicator
+ * @SINCE_1_0.0
*/
void HideIndicator();
* @code
* void YourCallbackName();
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
ScrollBar::PanFinishedSignalType& PanFinishedSignal();
* @code
* void YourCallbackName(float currentScrollPosition);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
ScrollBar::ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal();
public: // Not intended for application developers
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL ScrollBar( Internal::ScrollBar& implementation );
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal );
enum Type
{
- DEPTH, ///< Items arranged in a grid, scrolling along the Z-Axis.
- GRID, ///< Items arranged in a grid, scrolling along the Y-Axis.
- LIST, ///< One item per line, scrolling along the Y-Axis.
- SPIRAL ///< Items arranged in a spiral, centered around the Y-Axis.
+ DEPTH, ///< Items arranged in a grid, scrolling along the Z-Axis. @SINCE_1_0.0
+ GRID, ///< Items arranged in a grid, scrolling along the Y-Axis. @SINCE_1_0.0
+ LIST, ///< One item per line, scrolling along the Y-Axis. @SINCE_1_0.0
+ SPIRAL ///< Items arranged in a spiral, centered around the Y-Axis. @SINCE_1_0.0
};
/**
* @brief Creates a built-in default item-layout
*
+ * @SINCE_1_0.0
* @param[in] type The type of layout required.
*
* @return An ItemLayoutPtr to the newly created layout.
/**
* @brief ItemFactory is for providing actors to ItemView.
* Each actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfItems()-1.
+ * @SINCE_1_0.0
*/
class ItemFactory
{
/**
* @brief Virtual destructor.
+ * @SINCE_1_0.0
*/
DALI_EXPORT_API virtual ~ItemFactory() {};
* @brief Query the number of items available from the factory.
*
* The maximum available item has an ID of GetNumberOfItems() - 1.
+ * @SINCE_1_0.0
* @return the number of items
*/
virtual unsigned int GetNumberOfItems() = 0;
/**
* @brief Create an Actor to represent a visible item.
*
+ * @SINCE_1_0.0
* @param[in] itemId The ID of the newly visible item.
* @return An actor, or an uninitialized pointer if the ID is out of range.
*/
/**
* @brief Notify the factory the actor representing the item is removed from ItemView.
*
+ * @SINCE_1_0.0
* @param[in] itemId The ID of the released item.
* @param[in] actor The actor that represents the released item.
*/
virtual void ItemReleased(unsigned int itemId, Actor actor) {};
/**
- * Retrieve the extension for this control
+ * @brief Retrieve the extension for this control
*
+ * @SINCE_1_0.0
* @return The extension if available, NULL otherwise
*/
virtual Extension* GetExtension()
class ItemLayout;
-typedef IntrusivePtr<ItemLayout> ItemLayoutPtr; ///< Pointer to a Dali::Toolkit::ItemLayout object
+typedef IntrusivePtr<ItemLayout> ItemLayoutPtr; ///< Pointer to a Dali::Toolkit::ItemLayout object @SINCE_1_0.0
/**
* @brief A support class for managing ranges of items.
+ * @SINCE_1_0.0
*/
struct ItemRange
{
/**
* @brief Create a range of item identifiers.
*
+ * @SINCE_1_0.0
* @param[in] beginItem The first item within the range.
* @param[in] endItem The past-the-end item.
*/
/**
* @brief Copy Constructor.
*
+ * @SINCE_1_0.0
* @param[in] copy ItemRange we should copy from.
*/
ItemRange(const ItemRange& copy)
/**
* @brief Assignment operator.
*
+ * @SINCE_1_0.0
* @param[in] range The Range to assign from.
* @return The updated range.
*/
/**
* @brief Test whether an item is within the range.
*
+ * @SINCE_1_0.0
* @param[in] itemId The item identifier.
* @return True if the item is within the range.
*/
/**
* @brief Create the intersection of two ranges.
*
+ * @SINCE_1_0.0
* @param[in] second The second range.
* @return The intersection.
*/
*
* An ItemLayout also describes the direction of input gestures, used to scroll through the layout.
* Whilst scrolling, the layout provides a range of items that are within a layout-area (3D bounding volume).
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ItemLayout : public RefObject
{
/**
* @brief Virtual destructor.
+ * @SINCE_1_0.0
*/
DALI_IMPORT_API virtual ~ItemLayout();
/**
* @brief Set the orientation of the layout.
*
+ * @SINCE_1_0.0
* @param[in] orientation The orientation of the layout.
*/
DALI_IMPORT_API void SetOrientation(ControlOrientation::Type orientation);
/**
* @brief Query the orientation of the layout.
*
+ * @SINCE_1_0.0
* @return the orientation of the layout.
*/
DALI_IMPORT_API ControlOrientation::Type GetOrientation() const;
*
* This will return the default size for the layout unless overridden by calling SetItemSize().
*
- * @note layout-position is not provided as a parameter, since applying size constraints is not recommended.
- * Animating to target-sizes is preferable, since this allows controls to perform layouting without constraints.
+ * @SINCE_1_0.0
* @param[in] itemId The ID of an item in the layout.
* @param[in] layoutSize The layout size
* @param[out] itemSize The target size of an item.
+ * @note layout-position is not provided as a parameter, since applying size constraints is not recommended.
+ * Animating to target-sizes is preferable, since this allows controls to perform layouting without constraints.
*/
DALI_IMPORT_API void GetItemSize( unsigned int itemId, const Vector3& layoutSize, Vector3& itemSize ) const;
/**
* @brief Overrides the default size for the layout.
*
+ * @SINCE_1_0.0
* @param[in] itemSize The size of each item.
*/
DALI_IMPORT_API void SetItemSize( const Vector3& itemSize );
* @brief Query the minimum valid layout position; this is a negative value.
*
* When scrolling, the first item will move within the range 0 to GetMinimumLayoutPosition().
+ * @SINCE_1_0.0
* @param[in] numberOfItems The current number of items in the layout.
* @param[in] layoutSize The size of the layout area.
* @return The minimum layout position.
*
* This anchor position is the position where all the items in the layout are aligned to
* their rounded layout positions in integer.
+ * @SINCE_1_0.0
* @param[in] layoutPosition The layout position.
* @return The closest anchor position for the given layout position.
*/
* @brief Query the layout position for the first item in the layout to move to when the layout
* needs to scroll to a particular item.
*
+ * @SINCE_1_0.0
* @param[in] itemId The ID of an item in the layout.
* @return The layout position for the first item in the layout to move to.
*/
/**
* @brief Query the items within a given layout-area.
*
+ * @SINCE_1_0.0
* @param[in] firstItemPosition The layout-position of the first item in the layout.
* @param[in] layoutSize The size of the layout area.
* @return The ID of the first & last visible item.
* implementations should provide their own version of this function
* to ensure proper functionality of internal toolkit systems.
*
+ * @SINCE_1_0.0
* @param[in] itemID id of the item to bring within the viewable screen area
* @param[in] currentLayoutPosition the current layout position of the item view instance
* @param[in] layoutSize the current size of the item view instance
/**
* @brief Query the number of items that should be reserved, for scrolling purposes.
*
+ * @SINCE_1_0.0
* @param[in] layoutSize The size of the layout area.
* @return The number of extra items. ItemView will populate itself with actors within the layout-area
* (see GetItemsWithinArea), plus this number of additional items on either-side.
/**
* @brief Retrieve the default size of an item in the layout.
*
- * @note layout-position is not provided as a parameter, since applying size constraints is not recommended.
- * Animating to target-sizes is preferable, since this allows controls to perform layouting without constraints.
+ * @SINCE_1_0.0
* @param[in] itemId The ID of an item in the layout.
* @param[in] layoutSize The layout size
* @param[out] itemSize The target size of an item.
+ * @note layout-position is not provided as a parameter, since applying size constraints is not recommended.
+ * Animating to target-sizes is preferable, since this allows controls to perform layouting without constraints.
*/
virtual void GetDefaultItemSize( unsigned int itemId, const Vector3& layoutSize, Vector3& itemSize ) const = 0;
*
* When an input gesture follows this direction, the layout-position of items will be increased.
* If the input gesture points in the opposite direction, then the layout-positions will decrease.
+ * @SINCE_1_0.0
* @return The scroll direction in degrees.
*/
virtual Degree GetScrollDirection() const = 0;
* position of actors will be moved by 1.
* Therefore, the bigger the factor is, the faster the scroll speed will be.
*
+ * @SINCE_1_0.0
* @return The scroll speed factor of the layout.
*/
virtual float GetScrollSpeedFactor() const = 0;
* @brief Query the maximum swipe speed in pixels per second.
*
* Swipe gestures will be clamped when exceeding this speed limit.
+ * @SINCE_1_0.0
* @return speed The maximum swipe speed.
*/
virtual float GetMaximumSwipeSpeed() const = 0;
* This is the time taken to animate each
* item to its next layout position (e.g. from 1.0 to 2.0) when a flick animation is triggered
* by a swipe gesture.
+ * @SINCE_1_0.0
* @return The duration of the flick animation.
*/
virtual float GetItemFlickAnimationDuration() const = 0;
/**
* @brief Gets the id of the next item for KeyboardFocusManager to focus on depending on the inputted item ID.
*
+ * @SINCE_1_0.0
* @param[in] itemID The current focused item
* @param[in] maxItems The maximum number of items in the list
* @param[in] direction The directional key pressed on the keyboard
* position of actors will be moved by 1.
* Therefore, the bigger the factor is, the faster the flick speed will be.
*
+ * @SINCE_1_0.0
* @return The scroll speed factor of the layout.
*/
DALI_IMPORT_API virtual float GetFlickSpeedFactor() const;
/**
* @brief Gets the position of a given item
*
+ * @SINCE_1_0.0
* @param[in] itemID id of the item we want to get its position
* @param[in] currentLayoutPosition the current layout position of the item view instance
* @param[in] layoutSize the current size of the item view instance
DALI_IMPORT_API virtual Vector3 GetItemPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize) const = 0;
/**
- * Retrieve the extension for this layout.
+ * @brief Retrieve the extension for this layout.
*
+ * @SINCE_1_0.0
* @return The extension if available, NULL otherwise
*/
virtual Extension* GetExtension()
/**
* @brief Create a new ItemLayout; Only derived versions are instantiatable.
+ * @SINCE_1_0.0
*/
DALI_IMPORT_API ItemLayout();
private:
/**
- * Don't allow copy constructor
+ * @brief Don't allow copy constructor
+ * @SINCE_1_0.0
*/
ItemLayout( const ItemLayout& handle );
/**
- * Don't allow copy operator
+ * @brief Don't allow copy operator
+ * @SINCE_1_0.0
*/
ItemLayout& operator=( const ItemLayout& handle );
* @{
*/
-typedef unsigned int ItemId; ///< Unique identity for each item in the view.
+typedef unsigned int ItemId; ///< Unique identity for each item in the view. @SINCE_1_0.0
typedef std::vector<ItemId> ItemIdContainer;
typedef ItemIdContainer::iterator ItemIdIter;
* | %Signal Name | Method |
* |---------------------------------|--------------------------------------------|
* | layoutActivated | @ref LayoutActivatedSignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ItemView : public Scrollable
enum PropertyRange
{
- PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @since DALi 1.1.18
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @since DALi 1.1.18
+ PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @SINCE_1_1.18
ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1,
- ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the ScrollView class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
// Event side properties
- MINIMUM_SWIPE_SPEED = PROPERTY_START_INDEX, ///< Property, name "minimumSwipeSpeed", @see SetMinimumSwipeSpeed(), type float, @since DALi 1.1.18
- MINIMUM_SWIPE_DISTANCE, ///< Property, name "minimumSwipeDistance", @see SetMinimumSwipeDistance(), type float, @since DALi 1.1.18
- WHEEL_SCROLL_DISTANCE_STEP, ///< Property, name "wheelScrollDistanceStep", @see SetWheelScrollDistanceStep(), type float, @since DALi 1.1.18
- SNAP_TO_ITEM_ENABLED, ///< Property, name "snapToItemEnabled", @see SetAnchoring(), type bool, @since DALi 1.1.18
- REFRESH_INTERVAL, ///< Property, name "refreshInterval", @see SetRefreshInterval(), type float, @since DALi 1.1.18
+ MINIMUM_SWIPE_SPEED = PROPERTY_START_INDEX, ///< Property, name "minimumSwipeSpeed", @see SetMinimumSwipeSpeed(), type float, @SINCE_1_1.18
+ MINIMUM_SWIPE_DISTANCE, ///< Property, name "minimumSwipeDistance", @see SetMinimumSwipeDistance(), type float, @SINCE_1_1.18
+ WHEEL_SCROLL_DISTANCE_STEP, ///< Property, name "wheelScrollDistanceStep", @see SetWheelScrollDistanceStep(), type float, @SINCE_1_1.18
+ SNAP_TO_ITEM_ENABLED, ///< Property, name "snapToItemEnabled", @see SetAnchoring(), type bool, @SINCE_1_1.18
+ REFRESH_INTERVAL, ///< Property, name "refreshInterval", @see SetRefreshInterval(), type float, @SINCE_1_1.18
// Animatable properties
- LAYOUT_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "layoutPosition", type float
- SCROLL_SPEED, ///< Property, name "scrollSpeed", type float
- OVERSHOOT, ///< Property, name "overshoot", type float
- SCROLL_DIRECTION, ///< Property, name "scrollDirection", type Vector2
- LAYOUT_ORIENTATION, ///< Property, name "layoutOrientation", type integer
- SCROLL_CONTENT_SIZE ///< Property, name "scrollContentSize", type float
+ LAYOUT_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "layoutPosition", type float @SINCE_1_0.0
+ SCROLL_SPEED, ///< Property, name "scrollSpeed", type float @SINCE_1_0.0
+ OVERSHOOT, ///< Property, name "overshoot", type float @SINCE_1_0.0
+ SCROLL_DIRECTION, ///< Property, name "scrollDirection", type Vector2 @SINCE_1_0.0
+ LAYOUT_ORIENTATION, ///< Property, name "layoutOrientation", type integer @SINCE_1_0.0
+ SCROLL_CONTENT_SIZE ///< Property, name "scrollContentSize", type float @SINCE_1_0.0
};
};
* @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
*
* Calling member functions with an uninitialized Dali::Object is not allowed.
+ * @SINCE_1_0.0
*/
ItemView();
/**
* @brief Copy constructor.
+ * @SINCE_1_0.0
*/
ItemView( const ItemView& itemView );
/**
* @brief Assignment operator.
+ * @SINCE_1_0.0
*/
ItemView& operator=( const ItemView& itemView );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~ItemView();
/**
* @brief Create an initialized ItemView.
*
+ * @SINCE_1_0.0
* @param[in] factory The factory which provides ItemView with items.
* @return A handle to a newly allocated Dali resource.
*/
* If handle points to a ItemView 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 ItemView or an uninitialized handle
*/
/**
* @brief Query the number of layouts.
*
+ * @SINCE_1_0.0
* @return The number of layouts.
*/
unsigned int GetLayoutCount() const;
/**
* @brief Add a layout.
*
+ * @SINCE_1_0.0
* @param[in] layout The layout.
*/
void AddLayout(ItemLayout& layout);
/**
* @brief Remove a layout.
*
- * @pre layoutIndex is less than GetLayoutCount().
+ * @SINCE_1_0.0
* @param[in] layoutIndex The index of one of the ItemView layouts.
+ * @pre layoutIndex is less than GetLayoutCount().
*/
void RemoveLayout(unsigned int layoutIndex);
/**
* @brief Retrieve a layout.
*
- * @pre layoutIndex is less than GetLayoutCount().
+ * @SINCE_1_0.0
* @param[in] layoutIndex The index of the layout to retrieve.
* @return The layout
+ * @pre layoutIndex is less than GetLayoutCount().
*/
ItemLayoutPtr GetLayout(unsigned int layoutIndex) const;
/**
* @brief Retrieve the currently active layout, if any.
*
+ * @SINCE_1_0.0
* @return The layout, or an uninitialized pointer if no layout is active.
*/
ItemLayoutPtr GetActiveLayout() const;
/**
* @brief Retrieve the current layout-position of an item in the ItemView.
*
+ * @SINCE_1_0.0
* @param[in] itemId The item identifier.
* @return The current layout-position.
*/
* This is done by applying constraints from the new layout, and
* removing constraints from the previous layout.
*
- * @pre layoutIndex is less than GetLayoutCount().
- * @pre durationSeconds is greater or equal to zero.
+ * @SINCE_1_0.0
* @param[in] layoutIndex The index of one of the ItemView layouts.
* @param[in] targetSize The target ItemView & layout size.
* @param[in] durationSeconds The time taken to relayout in seconds (zero for immediate).
+ * @pre layoutIndex is less than GetLayoutCount().
+ * @pre durationSeconds is greater or equal to zero.
*/
void ActivateLayout(unsigned int layoutIndex, Vector3 targetSize, float durationSeconds);
* @brief Deactivate the current layout, if any.
*
* The constraints applied by the layout will be removed.
+ * @SINCE_1_0.0
*/
void DeactivateCurrentLayout();
* @brief Set the minimum swipe speed in pixels per second; A pan
* gesture must exceed this to trigger a swipe.
*
+ * @SINCE_1_0.0
* @param[in] speed The minimum swipe speed
*/
void SetMinimumSwipeSpeed(float speed);
/**
* @brief Get the minimum swipe speed in pixels per second.
*
+ * @SINCE_1_0.0
* @return The minimum swipe speed
*/
float GetMinimumSwipeSpeed() const;
* @brief Set the minimum swipe distance in actor coordinates; A pan
* gesture must exceed this to trigger a swipe.
*
+ * @SINCE_1_0.0
* @param[in] distance The minimum swipe distance.
*/
void SetMinimumSwipeDistance(float distance);
/**
* @brief Get the minimum swipe distance in actor coordinates.
*
+ * @SINCE_1_0.0
* @return The minimum swipe distance
*/
float GetMinimumSwipeDistance() const;
/**
* @brief Set the step of scroll distance in actor coordinates for each wheel event received.
*
+ * @SINCE_1_0.0
* @param[in] step The step of scroll distance(pixel).
*/
void SetWheelScrollDistanceStep(float step);
/**
* @brief Get the step of scroll distance in actor coordinates for each wheel event received.
*
+ * @SINCE_1_0.0
* @return The step of scroll distance(pixel)
*/
float GetWheelScrollDistanceStep() const;
* The anchor position is the position where all the items in the layout
* are aligned to their closest rounded layout positions in integer.
*
+ * @SINCE_1_0.0
* @param[in] enabled Whether the anchor animation is enabled or not.
*/
void SetAnchoring(bool enabled);
/**
* @brief Get whether the anchor animation is enabled or not.
*
+ * @SINCE_1_0.0
* @return Whether the anchor animation is enabled or not.
*/
bool GetAnchoring() const;
* This is the time taken to reach the nearest anchor position after
* a drag or swipe gesture ends.
*
- * @pre durationSeconds must be greater than zero.
+ * @SINCE_1_0.0
* @param[in] durationSeconds The duration of the anchor animation in seconds.
+ * @pre durationSeconds must be greater than zero.
*/
void SetAnchoringDuration(float durationSeconds);
/**
* @brief Get the duration of the anchor animation in seconds.
*
+ * @SINCE_1_0.0
* @return The duration of the anchor animation
*/
float GetAnchoringDuration() const;
/**
* @brief Scroll the current layout to a particular item.
*
+ * @SINCE_1_0.0
+ * @param[in] itemId The ID of an item in the layout.
+ * @param[in] durationSeconds How long the scrolling takes in seconds.
* @pre durationSeconds must be zero or greater; zero means the layout should scroll to the particular item instantly.
* If calling this with zero second of duration immediately after calling ActivateLayout, it might not work unless
* the duration of relayout animation for ActivateLayout is also set to be zero.
- * @param[in] itemId The ID of an item in the layout.
- * @param[in] durationSeconds How long the scrolling takes in seconds.
*/
void ScrollToItem(ItemId itemId, float durationSeconds);
* @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
* new items are requested from ItemFactory.
*
+ * @SINCE_1_0.0
* @param[in] intervalLayoutPositions The refresh interval in layout position.
*/
void SetRefreshInterval(float intervalLayoutPositions);
/**
* @brief Get the interval between refreshes in layout position.
*
+ * @SINCE_1_0.0
* @return The refresh interval
*/
float GetRefreshInterval() const;
/**
* @brief Do a refresh of the item view.
+ * @SINCE_1_0.0
*/
void Refresh();
/**
* @brief Given the Item ID, this returns the accompanying actor.
*
+ * @SINCE_1_0.0
* @param[in] itemId The Item ID of the actor required.
* @return The Actor corresponding to the Item ID.
*/
/**
* @brief Returns the Item ID of the specified actor.
*
+ * @SINCE_1_0.0
* @param[in] actor The actor whose Item ID is required.
* @return The Item ID of the item.
* @pre The actor should be an item of ItemView.
* ID 2 - ActorB ID 2 - ActorZ !
* ID 3 - ActorC ID 3 - ActorB
* ID 4 - ActorC
- * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
+ * @SINCE_1_0.0
* @param[in] newItem The item to insert.
* @param[in] durationSeconds How long the relayout takes in seconds.
+ * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
*/
void InsertItem(Item newItem, float durationSeconds);
/**
* @brief Insert a set of items; this is more efficient than calling InsertItem() repeatedly.
*
- * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
+ * @SINCE_1_0.0
* @param[in] newItems The items to insert.
* @param[in] durationSeconds How long the relayout takes in seconds.
+ * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
*/
void InsertItems(const ItemContainer& newItems, float durationSeconds);
* ID 2 - ActorB ID 2 - ActorC (previously ID 3)
* ID 3 - ActorC ID 3 - ActorB (previously ID 4)
* ID 4 - ActorD
- * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
+ * @SINCE_1_0.0
* @param[in] itemId The Item ID of the item to remove.
* @param[in] durationSeconds How long the relayout takes in seconds.
+ * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
*/
void RemoveItem(ItemId itemId, float durationSeconds);
/**
* @brief Remove a set of items; this is more efficient than calling RemoveItem() repeatedly.
*
- * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
+ * @SINCE_1_0.0
* @param[in] itemIds The IDs of the items to remove.
* @param[in] durationSeconds How long the relayout takes in seconds.
+ * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
*/
void RemoveItems(const ItemIdContainer& itemIds, float durationSeconds);
* @brief Replace an item.
*
* A relayout will occur for the replacement item only.
- * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
+ * @SINCE_1_0.0
* @param[in] replacementItem The replacement for an existing item.
* @param[in] durationSeconds How long the relayout takes in seconds.
+ * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
*/
void ReplaceItem(Item replacementItem, float durationSeconds);
* @brief Replace a set of items.
*
* A relayout will occur for the replacement items only.
- * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
+ * @SINCE_1_0.0
* @param[in] replacementItems The replacements for a set of existing items.
* @param[in] durationSeconds How long the relayout takes in seconds.
+ * @pre durationSeconds must be zero or greater; zero means the relayout occurs instantly.
*/
void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
* @brief Set the parent origin of the items
*
* A relayout will occur for all the items if the parent origin is different than the current one.
+ * @SINCE_1_0.0
* @param[in] parentOrigin New parent origin position vector
*/
void SetItemsParentOrigin( const Vector3& parentOrigin );
/**
* @brief Get the parent origin of the items
*
+ * @SINCE_1_0.0
* @return The current parent origin of the items
*/
Vector3 GetItemsParentOrigin() const;
* @brief Set the anchor point of the items
*
* A relayout will occur for all the items if the anchor point is different than the current one.
+ * @SINCE_1_0.0
* @param[in] anchorPoint New anchor point position vector
*/
void SetItemsAnchorPoint( const Vector3& anchorPoint );
/**
* @brief Get the anchor point of the items
*
+ * @SINCE_1_0.0
* @return The current anchor point of the items
*/
Vector3 GetItemsAnchorPoint() const;
/**
* @brief Get the range of items that are currently in ItemView.
*
+ * @SINCE_1_0.0
* @param[out] range The range of items.
*/
void GetItemsRange(ItemRange& range);
* @code
* void YourCallbackName();
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
ItemView::LayoutActivatedSignalType& LayoutActivatedSignal();
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL ItemView(Internal::ItemView& implementation);
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL ItemView( Dali::Internal::CustomActor* internal );
*/
/**
- * Move Actor constraint.
+ * @brief Move Actor constraint.
*
* Moves an Actor in accordance to scroll position.
+ * @SINCE_1_0.0
*/
DALI_IMPORT_API void MoveActorConstraint( Vector3& current, const PropertyInputContainer& inputs );
/**
- * Wrap Actor constraint.
+ * @brief Wrap Actor constraint.
*
* Wraps an Actors position in accordance to min/max bounds of domain.
+ * @SINCE_1_0.0
*/
DALI_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs );
* properties that can be used with visual effects. Such as creating
* constraints that are applied to ShaderEffects or Actors using these
* properties as inputs.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ScrollViewEffect : public Dali::BaseHandle
{
* @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
*
* Calling member functions with an uninitialized Toolkit::BaseObject is not allowed.
+ * @SINCE_1_0.0
*/
ScrollViewEffect();
/**
* @brief This constructor is used by Dali New() methods.
*
+ * @SINCE_1_0.0
* @param [in] impl A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect *impl);
*/
/**
- * ScrollView Page Path Effect.
+ * @brief ScrollView Page Path Effect.
* This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at
* the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
* to 0.0 at the end of the path
*
* Automatic operation:
* not implemented.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ScrollViewPagePathEffect : public ScrollViewEffect
{
public:
/**
- * Create an initialized ScrollViewPagePathEffect.
+ * @brief Create an initialized ScrollViewPagePathEffect.
+ * @SINCE_1_0.0
* @param[in] path The path that will be used by the scroll effect
* @param[in] forward Vector in page object space which will be aligned with the tangent of the path
* @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path.
static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& pageSize, unsigned int pageCount);
/**
- * Create an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New()
+ * @brief Create an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New()
* Calling member functions with an uninitialized Toolkit::ScrollViewPagePathEffect is not allowed.
+ * @SINCE_1_0.0
*/
ScrollViewPagePathEffect();
/**
- * Downcast an Object handle to ScrollViewPagePathEffect. If handle points to a ScrollViewPagePathEffect the
+ * @brief Downcast an Object handle to ScrollViewPagePathEffect. If handle points to a ScrollViewPagePathEffect 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 ScrollViewPagePathEffect or an uninitialized handle
*/
static ScrollViewPagePathEffect DownCast( BaseHandle handle );
/**
- * Manually apply effect to a page in the scroll-view.
+ * @brief Manually apply effect to a page in the scroll-view.
+ * @SINCE_1_0.0
* @param[in] page The page to be affected by this effect.
* @param[in] pageOrder The order of the page in the scroll-view
*/
protected:
/**
- * This constructor is used by Dali New() methods.
+ * @brief This constructor is used by Dali New() methods.
+ * @SINCE_1_0.0
* @param [in] impl A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl );
/**
* @brief How axes/rotation or scale are clamped
+ * @SINCE_1_0.0
*/
enum ClampState
{
- NotClamped, ///< The quantity isn't clamped
- ClampedToMin, ///< The quantity is clamped to the min value
- ClampedToMax ///< The quantity is clamped to the max value
+ NotClamped, ///< The quantity isn't clamped @SINCE_1_0.0
+ ClampedToMin, ///< The quantity is clamped to the min value @SINCE_1_0.0
+ ClampedToMax ///< The quantity is clamped to the max value @SINCE_1_0.0
};
/**
* @brief A 2 dimensional clamp
+ * @SINCE_1_0.0
*/
struct ClampState2D
{
/**
* @brief The snap type
+ * @SINCE_1_0.0
*/
enum SnapType
{
- Snap, ///< Snap
- Flick ///< Flick
+ Snap, ///< Snap @SINCE_1_0.0
+ Flick ///< Flick @SINCE_1_0.0
};
/**
* @brief DirectionBias types.
+ * @SINCE_1_0.0
*/
enum DirectionBias
{
- DirectionBiasLeft = -1, ///< Bias scroll snap to Left
- DirectionBiasNone = 0, ///< Don't bias scroll snap
- DirectionBiasRight = 1 ///< Bias scroll snap to Right
+ DirectionBiasLeft = -1, ///< Bias scroll snap to Left @SINCE_1_0.0
+ DirectionBiasNone = 0, ///< Don't bias scroll snap @SINCE_1_0.0
+ DirectionBiasRight = 1 ///< Bias scroll snap to Right @SINCE_1_0.0
};
/**
* @brief Used for specifying minimum/maximum extents of a ruler.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API RulerDomain
{
/**
* @brief Creates Ruler domain allowing a point to traverse between min and max extents.
*
+ * @SINCE_1_0.0
* @param[in] min Minimum extent (point cannot traverse less than this)
* @param[in] max Maximum extent (point cannot traverse greater than this)
* @param[in] enabled Whether domain has been enabled or not.
* An optional length parameter can be specified to suggest that the
* subject is not a point but a line to that should be clamped.
*
+ * @SINCE_1_0.0
* @param[in] x X point to be clamped between (min) and (max) extents.
* @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
* @param[in] scale Scaling parameter which treats domain as scaled in calculations.
* An optional length parameter can be specified to suggest that the
* subject is not a point but a line to that should be clamped.
*
+ * @SINCE_1_0.0
* @param[in] x X point to be clamped between (min) and (max) extents.
* @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
* @param[in] scale Scaling parameter which treats domain as scaled in calculations.
/**
* @brief Returns (max-min) size of ruler.
*
+ * @SINCE_1_0.0
* @return The size of the ruler from min to max.
*/
float GetSize() const;
*
* It can specify whether they are traversable, where their snap
* points are and their domain.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Ruler : public RefObject
{
public:
/// @brief The type of the ruler
enum RulerType {
- Fixed, ///< A fixed ruler
- Free ///< A free ruler
+ Fixed, ///< A fixed ruler @SINCE_1_0.0
+ Free ///< A free ruler @SINCE_1_0.0
};
public:
/**
* @brief Constructs ruler, default enabled, with limitless domain.
+ * @SINCE_1_0.0
*/
Ruler();
/**
* @brief Snaps (x) in accordance to the ruler settings.
*
+ * @SINCE_1_0.0
* @param[in] x The input value on the ruler to be snapped.
* @param[in] bias (optional) The biasing employed for snapping
* 0 floor input (floor x) "Used for Flick Left"
* number of pages within the domain), while wrapping the position
* within the domain.
*
+ * @SINCE_1_0.0
* @param[in] page The page index
* @param[out] volume The overflow volume when the page exceeds the domain (wrap must be enabled)
* @param[in] wrap Enable wrap mode
*
* If (wrap) is true, then will return a page wrapped within the domain.
*
+ * @SINCE_1_0.0
* @param[in] position The position on the domain
* @param[in] wrap Enable wrap mode
* @return The page where this position resides.
/**
* @brief Returns the total number of pages within this Ruler.
*
+ * @SINCE_1_0.0
* @return The number of pages in the Ruler.
*/
virtual unsigned int GetTotalPages() const = 0;
/**
* @brief Gets the extension interface of the Ruler.
*
+ * @SINCE_1_0.0
* @return The extension interface of the Ruler
*/
virtual RulerExtension* GetExtension() { return NULL; }
/**
* @brief Gets the ruler type.
*
+ * @SINCE_1_0.0
* @return The ruler type.
*/
Ruler::RulerType GetType() const;
/**
* @brief Returns whether this axis has been enabled or not.
*
+ * @SINCE_1_0.0
* @return true if axis is enabled
*/
bool IsEnabled() const;
/**
* @brief Enables ruler (ruler must be enabled in order to traverse along it).
+ * @SINCE_1_0.0
*/
void Enable();
/**
* @brief Disables ruler.
+ * @SINCE_1_0.0
*/
void Disable();
/**
* @brief Sets Domain.
*
+ * @SINCE_1_0.0
* @param[in] domain Ruler domain object.
*/
void SetDomain(RulerDomain domain);
/**
* @brief Gets Domain.
*
+ * @SINCE_1_0.0
* @return The domain
*/
const RulerDomain &GetDomain() const;
/**
* @brief Disables Domain (minimum/maximum extents for this axis).
+ * @SINCE_1_0.0
*/
void DisableDomain();
* An optional length parameter can be specified to suggest that the
* subject is not a point but a line that should be clamped.
*
+ * @SINCE_1_0.0
* @param[in] x X point to be clamped between (min) and (max) extents.
* @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
* @param[in] scale Scaling parameter which treats domain as scaled in calculations.
* An optional length parameter can be specified to suggest that the
* subject is not a point but a line to that should be clamped.
*
+ * @SINCE_1_0.0
* @param[in] x X point to be clamped between (min) and (max) extents.
* @param[in] length (optional) The Length of the line from (x) to (x + length) to be clamped.
* @param[in] scale Scaling parameter which treats domain as scaled in calculations.
/**
* @brief Snaps and Clamps (x) in accordance to ruler settings.
*
+ * @SINCE_1_0.0
* @param[in] x value to be snapped in accordance to ruler snap value,
* and clamped in accordance to the ruler's domain (if set).
* @param[in] bias (optional) The biasing employed for snapping
/**
* @brief Snaps and Clamps (x) in accordance to ruler settings.
*
+ * @SINCE_1_0.0
* @param[in] x value to be snapped in accordance to ruler snap value,
* and clamped in accordance to the ruler's domain (if set).
* @param[in] bias (optional) The biasing employed for snapping
/**
* @brief Destructor - A reference counted object may only be deleted by calling Unreference().
+ * @SINCE_1_0.0
*/
virtual ~Ruler();
};
-typedef IntrusivePtr<Ruler> RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object
+typedef IntrusivePtr<Ruler> RulerPtr; ///< Pointer to Dali::Toolkit::Ruler object @SINCE_1_0.0
/**
* @brief Concrete implementation of Ruler that has no snapping and has one single page.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API DefaultRuler : public Ruler
{
public:
/**
* @brief DefaultRuler constructor.
+ * @SINCE_1_0.0
*/
DefaultRuler();
/**
* @brief Concrete implementation of Ruler that has fixed snapping.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API FixedRuler : public Ruler
{
/**
* @brief Constructor
*
+ * @SINCE_1_0.0
* @param[in] spacing The spacing between each interval on this ruler.
*/
FixedRuler(float spacing = 1.0f);
* | %Signal Name | Method |
* |-------------------|----------------------------|
* | snap-started | @ref SnapStartedSignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API ScrollView : public Scrollable
{
/**
* @brief Clamp signal event's data
+ * @SINCE_1_0.0
*/
struct ClampEvent
{
/**
* @brief Snap signal event's data.
+ * @SINCE_1_0.0
*/
struct SnapEvent
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @since DALi 1.1.18
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @since DALi 1.1.18
+ PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices, @SINCE_1_1.18
ANIMATABLE_PROPERTY_START_INDEX = Toolkit::Scrollable::ANIMATABLE_PROPERTY_END_INDEX + 1,
- ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the ScrollView class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
// Event side properties
- WRAP_ENABLED = PROPERTY_START_INDEX, ///< Property, name "wrapEnabled", @see SetWrapMode(), type bool, @since DALi 1.1.18
- PANNING_ENABLED, ///< Property, name "panningEnabled", @see SetScrollSensitive(), type bool, @since DALi 1.1.18
- AXIS_AUTO_LOCK_ENABLED, ///< Property, name "axisAutoLockEnabled", @see SetAxisAutoLock(), type bool, @since DALi 1.1.18
- WHEEL_SCROLL_DISTANCE_STEP, ///< Property, name "wheelScrollDistanceStep", @see SetWheelScrollDistanceStep(), type Vector2, @since DALi 1.1.18
-
- SCROLL_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollPosition", type Vector2
- SCROLL_PRE_POSITION, ///< Property, name "scrollPrePosition", type Vector2
- SCROLL_PRE_POSITION_X, ///< Property, name "scrollPrePositionX", type float
- SCROLL_PRE_POSITION_Y, ///< Property, name "scrollPrePositionY", type float
- SCROLL_PRE_POSITION_MAX, ///< Property, name "scrollPrePositionMax", type Vector2
- SCROLL_PRE_POSITION_MAX_X, ///< Property, name "scrollPrePositionMaxX", type float
- SCROLL_PRE_POSITION_MAX_Y, ///< Property, name "scrollPrePositionMaxY", type float
- OVERSHOOT_X, ///< Property, name "overshootX", type float
- OVERSHOOT_Y, ///< Property, name "overshootY", type float
- SCROLL_FINAL, ///< Property, name "scrollFinal", type Vector2
- SCROLL_FINAL_X, ///< Property, name "scrollFinalX", type float
- SCROLL_FINAL_Y, ///< Property, name "scrollFinalY", type float
- WRAP, ///< Property, name "wrap", type bool
- PANNING, ///< Property, name "panning", type bool
- SCROLLING, ///< Property, name "scrolling", type bool
- SCROLL_DOMAIN_SIZE, ///< Property, name "scrollDomainSize", type Vector2
- SCROLL_DOMAIN_SIZE_X, ///< Property, name "scrollDomainSizeX", type float
- SCROLL_DOMAIN_SIZE_Y, ///< Property, name "scrollDomainSizeY", type float
- SCROLL_DOMAIN_OFFSET, ///< Property, name "scrollDomainOffset", type Vector2
- SCROLL_POSITION_DELTA, ///< Property, name "scrollPositionDelta", type Vector2
- START_PAGE_POSITION ///< Property, name "startPagePosition", type Vector3
+ WRAP_ENABLED = PROPERTY_START_INDEX, ///< Property, name "wrapEnabled", @see SetWrapMode(), type bool, @SINCE_1_1.18
+ PANNING_ENABLED, ///< Property, name "panningEnabled", @see SetScrollSensitive(), type bool, @SINCE_1_1.18
+ AXIS_AUTO_LOCK_ENABLED, ///< Property, name "axisAutoLockEnabled", @see SetAxisAutoLock(), type bool, @SINCE_1_1.18
+ WHEEL_SCROLL_DISTANCE_STEP, ///< Property, name "wheelScrollDistanceStep", @see SetWheelScrollDistanceStep(), type Vector2, @SINCE_1_1.18
+
+ SCROLL_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollPosition", type Vector2 @SINCE_1_0.0
+ SCROLL_PRE_POSITION, ///< Property, name "scrollPrePosition", type Vector2 @SINCE_1_0.0
+ SCROLL_PRE_POSITION_X, ///< Property, name "scrollPrePositionX", type float @SINCE_1_0.0
+ SCROLL_PRE_POSITION_Y, ///< Property, name "scrollPrePositionY", type float @SINCE_1_0.0
+ SCROLL_PRE_POSITION_MAX, ///< Property, name "scrollPrePositionMax", type Vector2 @SINCE_1_0.0
+ SCROLL_PRE_POSITION_MAX_X, ///< Property, name "scrollPrePositionMaxX", type float @SINCE_1_0.0
+ SCROLL_PRE_POSITION_MAX_Y, ///< Property, name "scrollPrePositionMaxY", type float @SINCE_1_0.0
+ OVERSHOOT_X, ///< Property, name "overshootX", type float @SINCE_1_0.0
+ OVERSHOOT_Y, ///< Property, name "overshootY", type float @SINCE_1_0.0
+ SCROLL_FINAL, ///< Property, name "scrollFinal", type Vector2 @SINCE_1_0.0
+ SCROLL_FINAL_X, ///< Property, name "scrollFinalX", type float @SINCE_1_0.0
+ SCROLL_FINAL_Y, ///< Property, name "scrollFinalY", type float @SINCE_1_0.0
+ WRAP, ///< Property, name "wrap", type bool @SINCE_1_0.0
+ PANNING, ///< Property, name "panning", type bool @SINCE_1_0.0
+ SCROLLING, ///< Property, name "scrolling", type bool @SINCE_1_0.0
+ SCROLL_DOMAIN_SIZE, ///< Property, name "scrollDomainSize", type Vector2 @SINCE_1_0.0
+ SCROLL_DOMAIN_SIZE_X, ///< Property, name "scrollDomainSizeX", type float @SINCE_1_0.0
+ SCROLL_DOMAIN_SIZE_Y, ///< Property, name "scrollDomainSizeY", type float @SINCE_1_0.0
+ SCROLL_DOMAIN_OFFSET, ///< Property, name "scrollDomainOffset", type Vector2 @SINCE_1_0.0
+ SCROLL_POSITION_DELTA, ///< Property, name "scrollPositionDelta", type Vector2 @SINCE_1_0.0
+ START_PAGE_POSITION ///< Property, name "startPagePosition", type Vector3 @SINCE_1_0.0
};
};
// Typedefs
- typedef Signal< void ( const SnapEvent& ) > SnapStartedSignalType; ///< SnapStarted signal type
+ typedef Signal< void ( const SnapEvent& ) > SnapStartedSignalType; ///< SnapStarted signal type @SINCE_1_0.0
public:
/**
* @brief Creates an empty ScrollView handle.
+ * @SINCE_1_0.0
*/
ScrollView();
*
* Creates another handle that points to the same real object
*
+ * @SINCE_1_0.0
* @param[in] handle to copy from
*/
ScrollView( const ScrollView& handle );
* @brief Assignment operator.
*
* Changes this handle to point to another real object
+ * @SINCE_1_0.0
* @param[in] handle The handle to copy from
* @return A reference to this
*/
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~ScrollView();
/**
* @brief Create an initialized ScrollView.
*
+ * @SINCE_1_0.0
* @return A handle to a newly allocated Dali resource.
*/
static ScrollView New();
* If handle points to a ScrollView 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 ScrollView or an uninitialized handle
*/
/**
* @brief Get snap-animation's AlphaFunction.
*
+ * @SINCE_1_0.0
* @return Current easing alpha function of the snap animation.
*/
AlphaFunction GetScrollSnapAlphaFunction() const;
/**
* @brief Set snap-animation's AlphaFunction.
*
+ * @SINCE_1_0.0
* @param[in] alpha Easing alpha function of the snap animation.
*/
void SetScrollSnapAlphaFunction(AlphaFunction alpha);
/**
* @brief Get flick-animation's AlphaFunction.
*
+ * @SINCE_1_0.0
* @return Current easing alpha function of the flick animation.
*/
AlphaFunction GetScrollFlickAlphaFunction() const;
/**
* @brief Set flick-animation's AlphaFunction.
*
+ * @SINCE_1_0.0
* @param[in] alpha Easing alpha function of the flick animation.
*/
void SetScrollFlickAlphaFunction(AlphaFunction alpha);
*
* This animation occurs when the user drags, and releases.
*
+ * @SINCE_1_0.0
* @return The time in seconds for the animation to take.
*/
float GetScrollSnapDuration() const;
*
* This animation occurs when the user drags, and releases.
*
+ * @SINCE_1_0.0
* @param[in] time The time in seconds for the animation to take.
*/
void SetScrollSnapDuration(float time);
*
* This animation occurs when the user flicks scroll view.
*
+ * @SINCE_1_0.0
* @return The time in seconds for the animation to take.
*/
float GetScrollFlickDuration() const;
*
* This animation occurs when the user flicks scroll view.
*
+ * @SINCE_1_0.0
* @param[in] time The time in seconds for the animation to take.
*/
void SetScrollFlickDuration(float time);
* Defines how scrolling horizontally is snapped, and
* the boundary (domain) in which the ScrollView can pan.
*
+ * @SINCE_1_0.0
* @param[in] ruler The ruler to be used for the X axis
*/
void SetRulerX(RulerPtr ruler);
* Defines how scrolling vertically is snapped, and the boundary
* (domain) in which the ScrollView can pan.
*
+ * @SINCE_1_0.0
* @param[in] ruler The ruler to be used for the Y axis
*/
void SetRulerY(RulerPtr ruler);
/**
* @brief Set Scroll's touch sensitivity.
*
+ * @SINCE_1_0.0
+ * @param[in] sensitive true to enable scroll, false to disable scrolling
* @note Unlike SetSensitive(), this determines whether this ScrollView
* should react (e.g. pan), without disrupting the sensitivity of it's children.
*
- * @param[in] sensitive true to enable scroll, false to disable scrolling
*/
void SetScrollSensitive(bool sensitive);
* edge of a scrollable area and the maximum overshoot is 100 then
* the final overshoot value will be 0.75f)
*
+ * @SINCE_1_0.0
* @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
* @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
*/
/**
* @brief Set Snap Overshoot animation's AlphaFunction.
*
+ * @SINCE_1_0.0
* @param[in] alpha Easing alpha function of the overshoot snap animation.
*/
void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
/**
* @brief Set Snap Overshoot animation's Duration.
*
+ * @SINCE_1_0.0
+ * @param[in] duration The duration of the overshoot snap animation.
* @note Set duration to 0 seconds, to disable Animation.
*
- * @param[in] duration The duration of the overshoot snap animation.
*/
void SetSnapOvershootDuration(float duration);
* snap to the closest actor (The closest actor will appear in the center of
* the ScrollView).
*
+ * @SINCE_1_0.0
* @param[in] enable Enables (true), or disables (false) Actor AutoSnap
*/
void SetActorAutoSnap(bool enable);
*
* When enabled, the ScrollView contents are wrapped over the X/Y Domain.
*
+ * @SINCE_1_0.0
+ * @param[in] enable Enables (true), or disables (false) Wrap Mode.
* @note You must apply a position constraint that causes Wrapping
* to all children.
*
- * @param[in] enable Enables (true), or disables (false) Wrap Mode.
*/
void SetWrapMode(bool enable);
/**
* @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted
*
+ * @SINCE_1_0.0
* @return Current scroll update distance
*/
int GetScrollUpdateDistance() const;
* The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
* Each time the ScrollView crosses this distance the signal will be emitted
*
+ * @SINCE_1_0.0
* @param[in] distance The distance for ScrollView to move before emitting update signal
*/
void SetScrollUpdateDistance(int distance);
/**
* @brief Returns state of Axis Auto Lock mode.
*
+ * @SINCE_1_0.0
* @return Whether Axis Auto Lock mode has been enabled or not.
*/
bool GetAxisAutoLock() const;
* vertical, will be automatically restricted to horizontal only or vertical
* only panning, until the pan gesture has completed.
*
+ * @SINCE_1_0.0
* @param[in] enable Enables (true), or disables (false) AxisAutoLock mode.
*/
void SetAxisAutoLock(bool enable);
* @brief Gets the gradient threshold at which a panning gesture
* should be locked to the Horizontal or Vertical axis.
*
+ * @SINCE_1_0.0
* @return The gradient, a value between 0.0 and 1.0f.
*/
float GetAxisAutoLockGradient() const;
* @note: Specifying a value of 1.0 (the maximum value accepted) indicates that
* all panning gestures will auto-lock. Either to the horizontal or vertical axis.
*
+ * @SINCE_1_0.0
* @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
*/
void SetAxisAutoLockGradient(float gradient);
*
* This is a value in stage-diagonals per second^2.
* stage-diagonal = Length( stage.width, stage.height )
+ * @SINCE_1_0.0
* @return Friction coefficient is returned.
*/
float GetFrictionCoefficient() const;
* A stage 480x800 in size has a diagonal length of 933.
* Friction coefficient of 1.0 means the swipe velocity will
* reduce by 1.0 * 933 pixels/sec^2.
+ * @SINCE_1_0.0
* @param[in] friction Friction coefficient, must be greater than 0.0 (default = 1.0)
*/
void SetFrictionCoefficient(float friction);
* This is a constant which multiplies the input touch
* flick velocity to determine the actual velocity at
* which to move the scrolling area.
+ * @SINCE_1_0.0
* @return The flick speed coefficient is returned.
*/
float GetFlickSpeedCoefficient() const;
* This is a constant which multiplies the input touch
* flick velocity to determine the actual velocity at
* which to move the scrolling area.
+ * @SINCE_1_0.0
* @param[in] speed The flick speed coefficient (default = 1.0).
*/
void SetFlickSpeedCoefficient(float speed);
/**
* @brief Returns the minimum pan distance required for a flick gesture in pixels
*
+ * @SINCE_1_0.0
* @return Minimum pan distance vector with separate x and y distance
*/
Vector2 GetMinimumDistanceForFlick() const;
*
* Takes a Vector2 containing separate x and y values. As long as the pan distance exceeds one of these axes a flick will be allowed
*
+ * @SINCE_1_0.0
* @param[in] distance The minimum pan distance for a flick
*/
void SetMinimumDistanceForFlick( const Vector2& distance );
/**
* @brief Returns the minimum pan speed required for a flick gesture in pixels per second
*
+ * @SINCE_1_0.0
* @return Minimum pan speed
*/
float GetMinimumSpeedForFlick() const;
/**
* @brief Sets the minimum pan speed required for a flick in pixels per second
*
+ * @SINCE_1_0.0
* @param[in] speed The minimum pan speed for a flick
*/
void SetMinimumSpeedForFlick( float speed );
*
* This is a value in stage-diagonals per second.
* stage-diagonal = Length( stage.width, stage.height )
+ * @SINCE_1_0.0
* @return Maximum flick speed is returned
*/
float GetMaxFlickSpeed() const;
* A stage 480x800 in size has a diagonal length of 933.
* Max Flick speed of 1.0 means the maximum velocity of
* a swipe can be 1.0 * 933 pixels/sec.
+ * @SINCE_1_0.0
* @param[in] speed Maximum flick speed (default = 3.0)
*/
void SetMaxFlickSpeed(float speed);
* @brief Gets the step of scroll distance in actor coordinates for
* each wheel event received in free panning mode.
*
+ * @SINCE_1_0.0
* @return The step of scroll distance(pixel) in X and Y axes.
*/
Vector2 GetWheelScrollDistanceStep() const;
* @brief Sets the step of scroll distance in actor coordinates for
* each wheel event received in free panning mode.
*
+ * @SINCE_1_0.0
* @param[in] step The step of scroll distance(pixel) in X and Y axes.
*
* @note: If snap points are defined in the rulers, it will always
* @brief Retrieves current scroll position.
*
* @returns The current scroll position.
+ * @SINCE_1_0.0
*/
Vector2 GetCurrentScrollPosition() const;
* @note: Pages start from 0 as the first page, not 1.
*
* @returns The Current page.
+ * @SINCE_1_0.0
*/
unsigned int GetCurrentPage() const;
* increasing Y scrolls contents up.
* - If Rulers have been applied to the axes, then the contents will scroll until
* reaching the domain boundary.
+ * @SINCE_1_0.0
+ * @param[in] position The position to scroll to.
* @note Contents will not snap to ruler snap points.
*
- * @param[in] position The position to scroll to.
*/
void ScrollTo(const Vector2& position);
* increasing Y scrolls contents up.
* - If Rulers have been applied to the axes, then the contents will scroll until
* reaching the domain boundary.
- * @note Contents will not snap to ruler snap points.
- *
+ * @SINCE_1_0.0
* @param[in] position The position to scroll to.
* @param[in] duration The duration of the animation in seconds
+ * @note Contents will not snap to ruler snap points.
+ *
*/
void ScrollTo(const Vector2& position, float duration);
* increasing Y scrolls contents up.
* - If Rulers have been applied to the axes, then the contents will scroll until
* reaching the domain boundary.
- * @note Contents will not snap to ruler snap points.
- *
+ * @SINCE_1_0.0
* @param[in] position The position to scroll to.
* @param[in] duration The duration of the animation in seconds
* @param[in] alpha The alpha function to use
+ * @note Contents will not snap to ruler snap points.
+ *
*/
void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha);
* increasing Y scrolls contents up.
* - If Rulers have been applied to the axes, then the contents will scroll until
* reaching the domain boundary.
+ * @SINCE_1_0.0
+ * @param[in] position The position to scroll to.
+ * @param[in] duration The duration of the animation in seconds
+ * @param[in] horizontalBias Whether to bias scrolling to left or right.
+ * @param[in] verticalBias Whether to bias scrolling to top or bottom.
* @note Contents will not snap to ruler snap points.
* Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
* wrap mode, the application developer can decide whether to scroll left or right
* to get to the target page
*
- * @param[in] position The position to scroll to.
- * @param[in] duration The duration of the animation in seconds
- * @param[in] horizontalBias Whether to bias scrolling to left or right.
- * @param[in] verticalBias Whether to bias scrolling to top or bottom.
*/
void ScrollTo(const Vector2& position, float duration,
DirectionBias horizontalBias, DirectionBias verticalBias);
* increasing Y scrolls contents up.
* - If Rulers have been applied to the axes, then the contents will scroll until
* reaching the domain boundary.
- * @note Contents will not snap to ruler snap points.
- * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
- * wrap mode, the application developer can decide whether to scroll left or right
- * to get to the target page
- *
+ * @SINCE_1_0.0
* @param[in] position The position to scroll to.
* @param[in] duration The duration of the animation in seconds
* @param[in] horizontalBias Whether to bias scrolling to left or right.
* @param[in] verticalBias Whether to bias scrolling to top or bottom.
* @param[in] alpha Alpha function to use
+ * @note Contents will not snap to ruler snap points.
+ * Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
+ * wrap mode, the application developer can decide whether to scroll left or right
+ * to get to the target page
+ *
*/
void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha,
DirectionBias horizontalBias, DirectionBias verticalBias);
* @brief Scrolls View to page currently based on assumption that each page is
* "(page) * ScrollViewSize.width, 0".
*
+ * @SINCE_1_0.0
+ * @param[in] page to scroll to
* @note Should probably be upgraded so that page is an abstract class, that can be
* a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
* orchestrated in a 2D grid fashion, or variable width.
*
- * @param[in] page to scroll to
*/
void ScrollTo(unsigned int page);
* @brief Scrolls View to page currently based on assumption that each page is
* "(page) * ScrollViewSize.width, 0".
*
+ * @SINCE_1_0.0
+ * @param[in] page to scroll to
+ * @param[in] duration The duration of the animation in seconds
* @note Should probably be upgraded so that page is an abstract class, that can be
* a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
* orchestrated in a 2D grid fashion, or variable width.
*
- * @param[in] page to scroll to
- * @param[in] duration The duration of the animation in seconds
*/
void ScrollTo(unsigned int page, float duration);
* @brief Scrolls View to page currently based on assumption that each page is
* "(page) * ScrollViewSize.width, 0".
*
+ * @SINCE_1_0.0
+ * @param[in] page to scroll to
+ * @param[in] duration The duration of the animation in seconds
+ * @param[in] bias Whether to bias scrolling to left or right.
* @note Should probably be upgraded so that page is an abstract class, that can be
* a function of ScrollViewSize, ruler domain, ruler snap points etc. as pages may be
* orchestrated in a 2D grid fashion, or variable width.
* the application developer can decide whether to scroll left or right to get to
* the target page.
*
- * @param[in] page to scroll to
- * @param[in] duration The duration of the animation in seconds
- * @param[in] bias Whether to bias scrolling to left or right.
*/
void ScrollTo(unsigned int page, float duration, DirectionBias bias);
/**
* @brief Scrolls View such that actor appears in the center of the ScrollView.
*
+ * @SINCE_1_0.0
+ * @param[in] actor The actor to center in on (via Scrolling).
* @note Actor must be a direct child of ScrollView, otherwise will
* cause an assertion failure.
- * @param[in] actor The actor to center in on (via Scrolling).
*/
void ScrollTo(Actor& actor);
/**
* @brief Scrolls View such that actor appears in the center of the ScrollView.
*
- * @note Actor must be a direct child of ScrollView, otherwise will
- * cause an assertion failure.
+ * @SINCE_1_0.0
* @param[in] actor The actor to center in on (via Scrolling).
* @param[in] duration The duration of the animation in seconds
+ * @note Actor must be a direct child of ScrollView, otherwise will
+ * cause an assertion failure.
*/
void ScrollTo(Actor& actor, float duration);
*
* If already at snap points, then will return false, and not scroll.
*
+ * @SINCE_1_0.0
* @return True if Snapping necessary.
*/
bool ScrollToSnapPoint();
/**
* @brief Applies a constraint that will affect the children of ScrollView.
*
- * @note this affects all existing and future Actors that are added to scrollview.
+ * @SINCE_1_0.0
* @param[in] constraint The constraint to apply
+ * @note this affects all existing and future Actors that are added to scrollview.
*/
void ApplyConstraintToChildren(Constraint constraint);
/**
* @brief Removes all constraints that will affect the children of ScrollView.
*
+ * @SINCE_1_0.0
* @note this removes all constraints from actors that have been added
* to scrollview.
*/
/**
* @brief Apply Effect to ScrollView.
*
+ * @SINCE_1_0.0
* @param[in] effect The effect to apply to scroll view
*/
void ApplyEffect(ScrollViewEffect effect);
/**
* @brief Remove Effect from ScrollView.
*
+ * @SINCE_1_0.0
* @param[in] effect The effect to remove.
*/
void RemoveEffect(ScrollViewEffect effect);
/**
* @brief Remove All Effects from ScrollView.
+ * @SINCE_1_0.0
*/
void RemoveAllEffects();
* Once an actor is bound to a ScrollView, it will be subject to
* that ScrollView's properties.
*
+ * @SINCE_1_0.0
* @param[in] child The actor to add to this ScrollView.
*/
void BindActor(Actor child);
* @brief Unbind Actor from this ScrollView.
*
* Once Unbound, this ScrollView will not affect the actor.
+ * @SINCE_1_0.0
+ * @param[in] child The actor to be unbound.
* @note this does not remove the child from the ScrollView container
*
- * @param[in] child The actor to be unbound.
*/
void UnbindActor(Actor child);
/**
* @brief Allows the user to constrain the scroll view in a particular direction.
*
+ * @SINCE_1_0.0
* @param[in] direction The axis to constrain the scroll-view to.
* Usually set to PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
* @param[in] threshold The threshold to apply around the axis.
/**
* @brief Remove a direction constraint from the scroll view.
*
+ * @SINCE_1_0.0
* @param[in] direction The axis to stop constraining to.
* Usually will be PanGestureDetector::DIRECTION_VERTICAL or PanGestureDetector::DIRECTION_HORIZONTAL (but can be any other angle if desired).
*/
* @code
* void YourCallbackName(const SnapEvent& event);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
SnapStartedSignalType& SnapStartedSignal();
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL ScrollView(Internal::ScrollView& implementation);
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
* | scrollStarted | @ref ScrollStartedSignal() |
* | scrollCompleted | @ref ScrollUpdatedSignal() |
* | scrollUpdated | @ref ScrollCompletedSignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Scrollable : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0
ANIMATABLE_PROPERTY_START_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX,
- ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices
+ ANIMATABLE_PROPERTY_END_INDEX = ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve animatable property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the Scrollable class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
// Event side properties
- OVERSHOOT_EFFECT_COLOR = PROPERTY_START_INDEX, ///< Property, name "overshootEffectColor", @see SetOvershootEffectColor(), type Vector4
- OVERSHOOT_ANIMATION_SPEED, ///< Property, name "overshootAnimationSpeed", @see SetOvershootAnimationSpeed(), type float
- OVERSHOOT_ENABLED, ///< Property, name "overshootEnabled", @see SetOvershootEnabled(), type bool, @since DALi 1.1.18
+ OVERSHOOT_EFFECT_COLOR = PROPERTY_START_INDEX, ///< Property, name "overshootEffectColor", @see SetOvershootEffectColor(), type Vector4 @SINCE_1_0.0
+ OVERSHOOT_ANIMATION_SPEED, ///< Property, name "overshootAnimationSpeed", @see SetOvershootAnimationSpeed(), type float @SINCE_1_0.0
+ OVERSHOOT_ENABLED, ///< Property, name "overshootEnabled", @see SetOvershootEnabled(), type bool, @SINCE_1_1.18
// Animatable properties
- SCROLL_RELATIVE_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollRelativePosition", type Vector2
- SCROLL_POSITION_MIN, ///< Property, name "scrollPositionMin", type Vector2
- SCROLL_POSITION_MIN_X, ///< Property, name "scrollPositionMinX", type float
- SCROLL_POSITION_MIN_Y, ///< Property, name "scrollPositionMinY", type float
- SCROLL_POSITION_MAX, ///< Property, name "scrollPositionMax", type Vector2
- SCROLL_POSITION_MAX_X, ///< Property, name "scrollPositionMaxX", type float
- SCROLL_POSITION_MAX_Y, ///< Property, name "scrollPositionMaxY", type float
- CAN_SCROLL_VERTICAL, ///< Property, name "canScrollVertical", type bool
- CAN_SCROLL_HORIZONTAL ///< Property, name "canScrollHorizontal", type bool
+ SCROLL_RELATIVE_POSITION = ANIMATABLE_PROPERTY_START_INDEX, ///< Property, name "scrollRelativePosition", type Vector2 @SINCE_1_0.0
+ SCROLL_POSITION_MIN, ///< Property, name "scrollPositionMin", type Vector2 @SINCE_1_0.0
+ SCROLL_POSITION_MIN_X, ///< Property, name "scrollPositionMinX", type float @SINCE_1_0.0
+ SCROLL_POSITION_MIN_Y, ///< Property, name "scrollPositionMinY", type float @SINCE_1_0.0
+ SCROLL_POSITION_MAX, ///< Property, name "scrollPositionMax", type Vector2 @SINCE_1_0.0
+ SCROLL_POSITION_MAX_X, ///< Property, name "scrollPositionMaxX", type float @SINCE_1_0.0
+ SCROLL_POSITION_MAX_Y, ///< Property, name "scrollPositionMaxY", type float @SINCE_1_0.0
+ CAN_SCROLL_VERTICAL, ///< Property, name "canScrollVertical", type bool @SINCE_1_0.0
+ CAN_SCROLL_HORIZONTAL ///< Property, name "canScrollHorizontal", type bool @SINCE_1_0.0
};
};
// Typedefs
- typedef Signal< void ( const Vector2& ) > ScrollStartedSignalType; ///< ScrollStarted signal type
- typedef Signal< void ( const Vector2& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type
- typedef Signal< void ( const Vector2& ) > ScrollUpdatedSignalType; ///< Scroll updated signal type
+ typedef Signal< void ( const Vector2& ) > ScrollStartedSignalType; ///< ScrollStarted signal type @SINCE_1_0.0
+ typedef Signal< void ( const Vector2& ) > ScrollCompletedSignalType; ///< ScrollCompleted signal type @SINCE_1_0.0
+ typedef Signal< void ( const Vector2& ) > ScrollUpdatedSignalType; ///< Scroll updated signal type @SINCE_1_0.0
public:
/**
* @brief Creates an uninitialized Scrollable handle.
+ * @SINCE_1_0.0
*/
Scrollable();
*
* Creates another handle that points to the same real object
*
+ * @SINCE_1_0.0
* @param handle to copy from
*/
Scrollable( const Scrollable& handle );
* @brief Assignment operator.
*
* Changes this handle to point to another real object
+ * @SINCE_1_0.0
* @param[in] handle to copy from
* @return A reference to this
*/
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Scrollable();
* If handle points to a Scrollable 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 Scrollable or an uninitialized handle
*/
/**
* @brief Checks if scroll overshoot has been enabled or not.
*
+ * @SINCE_1_0.0
* @return Whether the scroll obvershoot is enabled
*/
bool IsOvershootEnabled() const;
/**
* @brief Sets whether to enables or disable scroll overshoot.
*
+ * @SINCE_1_0.0
* @param[in] enable Whether to enable the scroll obvershoot or not
*/
void SetOvershootEnabled(bool enable);
/**
* @brief Set the color of the overshoot effect.
*
+ * @SINCE_1_0.0
* @param[in] color The color of the overshoot effect.
*/
void SetOvershootEffectColor( const Vector4& color );
/**
* @brief Get the color of the overshoot effect.
+ * @SINCE_1_0.0
* @return The color of the overshoot effect.
*/
Vector4 GetOvershootEffectColor() const;
/**
* @brief Set the speed of overshoot animation in pixels per second.
* When the speed is not greater than 0, the overshoot is set instantly with no animation.
+ * @SINCE_1_0.0
* @param[in] pixelsPerSecond The speed of the overshoot animation.
*/
void SetOvershootAnimationSpeed( float pixelsPerSecond );
/**
* @brief Get the speed of overshoot animation in pixels per second.
+ * @SINCE_1_0.0
* @return The speed of the overshoot animation.
*/
float GetOvershootAnimationSpeed() const;
* @code
* void YourCallbackName(const Vector2& currentScrollPosition);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
ScrollStartedSignalType& ScrollStartedSignal();
* @code
* void YourCallbackName(const Vector2& currentScrollPosition);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
ScrollUpdatedSignalType& ScrollUpdatedSignal();
* @code
* void YourCallbackName(const Vector2& currentScrollPosition);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
ScrollCompletedSignalType& ScrollCompletedSignal();
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL Scrollable(Internal::Scrollable& implementation);
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal );
* "cellVerticalAlignment": "center" // property to specify how to align vertically inside the cells, if not set, default value is 'top'
* }
* @endcode
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API TableView : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
};
/**
* It has the format as follows in script:
* @code
* "layoutRows":
- {
- "0": { "policy": "fixed", "value": 40 }, //@see SetFixedHight
- "2": { "policy": "relative", "value": 0.33 }, //@see SetRelativeHeight
- "3": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its height is decided by the children in this row
- }
+ * {
+ * "0": { "policy": "fixed", "value": 40 }, //@see SetFixedHight
+ * "2": { "policy": "relative", "value": 0.33 }, //@see SetRelativeHeight
+ * "3": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its height is decided by the children in this row
+ * }
* @endcode
*
* LayoutColumns: set the height of the rows.
* It has the format as follows in script:
* @code
* "layoutColumns":
- {
- "0": { "policy": "fixed", "value": 40 }, //@see SetFixedWidth
- "1": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its width is decided by the children in this column
- "2": { "policy": "relative", "value": 0.33 } //@see SetRelativeWidth
- }
+ * {
+ * "0": { "policy": "fixed", "value": 40 }, //@see SetFixedWidth
+ * "1": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its width is decided by the children in this column
+ * "2": { "policy": "relative", "value": 0.33 } //@see SetRelativeWidth
+ * }
* @endcode
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- ROWS = PROPERTY_START_INDEX, ///< name "rows", type unsigned int
- COLUMNS, ///< name "columns", type unsigned int
- CELL_PADDING, ///< name "cellPadding", type Vector2
- LAYOUT_ROWS, ///< name "layoutRows", type Map
- LAYOUT_COLUMNS, ///< name "layoutColumns", type Map
+ ROWS = PROPERTY_START_INDEX, ///< name "rows", type unsigned int @SINCE_1_0.0
+ COLUMNS, ///< name "columns", type unsigned int @SINCE_1_0.0
+ CELL_PADDING, ///< name "cellPadding", type Vector2 @SINCE_1_0.0
+ LAYOUT_ROWS, ///< name "layoutRows", type Map @SINCE_1_0.0
+ LAYOUT_COLUMNS, ///< name "layoutColumns", type Map @SINCE_1_0.0
};
};
/**
* @brief Describes how the size of a row / column been set
+ * @SINCE_1_0.0
*/
enum LayoutPolicy
{
- FIXED, ///< Fixed with the given value.
- RELATIVE, ///< Calculated as percentage of the remainder after subtracting Padding and Fixed height/width
- FILL, ///< Default policy, get the remainder of the 100% (after subtracting Fixed, Fit and Relative height/ width) divided evenly between 'fill' rows/columns
- FIT ///< Fit around its children.
+ FIXED, ///< Fixed with the given value. @SINCE_1_0.0
+ RELATIVE, ///< Calculated as percentage of the remainder after subtracting Padding and Fixed height/width @SINCE_1_0.0
+ FILL, ///< Default policy, get the remainder of the 100% (after subtracting Fixed, Fit and Relative height/ width) divided evenly between 'fill' rows/columns @SINCE_1_0.0
+ FIT ///< Fit around its children. @SINCE_1_0.0
};
/**
- * Structure to specify layout position for child actor
+ * @brief Structure to specify layout position for child actor
+ * @SINCE_1_0.0
*/
struct CellPosition
{
/**
- * Constructor to initialise values to defaults for convenience
+ * @brief Constructor to initialise values to defaults for convenience
+ * @SINCE_1_0.0
*/
CellPosition( unsigned int rowIndex = 0, unsigned int columnIndex = 0,
unsigned int rowSpan = 1, unsigned int columnSpan = 1 )
};
/**
- * Create a TableView handle; this can be initialised with TableView::New()
+ * @brief Create a TableView handle; this can be initialised with TableView::New()
* Calling member functions with an uninitialised handle is not allowed.
+ * @SINCE_1_0.0
*/
TableView();
/**
- * Copy constructor. Creates another handle that points to the same real object
+ * @brief Copy constructor. Creates another handle that points to the same real object
+ * @SINCE_1_0.0
* @param handle to copy from
*/
TableView( const TableView& handle );
/**
- * Assignment operator. Changes this handle to point to another real object
+ * @brief Assignment operator. Changes this handle to point to another real object
+ * @SINCE_1_0.0
*/
TableView& operator=( const TableView& handle );
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~TableView();
/**
- * Create the TableView control.
+ * @brief Create the TableView control.
+ * @SINCE_1_0.0
* @param[in] initialRows for the table
* @param[in] initialColumns for the table
* @return A handle to the TableView control.
static TableView New( unsigned int initialRows, unsigned int initialColumns );
/**
- * Downcast an Object handle to TableView. If handle points to a TableView the
+ * @brief Downcast an Object handle to TableView. If handle points to a TableView 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 TableView or an uninitialized handle
*/
static TableView DownCast( BaseHandle handle );
/**
- * Adds a child to the table
+ * @brief Adds a child to the table
* If the row or column index is outside the table, the table gets resized bigger
- * @pre The child actor has been initialized.
+ * @SINCE_1_0.0
* @param[in] child to add
* @param[in] position for the child
* @return true if the addition succeeded, false if the cell is already occupied
+ * @pre The child actor has been initialized.
*/
bool AddChild( Actor child, CellPosition position );
/**
- * Returns a child from the given layout position
+ * @brief Returns a child from the given layout position
* Note! if there is no child in this position this method returns an uninitialized
* Actor handle
+ * @SINCE_1_0.0
* @param[in] position in the table
* @return child that was in the cell or an uninitialized handle
*/
Actor GetChildAt( CellPosition position );
/**
- * Removes a child from the given layout position
+ * @brief Removes a child from the given layout position
* Note! if there is no child in this position this method does nothing
+ * @SINCE_1_0.0
* @param[in] position for the child to remove
* @return child that was removed or an uninitialized handle
*/
Actor RemoveChildAt( CellPosition position );
/**
- * Finds the childs layout position
+ * @brief Finds the childs layout position
+ * @SINCE_1_0.0
* @param[in] child to search for
* @param[out] position for the child
* @return true if the child was included in this TableView
bool FindChildPosition( Actor child, CellPosition& position );
/**
- * Insert a new row to given index
+ * @brief Insert a new row to given index
+ * @SINCE_1_0.0
* @param [in] rowIndex of the new row
*/
void InsertRow( unsigned int rowIndex );
/**
- * Delete a row from given index
+ * @brief Delete a row from given index
* Removed elements are deleted
+ * @SINCE_1_0.0
* @param [in] rowIndex of the row to delete
*/
void DeleteRow( unsigned int rowIndex );
/**
- * Delete a row from given index
+ * @brief Delete a row from given index
+ * @SINCE_1_0.0
* @param [in] rowIndex of the row to delete
* @param [out] removed elements
*/
void DeleteRow( unsigned int rowIndex, std::vector<Actor>& removed );
/**
- * Insert a new column to given index
+ * @brief Insert a new column to given index
+ * @SINCE_1_0.0
* @param [in] columnIndex of the new column
*/
void InsertColumn( unsigned int columnIndex );
/**
- * Delete a column from given index.
+ * @brief Delete a column from given index.
* Removed elements are deleted
+ * @SINCE_1_0.0
* @param [in] columnIndex of the column to delete
*/
void DeleteColumn( unsigned int columnIndex );
/**
- * Delete a column from given index
+ * @brief Delete a column from given index
+ * @SINCE_1_0.0
* @param [in] columnIndex of the column to delete
* @param [out] removed elements
*/
void DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed );
/**
- * Resize the TableView. Note! if the new size is smaller than old,
+ * @brief Resize the TableView. Note! if the new size is smaller than old,
* superfluous actors get removed. If you want to relayout removed children,
* use the variant that returns the removed Actors and reinsert them into the table
* If an actor spans to a removed row or column it gets removed from the table
+ * @SINCE_1_0.0
* @param[in] rows for the table
* @param[in] columns for the table
*/
void Resize( unsigned int rows, unsigned int columns );
/**
- * Resize the TableView. Note! if the new size is smaller than old,
+ * @brief Resize the TableView. Note! if the new size is smaller than old,
* superfluous actors get removed.
* If an actor spans to a removed row or column it gets removed from the table
+ * @SINCE_1_0.0
* @param[in] rows for the table
* @param[in] columns for the table
* @param[out] removed actor handles
void Resize( unsigned int rows, unsigned int columns, std::vector<Actor>& removed );
/**
- * Set horizontal and vertical padding between cells
+ * @brief Set horizontal and vertical padding between cells
+ * @SINCE_1_0.0
* @param[in] padding width and height
*/
void SetCellPadding( Size padding );
/**
+ * @SINCE_1_0.0
* @return the current padding as width and height
*/
Size GetCellPadding();
/**
* @brief Specify this row as fitting its height to its children
*
+ * @SINCE_1_0.0
* @param[in] rowIndex The row to set
*/
void SetFitHeight( unsigned int rowIndex );
/**
* @brief Is the row a fit row
*
+ * @SINCE_1_0.0
* @param[in] rowIndex The row to check
* @return Return true if the row is fit
*/
/**
* @brief Specify this column as fitting its width to its children
*
+ * @SINCE_1_0.0
* @param[in] columnIndex The column to set
*/
void SetFitWidth( unsigned int columnIndex );
/**
* @brief Is the column a fit column
*
+ * @SINCE_1_0.0
* @param[in] columnIndex The column to check
* @return Return true if the column is fit
*/
bool IsFitWidth( unsigned int columnIndex ) const;
/**
- * Sets a row to have fixed height
+ * @brief Sets a row to have fixed height
* Setting a fixed height of 0 has no effect
- * @pre The row rowIndex must exist.
+ * @SINCE_1_0.0
* @param rowIndex for row with fixed height
* @param height in world coordinate units
+ * @pre The row rowIndex must exist.
*/
void SetFixedHeight( unsigned int rowIndex, float height );
/**
- * Gets a row's fixed height.
+ * @brief Gets a row's fixed height.
* Note! The returned value is valid if it has been set before.
- * @pre The row rowIndex must exist.
+ * @SINCE_1_0.0
* @return height in world coordinate units.
+ * @pre The row rowIndex must exist.
*/
float GetFixedHeight( unsigned int rowIndex ) const;
/**
- * Sets a row to have relative height. Relative height means percentage of
+ * @brief Sets a row to have relative height. Relative height means percentage of
* the remainder of the table height after subtracting Padding and Fixed height rows
* Setting a relative height of 0 has no effect
- * @pre The row rowIndex must exist.
+ * @SINCE_1_0.0
* @param rowIndex for row with relative height
* @param heightPercentage between 0.0f and 1.0f
+ * @pre The row rowIndex must exist.
*/
void SetRelativeHeight( unsigned int rowIndex, float heightPercentage );
/**
- * Gets a row's relative height.
+ * @brief Gets a row's relative height.
* Note! The returned value is valid if it has been set before.
- * @pre The row rowIndex must exist.
+ * @SINCE_1_0.0
* @return height in percentage units, between 0.0f and 1.0f.
+ * @pre The row rowIndex must exist.
*/
float GetRelativeHeight( unsigned int rowIndex ) const;
/**
- * Sets a column to have fixed width
+ * @brief Sets a column to have fixed width
* Setting a fixed width of 0 has no effect
- * @pre The column columnIndex must exist.
+ * @SINCE_1_0.0
* @param columnIndex for column with fixed width
* @param width in world coordinate units
+ * @pre The column columnIndex must exist.
*/
void SetFixedWidth( unsigned int columnIndex, float width );
/**
- * Gets a column's fixed width.
+ * @brief Gets a column's fixed width.
* Note! The returned value is valid if it has been set before.
- * @pre The column columnIndex must exist.
+ * @SINCE_1_0.0
* @return width in world coordinate units.
+ * @pre The column columnIndex must exist.
*/
float GetFixedWidth( unsigned int columnIndex ) const;
/**
- * Sets a column to have relative width. Relative width means percentage of
+ * @brief Sets a column to have relative width. Relative width means percentage of
* the remainder of table width after subtracting Padding and Fixed width columns
* Setting a relative width of 0 has no effect
- * @pre The column columnIndex must exist.
+ * @SINCE_1_0.0
* @param columnIndex for column with fixed width
* @param widthPercentage between 0.0f and 1.0f
+ * @pre The column columnIndex must exist.
*/
void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
/**
- * Gets a column's relative width.
+ * @brief Gets a column's relative width.
* Note! The returned value is valid if it has been set before.
- * @pre The column columnIndex must exist.
+ * @SINCE_1_0.0
* @return width in percentage units, between 0.0f and 1.0f.
+ * @pre The column columnIndex must exist.
*/
float GetRelativeWidth( unsigned int columnIndex ) const;
/**
+ * @SINCE_1_0.0
* @return the amount of rows in the table
*/
unsigned int GetRows();
/**
+ * @SINCE_1_0.0
* @return the amount of columns in the table
*/
unsigned int GetColumns();
*
* Cells without calling this function have the default values of LEFT and TOP respectively.
*
+ * @SINCE_1_0.0
* @param[in] position The cell to set alignment on.
* @param[in] horizontal The horizontal alignment.
* @param[in] vertical The vertical alignment.
public: // Not intended for application developers
/**
- * Creates a handle using the Toolkit::Internal implementation.
+ * @brief Creates a handle using the Toolkit::Internal implementation.
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL TableView(Internal::TableView& implementation);
/**
- * Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal );
* | textChanged | @ref TextChangedSignal() |
* | maxLengthReached | @ref MaxLengthReachedSignal() |
*
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API TextField : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the TextField class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT
- TEXT, ///< name "text", The text to display in UTF-8 format, type STRING
- PLACEHOLDER_TEXT, ///< name "placeholderText", The text to display when the TextField is empty and inactive, type STRING
- PLACEHOLDER_TEXT_FOCUSED, ///< name "placeholderTextFocused", The text to display when the TextField is empty with key-input focus, type STRING
- FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING
- FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING
- POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT
- MAX_LENGTH, ///< name "maxLength" The maximum number of characters that can be inserted, type INTEGER
- EXCEED_POLICY, ///< name "exceedPolicy" Specifies how the text is truncated when it does not fit, type INTEGER
- HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END"
- VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM"
- TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4
- PLACEHOLDER_TEXT_COLOR, ///< name "placeholderTextColor", The placeholder-text color, type VECTOR4
- SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2
- SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4
- PRIMARY_CURSOR_COLOR, ///< name "primaryCursorColor", The color to apply to the primary cursor, type VECTOR4
- SECONDARY_CURSOR_COLOR, ///< name "secondaryCursorColor", The color to apply to the secondary cursor, type VECTOR4
- ENABLE_CURSOR_BLINK, ///< name "enableCursorBlink", Whether the cursor should blink or not, type BOOLEAN
- CURSOR_BLINK_INTERVAL, ///< name "cursorBlinkInterval", The time interval in seconds between cursor on/off states, type FLOAT
- CURSOR_BLINK_DURATION, ///< name "cursorBlinkDuration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT
- CURSOR_WIDTH, ///< name "cursorWidth", The cursor width, type INTEGER
- GRAB_HANDLE_IMAGE, ///< name "grabHandleImage", The image to display for the grab handle, type STRING
- GRAB_HANDLE_PRESSED_IMAGE, ///< name "grabHandlePressedImage", The image to display when the grab handle is pressed, type STRING
- SCROLL_THRESHOLD, ///< name "scrollThreshold" Horizontal scrolling will occur if the cursor is this close to the control border, type FLOAT
- SCROLL_SPEED, ///< name "scrollSpeed" The scroll speed in pixels per second, type FLOAT
- SELECTION_HANDLE_IMAGE_LEFT, ///< name "selectionHandleImageLeft", The image to display for the left selection handle, type MAP
- SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selectionHandleImageRight", The image to display for the right selection handle, type MAP
- SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selectionHandlePressedImageLeft", The image to display when the left selection handle is pressed, type MAP
- SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selectionHandlePressedImageRight", The image to display when the right selection handle is pressed, type MAP
- SELECTION_HANDLE_MARKER_IMAGE_LEFT, ///< name "selectionHandleMarkerImageLeft", The image to display for the left selection handle marker, type MAP
- SELECTION_HANDLE_MARKER_IMAGE_RIGHT, ///< name "selectionHandleMarkerImageRight", The image to display for the right selection handle marker, type MAP
- SELECTION_HIGHLIGHT_COLOR, ///< name "selectionHighlightColor", The color of the selection highlight, type VECTOR4
- DECORATION_BOUNDING_BOX, ///< name "decorationBoundingBox", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE
- INPUT_METHOD_SETTINGS, ///< name "inputMethodSettings", The settings to relating to the System's Input Method, Key and Value type MAP
- INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4
- ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN
- INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING
- INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING
- INPUT_POINT_SIZE ///< name "inputPointSize", The font's size of the new input text in points, type FLOAT
+ RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_0.0
+ TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_0.0
+ PLACEHOLDER_TEXT, ///< name "placeholderText", The text to display when the TextField is empty and inactive, type STRING @SINCE_1_0.0
+ PLACEHOLDER_TEXT_FOCUSED, ///< name "placeholderTextFocused", The text to display when the TextField is empty with key-input focus, type STRING @SINCE_1_0.0
+ FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_0.0
+ FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_0.0
+ POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_0.0
+ MAX_LENGTH, ///< name "maxLength" The maximum number of characters that can be inserted, type INTEGER @SINCE_1_0.0
+ EXCEED_POLICY, ///< name "exceedPolicy" Specifies how the text is truncated when it does not fit, type INTEGER @SINCE_1_0.0
+ HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_0.0
+ VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0
+ TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_0.0
+ PLACEHOLDER_TEXT_COLOR, ///< name "placeholderTextColor", The placeholder-text color, type VECTOR4 @SINCE_1_0.0
+ SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2 @SINCE_1_0.0
+ SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4 @SINCE_1_0.0
+ PRIMARY_CURSOR_COLOR, ///< name "primaryCursorColor", The color to apply to the primary cursor, type VECTOR4 @SINCE_1_0.0
+ SECONDARY_CURSOR_COLOR, ///< name "secondaryCursorColor", The color to apply to the secondary cursor, type VECTOR4 @SINCE_1_0.0
+ ENABLE_CURSOR_BLINK, ///< name "enableCursorBlink", Whether the cursor should blink or not, type BOOLEAN @SINCE_1_0.0
+ CURSOR_BLINK_INTERVAL, ///< name "cursorBlinkInterval", The time interval in seconds between cursor on/off states, type FLOAT @SINCE_1_0.0
+ CURSOR_BLINK_DURATION, ///< name "cursorBlinkDuration", The cursor will stop blinking after this number of seconds (if non-zero), type FLOAT @SINCE_1_0.0
+ CURSOR_WIDTH, ///< name "cursorWidth", The cursor width, type INTEGER @SINCE_1_0.0
+ GRAB_HANDLE_IMAGE, ///< name "grabHandleImage", The image to display for the grab handle, type STRING @SINCE_1_0.0
+ GRAB_HANDLE_PRESSED_IMAGE, ///< name "grabHandlePressedImage", The image to display when the grab handle is pressed, type STRING @SINCE_1_0.0
+ SCROLL_THRESHOLD, ///< name "scrollThreshold" Horizontal scrolling will occur if the cursor is this close to the control border, type FLOAT @SINCE_1_0.0
+ SCROLL_SPEED, ///< name "scrollSpeed" The scroll speed in pixels per second, type FLOAT @SINCE_1_0.0
+ SELECTION_HANDLE_IMAGE_LEFT, ///< name "selectionHandleImageLeft", The image to display for the left selection handle, type MAP @SINCE_1_0.0
+ SELECTION_HANDLE_IMAGE_RIGHT, ///< name "selectionHandleImageRight", The image to display for the right selection handle, type MAP @SINCE_1_0.0
+ SELECTION_HANDLE_PRESSED_IMAGE_LEFT, ///< name "selectionHandlePressedImageLeft", The image to display when the left selection handle is pressed, type MAP @SINCE_1_0.0
+ SELECTION_HANDLE_PRESSED_IMAGE_RIGHT, ///< name "selectionHandlePressedImageRight", The image to display when the right selection handle is pressed, type MAP @SINCE_1_0.0
+ SELECTION_HANDLE_MARKER_IMAGE_LEFT, ///< name "selectionHandleMarkerImageLeft", The image to display for the left selection handle marker, type MAP @SINCE_1_0.0
+ SELECTION_HANDLE_MARKER_IMAGE_RIGHT, ///< name "selectionHandleMarkerImageRight", The image to display for the right selection handle marker, type MAP @SINCE_1_0.0
+ SELECTION_HIGHLIGHT_COLOR, ///< name "selectionHighlightColor", The color of the selection highlight, type VECTOR4 @SINCE_1_0.0
+ DECORATION_BOUNDING_BOX, ///< name "decorationBoundingBox", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE @SINCE_1_0.0
+ INPUT_METHOD_SETTINGS, ///< name "inputMethodSettings", The settings to relating to the System's Input Method, Key and Value type MAP @SINCE_1_0.0
+ INPUT_COLOR, ///< name "inputColor", The color of the new input text, type VECTOR4 @SINCE_1_0.0
+ ENABLE_MARKUP, ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_0.0
+ INPUT_FONT_FAMILY, ///< name "inputFontFamily", The font's family of the new input text, type STRING @SINCE_1_0.0
+ INPUT_FONT_STYLE, ///< name "inputFontStyle", The font's style of the new input text, type STRING @SINCE_1_0.0
+ INPUT_POINT_SIZE ///< name "inputPointSize", The font's size of the new input text in points, type FLOAT @SINCE_1_0.0
};
};
* @brief Specifies how the text is truncated when it does not fit
*
* The default value is \e EXCEED_POLICY_CLIP.
+ * @SINCE_1_0.0
*/
enum ExceedPolicy
{
- EXCEED_POLICY_ORIGINAL, ///< The text will be display at original size, and may exceed the TextField boundary.
- EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField.
+ EXCEED_POLICY_ORIGINAL, ///< The text will be display at original size, and may exceed the TextField boundary. @SINCE_1_0.0
+ EXCEED_POLICY_CLIP ///< The end of text will be clipped to fit within the TextField. @SINCE_1_0.0
};
// Type Defs
/**
* @brief Create the TextField control.
+ * @SINCE_1_0.0
* @return A handle to the TextField control.
*/
static TextField New();
/**
* @brief Creates an empty handle.
+ * @SINCE_1_0.0
*/
TextField();
/**
* @brief Copy constructor.
*
+ * @SINCE_1_0.0
* @param[in] handle The handle to copy from.
*/
TextField( const TextField& handle );
/**
* @brief Assignment operator.
*
+ * @SINCE_1_0.0
* @param[in] handle The handle to copy from.
* @return A reference to this.
*/
* @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~TextField();
* If the BaseHandle points is a TextField the downcast returns a valid handle.
* If not the returned handle is left empty.
*
+ * @SINCE_1_0.0
* @param[in] handle Handle to an object.
* @return handle to a TextField or an empty handle.
*/
* @code
* void YourCallbackName( TextField textField );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
TextChangedSignalType& TextChangedSignal();
* @code
* void YourCallbackName( TextField textField );
* @endcode
+ * @SINCE_1_0.0
* @return The signal to connect to.
*/
MaxLengthReachedSignalType& MaxLengthReachedSignal();
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL TextField( Internal::TextField& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
* @brief A control which renders a short text string.
*
* Text labels are lightweight, non-editable and do not respond to user input.
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API TextLabel : public Control
{
/**
* @brief The start and end property ranges for this control.
+ * @SINCE_1_0.0
*/
enum PropertyRange
{
- PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
- PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices
+ PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
+ PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000 ///< Reserve property indices @SINCE_1_0.0
};
/**
* @brief An enumeration of properties belonging to the TextLabel class.
+ * @SINCE_1_0.0
*/
struct Property
{
enum
{
- RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT
- TEXT, ///< name "text", The text to display in UTF-8 format, type STRING
- FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING
- FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING
- POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT
- MULTI_LINE, ///< name "multiLine", The single-line or multi-line layout option, type BOOLEAN
- HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END"
- VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM"
- TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4
- SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2
- SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4
- UNDERLINE_ENABLED, ///< name "underlineEnabled", The underline enabled flag, type BOOLEAN
- UNDERLINE_COLOR, ///< name "underlineColor", The color of the underline, type VECTOR4
- UNDERLINE_HEIGHT, ///< name "underlineHeight", Overrides the underline height from font metrics, type FLOAT
- ENABLE_MARKUP ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN
+ RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "renderingBackend", The type or rendering e.g. bitmap-based, type INT @SINCE_1_0.0
+ TEXT, ///< name "text", The text to display in UTF-8 format, type STRING @SINCE_1_0.0
+ FONT_FAMILY, ///< name "fontFamily", The requested font family, type STRING @SINCE_1_0.0
+ FONT_STYLE, ///< name "fontStyle", The requested font style, type STRING @SINCE_1_0.0
+ POINT_SIZE, ///< name "pointSize", The size of font in points, type FLOAT @SINCE_1_0.0
+ MULTI_LINE, ///< name "multiLine", The single-line or multi-line layout option, type BOOLEAN @SINCE_1_0.0
+ HORIZONTAL_ALIGNMENT, ///< name "horizontalAlignment", The line horizontal alignment, type STRING, values "BEGIN", "CENTER", "END" @SINCE_1_0.0
+ VERTICAL_ALIGNMENT, ///< name "verticalAlignment", The line vertical alignment, type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0
+ TEXT_COLOR, ///< name "textColor", The text color, type VECTOR4 @SINCE_1_0.0
+ SHADOW_OFFSET, ///< name "shadowOffset", The drop shadow offset 0 indicates no shadow, type VECTOR2 @SINCE_1_0.0
+ SHADOW_COLOR, ///< name "shadowColor", The color of a drop shadow, type VECTOR4 @SINCE_1_0.0
+ UNDERLINE_ENABLED, ///< name "underlineEnabled", The underline enabled flag, type BOOLEAN @SINCE_1_0.0
+ UNDERLINE_COLOR, ///< name "underlineColor", The color of the underline, type VECTOR4 @SINCE_1_0.0
+ UNDERLINE_HEIGHT, ///< name "underlineHeight", Overrides the underline height from font metrics, type FLOAT @SINCE_1_0.0
+ ENABLE_MARKUP ///< name "enableMarkup", Whether the mark-up processing is enabled. type BOOLEAN @SINCE_1_0.0
};
};
/**
* @brief Create the TextLabel control.
*
+ * @SINCE_1_0.0
* @return A handle to the TextLabel control.
*/
static TextLabel New();
/**
* @brief Create the TextLabel control.
*
+ * @SINCE_1_0.0
* @param[in] text The text to display.
* @return A handle to the TextLabel control.
*/
/**
* @brief Creates an empty handle.
+ * @SINCE_1_0.0
*/
TextLabel();
/**
* @brief Copy constructor.
*
+ * @SINCE_1_0.0
* @param[in] handle The handle to copy from.
*/
TextLabel( const TextLabel& handle );
/**
* @brief Assignment operator.
*
+ * @SINCE_1_0.0
* @param[in] handle The handle to copy from.
* @return A reference to this.
*/
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~TextLabel();
* If the BaseHandle points is a TextLabel the downcast returns a valid handle.
* If not the returned handle is left empty.
*
+ * @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return handle to a TextLabel or an empty handle
*/
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
*
+ * @SINCE_1_0.0
* @param[in] implementation The Control implementation.
*/
DALI_INTERNAL TextLabel( Internal::TextLabel& implementation );
/**
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
+ * @SINCE_1_0.0
* @param[in] internal A pointer to the internal CustomActor.
*/
explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
{
/**
* @brief DALi Toolkit namespace.
+ * @SINCE_1_0.0
*/
namespace Toolkit
{
/**
* @brief Control Orientation namespace.
+ * @SINCE_1_0.0
*/
namespace ControlOrientation
{
/**
* @brief The internal orientation of a control.
+ * @SINCE_1_0.0
*/
enum Type
{
- Up, ///< The contents of control are in a vertical layout, from top to bottom
- Left, ///< The contents of control are in a horizontal layout, from left to right
- Down, ///< The contents of control are in a vertical layout, from bottom to top
- Right ///< The contents of control are in a horizontal layout, from right to left
+ Up, ///< The contents of control are in a vertical layout, from top to bottom @SINCE_1_0.0
+ Left, ///< The contents of control are in a horizontal layout, from left to right @SINCE_1_0.0
+ Down, ///< The contents of control are in a vertical layout, from bottom to top @SINCE_1_0.0
+ Right ///< The contents of control are in a horizontal layout, from right to left @SINCE_1_0.0
};
} // namespace ControlOrientation
/**
* @brief Query whether an orientation is horizontal.
*
+ * @SINCE_1_0.0
* @param[in] orientation The orientation.
* @return True if the orientation is horizontal.
*/
* | keyboardFocusChanged | @ref FocusChangedSignal() |
* | keyboardFocusGroupChanged | @ref FocusGroupChangedSignal() |
* | keyboardFocusedActorAenterKey | @ref FocusedActorEnterKeySignal() |
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API KeyboardFocusManager : public BaseHandle
{
* @brief Create a KeyboardFocusManager handle; this can be initialised with KeyboardFocusManager::New().
*
* Calling member functions with an uninitialised handle is not allowed.
+ * @SINCE_1_0.0
*/
KeyboardFocusManager();
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~KeyboardFocusManager();
/**
* @brief Get the singleton of KeyboardFocusManager object.
*
+ * @SINCE_1_0.0
* @return A handle to the KeyboardFocusManager control.
*/
static KeyboardFocusManager Get();
* Only one actor can be focused at the same time. The actor must
* be in the stage already and keyboard focusable.
*
- * @pre The KeyboardFocusManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be focused
* @return Whether the focus is successful or not
+ * @pre The KeyboardFocusManager has been initialized.
+ * @pre The Actor has been initialized.
*/
bool SetCurrentFocusActor(Actor actor);
/**
* @brief Get the current focused actor.
*
- * @pre The KeyboardFocusManager has been initialized.
+ * @SINCE_1_0.0
* @return A handle to the current focused actor or an empty handle if no actor is focused.
+ * @pre The KeyboardFocusManager has been initialized.
*/
Actor GetCurrentFocusActor();
* chain in the given direction (according to the focus traversal
* order).
*
- * @pre The KeyboardFocusManager has been initialized.
+ * @SINCE_1_0.0
* @param direction The direction of focus movement
* @return true if the movement was successful
+ * @pre The KeyboardFocusManager has been initialized.
*/
bool MoveFocus(Control::KeyboardFocus::Direction direction);
* that no actor is focused in the focus chain.
*
* It will emit focus changed signal without current focused actor
+ * @SINCE_1_0.0
* @pre The KeyboardFocusManager has been initialized.
*/
void ClearFocus();
* @brief Set whether the focus movement should be looped within the same focus group.
*
* The focus movement is not looped by default.
- * @pre The KeyboardFocusManager has been initialized.
+ * @SINCE_1_0.0
* @param enabled Whether the focus movement should be looped
+ * @pre The KeyboardFocusManager has been initialized.
*/
void SetFocusGroupLoop(bool enabled);
/**
* @brief Get whether the focus movement should be looped within the same focus group.
*
- * @pre The KeyboardFocusManager has been initialized.
+ * @SINCE_1_0.0
* @return Whether the focus movement should be looped
+ * @pre The KeyboardFocusManager has been initialized.
*/
bool GetFocusGroupLoop() const;
*
* Layout controls set themselves as focus groups by default.
*
- * @pre The KeyboardFocusManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be set as a focus group.
* @param isFocusGroup Whether to set the actor as a focus group or not.
+ * @pre The KeyboardFocusManager has been initialized.
+ * @pre The Actor has been initialized.
*/
void SetAsFocusGroup(Actor actor, bool isFocusGroup);
/**
* @brief Check whether the actor is set as a focus group or not.
*
- * @pre The KeyboardFocusManager has been initialized.
- * @pre The Actor has been initialized.
+ * @SINCE_1_0.0
* @param actor The actor to be checked.
* @return Whether the actor is set as a focus group.
+ * @pre The KeyboardFocusManager has been initialized.
+ * @pre The Actor has been initialized.
*/
bool IsFocusGroup(Actor actor) const;
/**
* @brief Returns the closest ancestor of the given actor that is a focus group.
*
+ * @SINCE_1_0.0
* @param actor The actor to be checked for its focus group
* @return The focus group the given actor belongs to or an empty handle if the given actor
* doesn't belong to any focus group
* KeyboardFocusManager and will be added to the focused actor as a
* highlight.
*
+ * @SINCE_1_0.0
+ * @param indicator The indicator actor to be added
* @pre The KeyboardFocusManager has been initialized.
* @pre The indicator actor has been initialized.
- * @param indicator The indicator actor to be added
*/
void SetFocusIndicatorActor(Actor indicator);
/**
* @brief Get the focus indicator actor.
*
- * @pre The KeyboardFocusManager has been initialized.
+ * @SINCE_1_0.0
* @return A handle to the focus indicator actor
+ * @pre The KeyboardFocusManager has been initialized.
*/
Actor GetFocusIndicatorActor();
* @code
* Actor YourCallbackName(Actor currentFocusedActor, Actor proposedActorToFocus, Control::KeyboardFocus::Direction direction);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
PreFocusChangeSignalType& PreFocusChangeSignal();
* @code
* void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
FocusChangedSignalType& FocusChangedSignal();
* @code
* void YourCallbackName(Actor currentFocusedActor, bool forward);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
FocusGroupChangedSignalType& FocusGroupChangedSignal();
* @code
* void YourCallbackName(Actor enterPressedActor);
* @endcode
- * @pre The Object has been initialized.
+ * @SINCE_1_0.0
* @return The signal to connect to.
+ * @pre The Object has been initialized.
*/
FocusedActorEnterKeySignalType& FocusedActorEnterKeySignal();
/**
* @brief Creates a new handle from the implementation.
*
+ * @SINCE_1_0.0
* @param[in] impl A pointer to the object.
*/
explicit DALI_INTERNAL KeyboardFocusManager(Internal::KeyboardFocusManager *impl);
// The type of text renderer required
enum RenderingType
{
- RENDERING_SHARED_ATLAS ///< A bitmap-based solution where renderers can share a texture atlas
+ RENDERING_SHARED_ATLAS ///< A bitmap-based solution where renderers can share a texture atlas @SINCE_1_0.0
};
const unsigned int DEFAULT_RENDERING_BACKEND = RENDERING_SHARED_ATLAS;
projects / platform / core / uifw / dali-toolkit.git / commitdiff