- For document public release, Native API reference is checked by Lionbridge.
Change-Id: I78cad260974f386ceeeb1fbc8774815be2213457
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>
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.
+ * @brief Enumeration for accessibility that needs four information which will be read by screen-reader.
*
* Reading order : Label -> Trait -> Optional (Value and Hint)
* @SINCE_1_0.0
};
/**
- * @brief Overshoot direction.
+ * @brief Enumeration for overshoot direction.
* @SINCE_1_0.0
*/
enum FocusOvershotDirection
typedef Signal< void ( Actor ) > FocusedActorActivatedSignalType;
/**
- * @brief Create a AccessibilityManager handle; this can be initialised with AccessibilityManager::New().
+ * @brief Creates an AccessibilityManager handle; this can be initialised with AccessibilityManager::New().
*
- * Calling member functions with an uninitialised handle is not allowed.
+ * Calling member functions with an uninitialized handle is not allowed.
* @SINCE_1_0.0
*/
AccessibilityManager();
/**
- * @brief Destructor
+ * @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.
+ * @brief Gets the singleton of AccessibilityManager object.
*
* @SINCE_1_0.0
- * @return A handle to the AccessibilityManager control.
+ * @return A handle to the AccessibilityManager control
*/
static AccessibilityManager Get();
/**
- * @brief Set the information of the specified actor's accessibility attribute.
+ * @brief Sets the information of the specified actor's accessibility attribute.
*
* @SINCE_1_0.0
- * @param actor The actor the text to be set with
+ * @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.
void SetAccessibilityAttribute(Actor actor, AccessibilityAttribute type, const std::string& text);
/**
- * @brief Get the text of the specified actor's accessibility attribute.
+ * @brief Gets the text of the specified actor's accessibility attribute.
*
* @SINCE_1_0.0
* @param actor The actor to be queried
std::string GetAccessibilityAttribute(Actor actor, AccessibilityAttribute type) const;
/**
- * @brief Set the focus order of the actor.
+ * @brief Sets the focus order of the actor.
*
- * The focus order of each actor in the focus chain is unique. If
- * there is another actor assigned with the same focus order
+ * The focus order of each actor in the focus chain is unique.
+ * If there is another actor assigned with the same focus order
* already, the new actor will be inserted to the focus chain with
* that focus order, and the focus order of the original actor and
* all the actors followed in the focus chain will be increased
void SetFocusOrder(Actor actor, const unsigned int order);
/**
- * @brief Get the focus order of the actor.
+ * @brief Gets the focus order of the actor.
*
* When the focus order is 0, it means the focus order of the actor
* is undefined.
unsigned int GenerateNewFocusOrder() const;
/**
- * @brief Get the actor that has the specified focus order.
+ * @brief Gets the actor that has the specified focus order.
*
* It will return an empty handle if no actor in the stage
* has the specified focus order.
* @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.
+ * handle if no actor in the stage has the specified focus order
* @pre The AccessibilityManager has been initialized.
*/
Actor GetActorByFocusOrder(const unsigned int order);
/**
- * @brief Move the focus to the specified actor.
+ * @brief Moves the focus to the specified actor.
*
- * Only one actor can be focused at the same time. The actor must
+ * Only one actor can be focused at the same time. The actor must
* have a defined focus order and must be focusable, visible and in
* the stage.
*
bool SetCurrentFocusActor(Actor actor);
/**
- * @brief Get the current focused actor.
+ * @brief Gets the current focused actor.
*
* @SINCE_1_0.0
- * @return A handle to the current focused actor or an empty handle if no actor is focused.
+ * @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.
+ * @brief Gets the focus group of current focused actor.
*
* @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.
+ * is focused
* @pre The AccessibilityManager has been initialized.
*
*/
Actor GetCurrentFocusGroup();
/**
- * @brief Get the focus order of currently focused actor.
+ * @brief Gets the focus order of currently focused actor.
* @SINCE_1_0.0
* @return The focus order of the currently focused actor or 0 if no
- * actor is in focus.
+ * actor is in focus
* @pre The AccessibilityManager has been initialized.
*
*/
unsigned int GetCurrentFocusOrder();
/**
- * @brief Move the focus to the next focusable actor in the focus
+ * @brief Moves the focus to the next focusable actor in the focus
* chain (according to the focus traversal order).
*
* When the focus movement is wrapped around, the focus will be moved
bool MoveFocusForward();
/**
- * @brief Move the focus to the previous focusable actor in the
+ * @brief Moves the focus to the previous focusable actor in the
* focus chain (according to the focus traversal order).
*
* When the focus movement is wrapped around, the focus will be
bool MoveFocusBackward();
/**
- * @brief Clear the focus from the current focused actor if any, so
+ * @brief Clears the focus from the current focused actor if any, so
* that no actor is focused in the focus chain.
*
* It will emit focus changed signal without current focused actor.
void ClearFocus();
/**
- * @brief Clear the every registered focusable actor from focus-manager.
+ * @brief Clears 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
+ * @brief Sets whether an actor is a focus group that can limit the
* scope of focus movement to its child actors in the focus chain.
*
* @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.
+ * @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.
+ * @brief Checks whether the actor is set as a focus group or not.
*
* @SINCE_1_0.0
- * @param actor The actor to be checked.
- * @return Whether the actor is set as a focus group.
+ * @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;
/**
- * @brief Set whether the group mode is enabled or not.
+ * @brief Sets whether the group mode is enabled or not.
*
* 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.
+ * group is the closest ancestor of the current focused actor that is set as a focus group.
* @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.
+ * @brief Gets whether the group mode is enabled or not.
*
* @SINCE_1_0.0
* @return Whether the group mode is enabled or not.
bool GetGroupMode() const;
/**
- * @brief Set whether focus will be moved to the beginning of the
+ * @brief Sets whether focus will be moved to the beginning of the
* focus chain when it reaches the end or vice versa.
*
* When both the wrap mode and the group mode are enabled, focus will be
void SetWrapMode(bool wrapped);
/**
- * @brief Get whether the wrap mode is enabled or not.
+ * @brief Gets whether the wrap mode is enabled or not.
*
* @SINCE_1_0.0
* @return Whether the wrap mode is enabled or not.
bool GetWrapMode() const;
/**
- * @brief Set the focus indicator actor.
+ * @brief Sets the focus indicator actor.
*
* This will replace the default focus indicator actor in
* AccessibilityManager and will be added to the focused actor as a
void SetFocusIndicatorActor(Actor indicator);
/**
- * @brief Get the focus indicator actor.
+ * @brief Gets the focus indicator actor.
*
* @SINCE_1_0.0
* @return A handle to the focus indicator actor
/**
* @brief Returns the current position of the read action.
* @SINCE_1_0.0
- * @return The current event position.
+ * @return The current event position
*/
Vector2 GetReadPosition() const;
* void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
FocusChangedSignalType& FocusChangedSignal();
* void YourCallbackName(Actor currentFocusedActor, FocusOvershotDirection direction);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
FocusOvershotSignalType& FocusOvershotSignal();
* void YourCallbackName(Actor activatedActor);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
FocusedActorActivatedSignalType& FocusedActorActivatedSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& StatusChangedSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionNextSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionPreviousSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionActivateSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionReadSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionOverSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionReadNextSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionReadPreviousSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionUpSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionDownSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionClearFocusSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionBackSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionScrollUpSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionScrollDownSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionPageLeftSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionPageRightSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionPageUpSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionPageDownSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionMoveToFirstSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionMoveToLastSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionReadFromNextSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionZoomSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionReadIndicatorInformationSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionReadPauseResumeSignal();
* bool YourCallback( AccessibilityManager& manager );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
AccessibilityActionSignalType& ActionStartStopSignal();
* bool YourCallback( AccessibilityManager& manager, const TouchEvent& event );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @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.
+ * Additionally, 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
+ * 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
* different than ScaleNone, constraints as well.
*/
class DALI_IMPORT_API Alignment : public Control
{
public:
/**
- * @brief Different types of alignment.
+ * @brief Enumeration for different types of alignment.
* @SINCE_1_0.0
*/
enum Type
};
/**
- * @brief Scaling determines how actors are scaled, to match the alignment's boundary.
+ * @brief Scaling determines how actors are scaled to match the alignment's boundary.
* @SINCE_1_0.0
*/
enum Scaling
struct Padding
{
/**
- * @brief Constructor
+ * @brief Constructor.
* @SINCE_1_0.0
*/
Padding()
}
/**
- * @brief Constructor
+ * @brief Constructor.
*
* @SINCE_1_0.0
* @param[in] l Left padding
};
/**
- * @brief Create an Alignment handle; this can be initialised with Alignment::New().
+ * @brief Creates an Alignment handle; this can be initialized with Alignment::New().
*
- * Calling member functions with an uninitialised handle is not allowed.
+ * Calling member functions with an uninitialized 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.
+ * @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
*/
static Alignment New( Type horizontal = HorizontalCenter, Type vertical = VerticalCenter );
* @brief Copy constructor. Creates another handle that points to the same real object.
*
* @SINCE_1_0.0
- * @param[in] alignment Object to copy.
+ * @param[in] alignment Object to copy
*/
Alignment(const Alignment& alignment);
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~Alignment();
/**
- * @brief Downcast a handle to Alignment handle.
+ * @brief Downcasts a handle to Alignment handle.
*
- * If handle points to a Alignment the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If handle points to an 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
static Alignment DownCast( BaseHandle handle );
/**
- * @brief Sets the new alignment. By default ( HorizontalCenter | VerticalCenter ).
+ * @brief Sets the new alignment. By default, ( HorizontalCenter | VerticalCenter ).
*
* @SINCE_1_0.0
- * @param [in] type The new alignment option.
+ * @param[in] type The new alignment option
* @note There should only be one horizontal and one vertical policy.
*/
void SetAlignmentType( Type type );
/**
- * @brief Get the current alignment combined into a single value.
+ * @brief Gets the current alignment combined into a single value.
*
* The values can be tested by using the & operator and the desired
* flag. e.g.
* @endcode
*
* @SINCE_1_0.0
- * @return the alignment value.
+ * @return the alignment value
*/
Type GetAlignmentType() const;
* @brief Sets how added actors scale to fit the alignment's boundary.
*
* @SINCE_1_0.0
- * @param[in] scaling The scaling property.
+ * @param[in] scaling The scaling property
* @see Scaling.
*/
void SetScaling( Scaling scaling );
* @brief Retrieves the scaling property.
*
* @SINCE_1_0.0
- * @return The scaling.
+ * @return The scaling
* @see Scaling.
*/
Scaling GetScaling() const;
/**
- * @brief Set a padding value.
+ * @brief Sets a padding value.
*
* @SINCE_1_0.0
- * @param [in] padding The left, right, top, bottom padding values.
+ * @param[in] padding The left, right, top, bottom padding values
*/
void SetPadding( const Padding& padding );
/**
- * @brief Get the padding values.
+ * @brief Gets the padding values.
*
* @SINCE_1_0.0
- * @return The left, right, top, bottom padding values.
+ * @return The left, right, top, bottom padding values
*/
const Padding& GetPadding() const;
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal );
/// @endcond
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the Button class.
+ * @brief Enumeration for the instance of properties belonging to the Button class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Button class.
+ * @brief Enumeration for the instance of properties belonging to the Button class.
* @SINCE_1_0.0
*/
enum
public:
/**
- * @brief Create an uninitialized Button.
+ * @brief Creates an uninitialized Button.
*
* Only derived versions can be instantiated. Calling member
* functions with an uninitialized Dali::Object is not allowed.
Button& operator=( const Button& button );
/**
- * @brief Downcast a handle to Button handle.
+ * @brief Downcasts a handle to Button handle.
*
- * If handle points to a Button the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
static Button DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* No signals are emitted when the \e disabled property is set.
*
* @SINCE_1_0.0
- * @param[in] disabled property.
+ * @param[in] disabled Disabled property
*/
void SetDisabled( bool disabled ) DALI_DEPRECATED_API;
*
* @brief Returns if the button is disabled.
* @SINCE_1_0.0
- * @return \e true if the button is \e disabled.
+ * @return \e true if the button is \e disabled
*/
bool IsDisabled() const DALI_DEPRECATED_API;
* but no signal is emitted.
*
* @SINCE_1_0.0
- * @param[in] autoRepeating \e autorepeating property.
+ * @param[in] autoRepeating \e autorepeating property
*/
void SetAutoRepeating( bool autoRepeating ) DALI_DEPRECATED_API;
*
* @brief Returns if the autorepeating property is set.
* @SINCE_1_0.0
- * @return \e true if the \e autorepeating property is set.
+ * @return \e true if the \e autorepeating property is set
*/
bool IsAutoRepeating() const DALI_DEPRECATED_API;
*
* @brief Sets the initial autorepeating delay.
*
- * By default this value is set to 0.15 seconds.
+ * By default, this value is set to 0.15 seconds.
*
* @SINCE_1_0.0
- * @param[in] initialAutoRepeatingDelay in seconds.
+ * @param[in] initialAutoRepeatingDelay in seconds
* @pre initialAutoRepeatingDelay must be greater than zero.
*/
void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay ) DALI_DEPRECATED_API;
*
* @brief Gets the initial autorepeating delay in seconds.
* @SINCE_1_0.0
- * @return the initial autorepeating delay in seconds.
+ * @return The initial autorepeating delay in seconds
*/
float GetInitialAutoRepeatingDelay() const DALI_DEPRECATED_API;
*
* @brief Sets the next autorepeating delay.
*
- * By default this value is set to 0.05 seconds.
+ * By default, this value is set to 0.05 seconds.
*
* @SINCE_1_0.0
- * @param[in] nextAutoRepeatingDelay in seconds.
+ * @param[in] nextAutoRepeatingDelay in seconds
* @pre nextAutoRepeatingDelay must be greater than zero.
*/
void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay ) DALI_DEPRECATED_API;
*
* @brief Gets the next autorepeating delay in seconds.
* @SINCE_1_0.0
- * @return the next autorepeating delay in seconds.
+ * @return The next autorepeating delay in seconds
*/
float GetNextAutoRepeatingDelay() const DALI_DEPRECATED_API;
* 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.
+ * @param[in] togglable Togglable property
*/
void SetTogglableButton( bool togglable ) DALI_DEPRECATED_API;
*
* @brief Returns if the togglable property is set.
* @SINCE_1_0.0
- * @return \e true if the \e togglable property is set.
+ * @return \e true if the \e togglable property is set
*/
bool IsTogglableButton() const DALI_DEPRECATED_API;
* Emits a Button::StateChangedSignal() signal.
*
* @SINCE_1_0.0
- * @param[in] selected property.
+ * @param[in] selected Selected property
*/
void SetSelected( bool selected ) DALI_DEPRECATED_API;
*
* @brief Returns if the selected property is set and the button is togglable.
* @SINCE_1_0.0
- * @return \e true if the button is \e selected.
+ * @return \e true if the button is \e selected
*/
bool IsSelected() const DALI_DEPRECATED_API;
* @brief Sets the animation time.
*
* @SINCE_1_0.0
- * @param[in] animationTime The animation time in seconds.
+ * @param[in] animationTime The animation time in seconds
*/
void SetAnimationTime( float animationTime ) DALI_DEPRECATED_API;
* @brief Retrieves button's animation time.
*
* @SINCE_1_0.0
- * @return The animation time in seconds.
+ * @return The animation time in seconds
*/
float GetAnimationTime() const DALI_DEPRECATED_API;
* @brief Sets the button's label.
*
* @SINCE_1_0.0
- * @param[in] label The label text.
+ * @param[in] label The label text
*/
void SetLabelText( const std::string& label ) DALI_DEPRECATED_API;
* @brief Gets the label.
*
* @SINCE_1_0.0
- * @return The label text.
+ * @return The label text
*/
std::string GetLabelText() const DALI_DEPRECATED_API;
* @brief Sets the unselected button image.
*
* @SINCE_1_0.0
- * @param[in] filename The button image.
+ * @param[in] filename The button image
*/
void SetUnselectedImage( const std::string& filename ) DALI_DEPRECATED_API;
* @brief Sets the background image.
*
* @SINCE_1_0.0
- * @param[in] filename The background image.
+ * @param[in] filename The background image
*/
void SetBackgroundImage( const std::string& filename ) DALI_DEPRECATED_API;
* @brief Sets the selected image.
*
* @SINCE_1_0.0
- * @param[in] filename The selected image.
+ * @param[in] filename The selected image
*/
void SetSelectedImage( const std::string& filename ) DALI_DEPRECATED_API;
* @brief Sets the selected background image.
*
* @SINCE_1_0.0
- * @param[in] filename The selected background image.
+ * @param[in] filename The selected background image
*/
void SetSelectedBackgroundImage( const std::string& filename ) DALI_DEPRECATED_API;
* @brief Sets the disabled background image.
*
* @SINCE_1_0.0
- * @param[in] filename The disabled background image.
+ * @param[in] filename The disabled background image
*/
void SetDisabledBackgroundImage( const std::string& filename ) DALI_DEPRECATED_API;
* @brief Sets the disabled button image.
*
* @SINCE_1_0.0
- * @param[in] filename The disabled button image.
+ * @param[in] filename The disabled button image
*/
void SetDisabledImage( const std::string& filename ) DALI_DEPRECATED_API;
* @brief Sets the disabled selected button image.
*
* @SINCE_1_0.0
- * @param[in] filename The disabled selected button image.
+ * @param[in] filename The disabled selected button image
*/
void SetDisabledSelectedImage( const std::string& filename ) DALI_DEPRECATED_API;
/**
- * @DEPRECATED_1_0.50. Instead, use SetLabelText.
+ * @DEPRECATED_1_0.50. Instead, use SetLabelText
*
* @brief Sets the label with an actor.
*
* @SINCE_1_0.0
- * @param[in] label The actor to use as a label
+ * @param[in] label The actor to use as a label
*/
void SetLabel( Actor label ) DALI_DEPRECATED_API;
* @brief Sets the button image.
*
* @SINCE_1_0.0
- * @param[in] image The button image.
+ * @param[in] image The button image
*/
void SetButtonImage( Image image ) DALI_DEPRECATED_API;
* @brief Sets the selected image.
*
* @SINCE_1_0.0
- * @param[in] image The selected image.
+ * @param[in] image The selected image
*/
void SetSelectedImage( Image image ) DALI_DEPRECATED_API;
*
* @SINCE_1_0.0
* @remarks Avoid using this method as it's a legacy code.
- * @return An actor with the button image.
+ * @return An actor with the button image
*/
Actor GetButtonImage() const DALI_DEPRECATED_API;
*
* @SINCE_1_0.0
* @remarks Avoid using this method as it's a legacy code.
- * @return An actor with the selected image.
+ * @return An actor with the selected image
*/
Actor GetSelectedImage() const DALI_DEPRECATED_API;
public: //Signals
/**
- * @brief Button signal type
+ * @brief Button signal type.
* @SINCE_1_0.0
*/
typedef Signal< bool ( Button ) > ButtonSignalType;
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& PressedSignal();
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& ReleasedSignal();
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
ButtonSignalType& ClickedSignal();
* bool YourCallbackName( Button button );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @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.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL Button( Dali::Internal::CustomActor* internal );
/// @endcond
/**
* @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.
+ * By default, a CheckBoxButton emits a Button::ClickedSignal() signal when the button changes its state to selected or unselected.
*
* The button's appearance could be modified by Button::SetUnselectedImage, Button::SetBackgroundImage,
* Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
public:
/**
- * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
+ * @brief Creates 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& operator=( const CheckBoxButton& checkBox );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~CheckBoxButton();
/**
- * @brief Create an initialized CheckBoxButton.
+ * @brief Creates an initialized CheckBoxButton.
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static CheckBoxButton New();
/**
- * @brief Downcast a handle to CheckBoxButton handle.
+ * @brief Downcasts a handle to CheckBoxButton handle.
*
- * If handle points to a CheckBoxButton the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * 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
+ * @return Handle to a CheckBoxButton or an uninitialized handle
*/
static CheckBoxButton DownCast( BaseHandle handle );
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL CheckBoxButton( Internal::CheckBoxButton& 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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL CheckBoxButton( Dali::Internal::CustomActor* internal );
/// @endcond
/**
* @brief A PushButton changes its appearance when is pressed and returns to its original when is released.
*
- * By default a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked
+ * By default, a PushButton emits a Button::PressedSignal() signal when the button is pressed, a Button::ClickedSignal() signal when it's clicked.
* and a Button::ReleasedSignal() signal when it's released or having pressed it, the touch point leaves the boundary of the button.
*
* Usage example: -
* }
* @endcode
*
- * See Button for more detail on signals and modifying appearance via properties.
+ * See Button for more details on signals and modifying appearance via properties.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API PushButton : public Button
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the PushButton class.
+ * @brief Enumeration for the instance of properties belonging to the PushButton class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the PushButton class.
+ * @brief Enumeration for the instance of properties belonging to the PushButton class.
* @SINCE_1_0.0
*/
enum
public:
/**
- * @brief Create an uninitialized PushButton; this can be initialized with PushButton::New().
+ * @brief Creates 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& operator=( const PushButton& pushButton );
/**
- * @brief Destructor
+ * @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.
+ * @brief Creates an initialized PushButton.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static PushButton New();
/**
- * @brief Downcast a handle to PushButton handle.
+ * @brief Downcasts a handle to PushButton handle.
*
- * If handle points to a PushButton the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
* @brief Sets the unselected image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetButtonImage( Actor image ) DALI_DEPRECATED_API;
* @brief Sets the background image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetBackgroundImage( Actor image ) DALI_DEPRECATED_API;
* @brief Sets the selected image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetSelectedImage( Actor image ) DALI_DEPRECATED_API;
* @brief Sets the selected background image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetSelectedBackgroundImage( Actor image ) DALI_DEPRECATED_API;
* @brief Sets the disabled background image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetDisabledBackgroundImage( Actor image ) DALI_DEPRECATED_API;
* @brief Sets the disabled image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetDisabledImage( Actor image ) DALI_DEPRECATED_API;
* @brief Sets the disabled selected image with an Actor.
*
* @SINCE_1_0.0
- * @param[in] image The Actor to use.
+ * @param[in] image The Actor to use
*/
void SetDisabledSelectedImage( Actor image ) DALI_DEPRECATED_API;
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL PushButton( Dali::Internal::CustomActor* internal );
/// @endcond
* Usage example: -
*
* @code
- * // in Creating a DALi Application
+ * // In Creating a DALi Application
*
* // Create a group to bind two or more RadioButtons together
* Actor radioGroup = Actor::New();
{
public:
/**
- * @brief Create an uninitialized RadioButton; this can be initialized with RadioButton::New().
+ * @brief Creates 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& operator=( const RadioButton& radioButton );
/**
- * @brief Destructor
+ * @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.
+ * @brief Creates an initialized RadioButton.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static RadioButton New();
/**
- * @brief Create an initialized RadioButton with given label.
+ * @brief Creates 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.
+ * @param[in] label The button label
+ * @return A handle to a newly allocated Dali resource
*/
static RadioButton New( const std::string& label );
/**
- * @brief Downcast a handle to RadioButton handle.
+ * @brief Downcasts a handle to RadioButton handle.
*
- * If handle points to a RadioButton the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL RadioButton( Dali::Internal::CustomActor* internal );
/// @endcond
// Creation & Destruction
/**
- * @brief Create a new ControlImpl instance that does not require touch by default.
+ * @brief Creates 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.
+ * 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.
+ * @return A handle to the ControlImpl instance
*/
static Toolkit::Control New();
void SetBackgroundImage( Image image );
/**
- * @brief Set the background with a property map.
+ * @brief Sets the background with a property map.
*
* @SINCE_1_0.0
- * @param[in] map The background property map.
+ * @param[in] map The background property map
*/
void SetBackground(const Property::Map& map);
* EnableGestureDetection(Gesture::Type(Gesture::Pinch | Gesture::Tap | Gesture::Pan));
* @endcode
* @SINCE_1_0.0
- * @param[in] type The gesture type(s) to enable.
+ * @param[in] type The gesture type(s) to enable
*/
void EnableGestureDetection( Gesture::Type type );
*
* Like EnableGestureDetection, this can also be called using bitwise or.
* @SINCE_1_0.0
- * @param[in] type The gesture type(s) to disable.
+ * @param[in] type The gesture type(s) to disable
* @see EnableGetureDetection
*/
void DisableGestureDetection( Gesture::Type type );
/**
* @brief If deriving classes wish to fine tune pinch gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
* @SINCE_1_0.0
- * @return The pinch gesture detector.
+ * @return The pinch gesture detector
* @pre Pinch detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
/**
* @brief If deriving classes wish to fine tune pan gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
* @SINCE_1_0.0
- * @return The pan gesture detector.
+ * @return The pan gesture detector
* @pre Pan detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
/**
* @brief If deriving classes wish to fine tune tap gesture
- * detection then they can access the gesture detector through this
+ * detection, then they can access the gesture detector through this
* API and modify the detection.
*
* @SINCE_1_0.0
- * @return The tap gesture detector.
+ * @return The tap gesture detector
* @pre Tap detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
/**
* @brief If deriving classes wish to fine tune long press gesture
- * detection then they can access the gesture detector through this
+ * 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.
+ * @return The long press gesture detector
* @pre Long press detection should have been enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
*
* The control doesn't support it by default.
* @SINCE_1_0.0
- * @param[in] isSupported Whether this control supports two dimensional keyboard navigation.
+ * @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.
+ * @return true if this control supports two dimensional keyboard navigation
*/
bool IsKeyboardNavigationSupported();
* @brief Sets whether this control is a focus group for keyboard navigation.
*
* (i.e. the scope of keyboard focus movement
- * can be limitied to its child actors). The control is not a focus group by default.
+ * can be limited 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.
+ * @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.
+ * @return true if this control is set as a focus group for keyboard navigation
*/
bool IsKeyboardFocusGroup();
* @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.
+ * @param[in] event The key event
+ * @return True if the event was consumed
*/
DALI_INTERNAL bool EmitKeyEventSignal( const KeyEvent& event );
/// @endcond
Dali::Animation CreateTransition( const Toolkit::TransitionData& transitionData );
/**
- * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal
+ * @brief Emits KeyInputFocusGained signal if true else emits KeyInputFocusLost signal.
*
* Should be called last by the control after it acts on the Input Focus change.
*
// Construction
/**
- * @brief Flags for the constructor
+ * @brief Flags for the constructor.
* @SINCE_1_0.0
*/
enum ControlBehaviour
static const int CONTROL_BEHAVIOUR_FLAG_COUNT = Log< LAST_CONTROL_BEHAVIOUR_FLAG - 1 >::value + 1; ///< Total count of flags
/**
- * @brief Control constructor
+ * @brief Control constructor.
*
* @SINCE_1_0.0
* @param[in] behaviourFlags Behavioural flags from ControlBehaviour enum
* Could be overridden by derived classes.
*
* @SINCE_1_0.0
- * @param[in] child The added actor.
+ * @param[in] child The added actor
*/
virtual void OnControlChildAdd( Actor& child ) DALI_DEPRECATED_API;
* Could be overridden by derived classes.
*
* @SINCE_1_0.0
- * @param[in] child The removed actor.
+ * @param[in] child The removed actor
*/
virtual void OnControlChildRemove( Actor& child ) DALI_DEPRECATED_API;
* @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.
+ * @param[in] styleManager The StyleManager object
+ * @param[in] change Information denoting what has changed
*/
virtual void OnStyleChange( Toolkit::StyleManager styleManager, StyleChange::Type change );
*
* Derived classes should override this to perform custom accessibility activation.
* @SINCE_1_0.0
- * @return true if this control can perform accessibility activation.
+ * @return true if this control can perform accessibility activation
*/
virtual bool OnAccessibilityActivated();
* pan gesture.
*
* @SINCE_1_0.0
- * @param[in] gesture The pan gesture.
+ * @param[in] gesture The pan gesture
* @return true if the pan gesture has been consumed by this control
*/
virtual bool OnAccessibilityPan( PanGesture gesture );
* touch event.
*
* @SINCE_1_0.0
- * @param[in] touchEvent The touch event.
+ * @param[in] touchEvent The touch event
* @return true if the touch event has been consumed by this control
*/
virtual bool OnAccessibilityTouch( const TouchEvent& touchEvent );
*
* 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.
- * @return the next keyboard focusable actor in this control or an empty handle if no actor can be focused.
+ * @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
+ * @return The next keyboard focusable actor in this control or an empty handle if no actor can be focused
*/
virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
/**
* @brief Informs this control that its chosen focusable actor will be focused.
*
- * This allows the application to preform any actions if wishes
+ * This allows the application to perform 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.
+ * @param[in] commitedFocusableActor The commited focusable actor
*/
virtual void OnKeyboardFocusChangeCommitted( Actor commitedFocusableActor );
*
* Derived classes should override this to perform custom actions.
* @SINCE_1_0.0
- * @return true if this control supported this action.
+ * @return true if this control supported this action
*/
virtual bool OnKeyboardEnter();
* pinch scale.
*
* @SINCE_1_0.0
- * @param[in] pinch The pinch gesture.
- * @note If overridden, then the default behaviour will not occur.
+ * @param[in] pinch The pinch gesture
+ * @note If overridden, then the default behavior will not occur.
* @note Pinch detection should be enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
* is enabled.
*
* @SINCE_1_0.0
- * @param[in] pan The pan gesture.
- * @note There is no default behaviour with panning.
+ * @param[in] pan The pan gesture
+ * @note There is no default behavior with panning.
* @note Pan detection should be enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
* is enabled.
*
* @SINCE_1_0.0
- * @param[in] tap The tap gesture.
- * @note There is no default behaviour with a tap.
+ * @param[in] tap The tap gesture
+ * @note There is no default behavior with a tap.
* @note Tap detection should be enabled via EnableGestureDetection().
* @see EnableGestureDetection
*/
* detection is enabled.
*
* @SINCE_1_0.0
- * @param[in] longPress The long press gesture.
+ * @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().
* @see EnableGestureDetection
virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
/**
- * @brief Retrieve the extension for this control
+ * @brief Retrieves the extension for this control.
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
};
/**
- * @brief Get implementation from the handle.
+ * @brief Gets implementation from the handle.
*
* @SINCE_1_0.0
* @param handle
- * @return implementation
+ * @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.
+ * @brief Gets implementation from the handle.
*
* @SINCE_1_0.0
* @param handle
- * @return implementation
- * @pre handle is initialized and points to a control
+ * @return Implementation
+ * @pre Handle is initialized and points to a control.
*/
DALI_IMPORT_API const Internal::Control& GetImplementation( const Dali::Toolkit::Control& handle );
public:
/**
- * @brief The start and end property ranges for control.
+ * @brief Enumeration for the start and end property ranges for control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the Control class.
+ * @brief Enumeration for the instance of properties belonging to the Control class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Control class.
+ * @brief Enumeration for the instance of properties belonging to the Control class.
* @SINCE_1_0.0
*/
enum
{
/**
- * @brief name "styleName", type std::string
+ * @brief name "styleName", type std::string.
* @SINCE_1_0.0
* @see SetStyleName
*/
STYLE_NAME = PROPERTY_START_INDEX,
/**
* @DEPRECATED_1_1.3
- * @brief name "backgroundColor", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4
+ * @brief name "backgroundColor", mutually exclusive with BACKGROUND_IMAGE & BACKGROUND, type Vector4.
* @SINCE_1_0.0
* @see SetStyleName
*/
BACKGROUND_COLOR,
/**
* @DEPRECATED_1_1.3
- * @brief name "backgroundImage", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map
+ * @brief name "backgroundImage", mutually exclusive with BACKGROUND_COLOR & BACKGROUND, type Map.
* @SINCE_1_0.0
*/
BACKGROUND_IMAGE,
/**
- * @brief name "keyInputFocus", type bool
+ * @brief name "keyInputFocus", type bool.
* @SINCE_1_0.0
* @see SetKeyInputFocus
*/
KEY_INPUT_FOCUS,
/**
- * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL
+ * @brief name "background", mutually exclusive with BACKGROUND_COLOR & BACKGROUND_IMAGE, type Map or std::string for URL.
* @SINCE_1_1.3
*/
BACKGROUND,
struct KeyboardFocus
{
/**
- * @brief Keyboard focus direction
+ * @brief Keyboard focus direction.
* @SINCE_1_0.0
*/
enum Direction
public: // Creation & Destruction
/**
- * @brief Create a new instance of a Control.
+ * @brief Creates a new instance of a Control.
*
* @SINCE_1_0.0
- * @return A handle to a new Control.
+ * @return A handle to a new Control
*/
static Control New();
/**
- * @brief Create an uninitialized Control handle.
+ * @brief Creates an uninitialized Control handle.
*
* Only derived versions can be instantiated. Calling member
* functions with an uninitialized Dali::Object is not allowed.
* 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
+ * @return Reference to this
*/
Control& operator=( const Control& handle );
public:
/**
- * @brief Downcast a handle to Control handle.
+ * @brief Downcasts a handle to Control handle.
*
- * If handle points to a Control the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
* As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
* unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
* controls above it in the focus stack.
- * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
+ * To query for the control which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
*/
bool HasKeyInputFocus();
* @brief Retrieves the pinch gesture detector of the control.
*
* @SINCE_1_0.0
- * @return The pinch gesture detector.
+ * @return The pinch gesture detector
* @note Will return an empty handle if the control does not handle the gesture itself.
*/
PinchGestureDetector GetPinchGestureDetector() const;
* @brief Retrieves the pan gesture detector of the control.
*
* @SINCE_1_0.0
- * @return The pan gesture detector.
+ * @return The pan gesture detector
* @note Will return an empty handle if the control does not handle the gesture itself.
*/
PanGestureDetector GetPanGestureDetector() const;
* @brief Retrieves the tap gesture detector of the control.
*
* @SINCE_1_0.0
- * @return The tap gesture detector.
+ * @return The tap gesture detector
* @note Will return an empty handle if the control does not handle the gesture itself.
*/
TapGestureDetector GetTapGestureDetector() const;
* @brief Retrieves the long press gesture detector of the control.
*
* @SINCE_1_0.0
- * @return The long press gesture detector.
+ * @return The long press gesture detector
* @note Will return an empty handle if the control does not handle the gesture itself.
*/
LongPressGestureDetector GetLongPressGestureDetector() const;
* @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.
+ * @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.
+ * @return A string matching a style, or an empty string
*/
const std::string& GetStyleName() const;
* @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 If SetBackgroundImage is called later, this background color is removed.
*
* @note The background color fully blends with the actor color.
*/
* @brief Retrieves the background color of the control.
*
* @SINCE_1_0.0
- * @return The background color of the control.
+ * @return The background color of the control
*/
Vector4 GetBackgroundColor() const DALI_DEPRECATED_API;
* @brief Sets an image as the background of the control.
*
* @SINCE_1_0.0
- * @param[in] image The image to set as the background.
+ * @param[in] image The image to set as the background
*/
void SetBackgroundImage( Image image ) DALI_DEPRECATED_API;
* The return value of True, indicates that the event should be consumed.
* Otherwise the signal will be emitted on the next parent of the actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Control has been initialized.
*/
KeyEventSignalType& KeyEventSignal();
* The return value of True, indicates that the event should be consumed.
* Otherwise the signal will be emitted on the next parent of the actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Control has been initialized.
*/
KeyInputFocusSignalType& KeyInputFocusGainedSignal();
* The return value of True, indicates that the event should be consumed.
* Otherwise the signal will be emitted on the next parent of the actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Control has been initialized.
*/
KeyInputFocusSignalType& KeyInputFocusLostSignal();
public: // Intended for control developers
/**
- * @brief Create an initialised Control.
+ * @brief Creates an initialized Control.
*
* @SINCE_1_0.0
- * @param[in] implementation The implementation for this control.
- * @return A handle to a newly allocated Dali resource.
- *
+ * @param[in] implementation The implementation for this control
+ * @return A handle to a newly allocated Dali resource
* @note Should NOT be called to create a handle from the implementation. As stated, this allocates a NEW Dali resource.
*/
explicit Control(Internal::Control& implementation);
* using an Internal CustomActor pointer.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource
+ * @param[in] internal A pointer to a newly allocated Dali resource
*/
explicit Control(Dali::Internal::CustomActor* internal);
/**
* @brief Template to allow deriving controls to DownCast handles to deriving handle classes.
*
- * @tparam T The handle class
- * @tparam I The implementation class
+ * @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.
+ * @param[in] handle Handle to an object
+ * @return Handle to a class T or an uninitialized handle
* @see DownCast(BaseHandle)
*/
template<typename T, typename I>
* @brief Template to allow deriving controls to verify whether the Internal::CustomActor* is actually an
* implementation of their class.
*
- * @tparam I The implementation class
+ * @tparam I The implementation class
* @SINCE_1_0.0
- * @param[in] internal Pointer to the Internal::CustomActor
+ * @param[in] internal Pointer to the Internal::CustomActor
*/
template<typename I>
DALI_INTERNAL void VerifyCustomActorPointer(Dali::Internal::CustomActor* internal)
* "type":"ImageView",
* "image":"image.png",
* "properties": {
- * "flex":1, // property to make the item to receive the specified proportion of the free space in the container.
- * "alignSelf":"flexStart", // property to specify how the item will align along the cross axis.
- * "flexMargin":[10, 10, 10, 10] // property to specify the space around the item.
+ * "flex":1, // Property to make the item to receive the specified proportion of the free space in the container.
+ * "alignSelf":"flexStart", // Property to specify how the item will align along the cross axis.
+ * "flexMargin":[10, 10, 10, 10] // Property to specify the space around the item.
* }
* @endcode
* @SINCE_1_1.35
public:
/**
- * @brief The direction of the main axis in the flex container. This determines
+ * @brief Enumeration for the direction of the main axis in the flex container. This determines
* the direction that flex items are laid out in the flex container.
* @SINCE_1_1.35
*/
};
/**
- * @brief The primary direction in which content is ordered in the flex container
+ * @brief Enumeration for the primary direction in which content is ordered in the flex container
* and on which sides the “start” and “end” are.
* @SINCE_1_1.35
*/
};
/**
- * @brief Alignment of the flex items when the items do not use all available
+ * @brief Enumeration for the alignment of the flex items when the items do not use all available
* space on the main-axis.
* @SINCE_1_1.35
*/
};
/**
- * @brief Alignment of the flex items or lines when the items or lines do not
- * use all available space on the cross-axis.
+ * @brief Enumeration for the alignment of the flex items or lines when the items or lines do not
+ * use all the available space on the cross-axis.
* @SINCE_1_1.35
*/
enum Alignment
};
/**
- * @brief The wrap type of the flex container when there is no enough room for
+ * @brief Enumeration for the wrap type of the flex container when there is no enough room for
* all the items on one flex line.
* @SINCE_1_1.35
*/
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_1.35
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the FlexContainer class.
+ * @brief Enumeration for the instance of properties belonging to the FlexContainer class.
* @SINCE_1_1.35
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the FlexContainer class.
+ * @brief Enumeration for the instance of properties belonging to the FlexContainer class.
* @SINCE_1_1.35
*/
enum
};
/**
- * @brief An enumeration of child properties belonging to the FlexContainer class.
+ * @brief Enumeration for the instance of child properties belonging to the FlexContainer class.
* @SINCE_1_1.35
*/
struct ChildProperty
{
/**
- * @brief An enumeration of child properties belonging to the FlexContainer class.
+ * @brief Enumeration for the instance of child properties belonging to the FlexContainer class.
* @SINCE_1_1.35
*/
enum
};
/**
- * @brief Create a FlexContainer handle; this can be initialised with FlexContainer::New()
- * Calling member functions with an uninitialised handle is not allowed.
+ * @brief Creates a FlexContainer handle; this can be initialized with FlexContainer::New()
+ * Calling member functions with an uninitialized handle is not allowed.
* @SINCE_1_1.35
*/
FlexContainer();
/**
- * @brief 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.35
*
* @param[in] handle The handle to copy from
FlexContainer( const FlexContainer& handle );
/**
- * @brief 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.35
* @param[in] handle Handle to an object
* @return A reference to this
FlexContainer& operator=( const FlexContainer& handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @details This is non-virtual since derived Handle types must not contain data or virtual methods.
*
~FlexContainer();
/**
- * @brief Create the FlexContainer control.
+ * @brief Creates the FlexContainer control.
* @SINCE_1_1.35
*
- * @return A handle to the FlexContainer control.
+ * @return A handle to the FlexContainer control
*/
static FlexContainer New();
/**
- * @brief Downcast an Object handle to FlexContainer.
+ * @brief Downcasts an Object handle to FlexContainer.
*
- * @details If handle points to a FlexContainer the downcast produces
- * valid handle. If not the returned handle is left uninitialized.
+ * @details If handle points to a FlexContainer, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_1.35
*
* @param[in] handle Handle to an object
- * @return handle to a FlexContainer or an uninitialized handle
+ * @return Handle to a FlexContainer or an uninitialized handle
*/
static FlexContainer DownCast( BaseHandle handle );
* @brief Creates a handle using the Toolkit::Internal implementation.
* @SINCE_1_1.35
*
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL FlexContainer( Internal::FlexContainer& implementation );
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
* @SINCE_1_1.35
*
- * @param[in] internal A pointer to the internal CustomActor.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL FlexContainer( Dali::Internal::CustomActor* internal );
/// @endcond
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the ImageView class.
+ * @brief Enumeration for the instance of properties belonging to the ImageView class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the ImageView class.
+ * @brief Enumeration for the instance of properties belonging to the ImageView class.
* @SINCE_1_0.0
*/
enum
/**
* @DEPRECATED_1_1.16. Use IMAGE instead.
- * @brief name "resourceUrl", type string
+ * @brief name "resourceUrl", type string.
* @SINCE_1_0.0
*/
RESOURCE_URL = PROPERTY_START_INDEX,
/**
- * @brief name "image", type string if it is a url, map otherwise
+ * @brief name "image", type string if it is a url, map otherwise.
* @SINCE_1_0.0
*/
IMAGE,
/**
- * @brief name "preMultipliedAlpha", type Boolean
+ * @brief name "preMultipliedAlpha", type Boolean.
* @SINCE_1_1.18
* @pre image must be initialized.
*/
// Animatable properties
/**
- * @brief name "pixelArea", type Vector4
+ * @brief name "pixelArea", type Vector4.
* @details Pixel area is a relative value with the whole image area as [0.0, 0.0, 1.0, 1.0].
* @SINCE_1_1.18
*/
public:
/**
- * @brief Create an uninitialized ImageView.
+ * @brief Creates 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.
+ * @return A handle to a newly allocated Dali ImageView
*
* @note ImageView will not display anything.
*/
/**
* @DEPRECATED_1_2_8, use New( const std::string& ) instead.
*
- * @brief Create an initialized ImageView from an Image instance.
+ * @brief Creates an initialized ImageView from an Image instance.
*
* If the handle is empty, ImageView will not display anything.
*
* @SINCE_1_0.0
- * @param[in] image The Image instance to display.
- * @return A handle to a newly allocated ImageView.
+ * @param[in] image The Image instance to display
+ * @return A handle to a newly allocated ImageView
*/
static ImageView New( Image image ) DALI_DEPRECATED_API;
/**
- * @brief Create an initialized ImageView from an URL to an image resource.
+ * @brief Creates an initialized ImageView from an URL to an image resource.
*
* If the string is empty, ImageView will not display anything.
*
* @SINCE_1_0.0
* @REMARK_INTERNET
* @REMARK_STORAGE
- * @param[in] url The url of the image resource to display.
- * @return A handle to a newly allocated ImageView.
+ * @param[in] url The url of the image resource to display
+ * @return A handle to a newly allocated ImageView
*/
static ImageView New( const std::string& url );
/**
- * @brief Create an initialized ImageView from a URL to an image resource.
+ * @brief Creates an initialized ImageView from a URL to an image resource.
*
* If the string is empty, ImageView will not display anything.
*
* @SINCE_1_1.10
* @REMARK_INTERNET
* @REMARK_STORAGE
- * @param[in] url The url of the image resource to display.
- * @param [in] size The width and height to which to fit the loaded image.
- * @return A handle to a newly allocated ImageView.
- *
+ * @param[in] url The url of the image resource to display
+ * @param [in] size The width and height to which to fit the loaded image
+ * @return A handle to a newly allocated ImageView
* @note A valid size is preferable for efficiency.
* However, do not set a size that is bigger than the actual image size, as up-scaling is not available.
* The content of the area not covered by the actual image is undefined and will not be cleared.
static ImageView New( const std::string& url, ImageDimensions size );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] imageView The ImageView to assign from.
- * @return The updated ImageView.
+ * @param[in] imageView The ImageView to assign from
+ * @return The updated ImageView
*/
ImageView& operator=( const ImageView& imageView );
/**
- * @brief Downcast a handle to ImageView handle.
+ * @brief Downcasts a handle to ImageView handle.
*
- * If handle points to a ImageView the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
+ * @return Handle to a ImageView or an uninitialized handle
*/
static ImageView DownCast( BaseHandle handle );
* @SINCE_1_1.4
* @REMARK_INTERNET
* @REMARK_STORAGE
- * @param[in] url The URL to the image resource to display.
+ * @param[in] url The URL to the image resource to display
*/
void SetImage( const std::string& url );
* @SINCE_1_1.10
* @REMARK_INTERNET
* @REMARK_STORAGE
- * @param[in] url The URL to the image resource to display.
- * @param [in] size The width and height to fit the loaded image to.
+ * @param[in] url The URL to the image resource to display
+ * @param [in] size The width and height to fit the loaded image to
*/
void SetImage( const std::string& url, ImageDimensions size );
* A valid handle will be returned only if this instance was created with New(Image) or SetImage(Image) was called.
*
* @SINCE_1_0.0
- * @return The Image instance currently used by the ImageView.
+ * @return The Image instance currently used by the ImageView
*/
Image GetImage() const DALI_DEPRECATED_API;
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The ImageView implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL ImageView( Dali::Internal::CustomActor* internal );
/// @endcond
* @brief Model3dView is a control for displaying 3d geometry.
*
* 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)
+ * the size of all the other controls. So the max is (0.5,0.5) and the min is (-0.5,-0.5).
*
* @SINCE_1_1.4
*/
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_1.4
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the TextLabel class.
+ * @brief Enumeration for the instance of properties belonging to the TextLabel class.
* @SINCE_1_1.4
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the TextLabel class.
+ * @brief Enumeration for the instance of properties belonging to the TextLabel class.
* @SINCE_1_1.4
*/
enum
};
/**
- * @brief Create a new instance of a Model3dView control.
+ * @brief Creates a new instance of a Model3dView control.
*
* @SINCE_1_1.4
- * @return A handle to the new Model3dView control.
+ * @return A handle to the new Model3dView control
*/
static Model3dView New();
/**
- * @brief Create a new instance of a Model3dView control.
+ * @brief Creates a new instance of a Model3dView control.
*
* @SINCE_1_1.4
* @param[in] objUrl The path to the geometry file
* @param[in] mtlUrl The path to the material file
* @param[in] imagesUrl The path to the images directory
- * @return A handle to the new Model3dView control.
+ * @return A handle to the new Model3dView control
*/
static Model3dView New( const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl );
/**
- * @brief Create an uninitialized Model3dView
+ * @brief Creates an uninitialized Model3dView.
*
- * Only derived versions can be instantiated. Calling member
+ * Only derived versions can be instantiated. Calling member
* functions with an uninitialized Dali::Object is not allowed.
* @SINCE_1_1.4
*/
Model3dView();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_1.4
Model3dView& operator=( const Model3dView& model3dView );
/**
- * @brief Downcast an Object handle to Model3dView.
+ * @brief Downcasts an Object handle to Model3dView.
*
- * If handle points to a Model3dView the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
+ * @return Handle to a Model3dView or an uninitialized handle
*/
static Model3dView DownCast( BaseHandle handle );
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_1.4
- * @param[in] implementation The Control implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL Model3dView( Dali::Internal::CustomActor* internal );
/// @endcond
// Properties
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the ScrollBar class.
+ * @brief Enumeration for the instance of properties belonging to the ScrollBar class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the ScrollBar class.
+ * @brief Enumeration for the instance of properties belonging to the ScrollBar class.
* @SINCE_1_0.0
*/
enum
{
/**
- * @brief name "scrollDirection", type std::string
- * @see SetScrollDirection()
+ * @brief name "scrollDirection", type std::string.
* @SINCE_1_0.0
+ * @see SetScrollDirection()
*/
SCROLL_DIRECTION = PROPERTY_START_INDEX,
/**
- * @brief name "indicatorHeightPolicy", type std::string
- * @see SetIndicatorHeightPolicy()
+ * @brief name "indicatorHeightPolicy", type std::string.
* @SINCE_1_0.0
+ * @see SetIndicatorHeightPolicy()
*/
INDICATOR_HEIGHT_POLICY,
/**
- * @brief name "indicatorFixedHeight", type float
- * @see SetIndicatorFixedHeight()
+ * @brief name "indicatorFixedHeight", type float.
* @SINCE_1_0.0
+ * @see SetIndicatorFixedHeight()
*/
INDICATOR_FIXED_HEIGHT,
/**
- * @brief name "indicatorShowDuration", type float
- * @see SetIndicatorShowDuration()
+ * @brief name "indicatorShowDuration", type float.
* @SINCE_1_0.0
+ * @see SetIndicatorShowDuration()
*/
INDICATOR_SHOW_DURATION,
/**
- * @brief name "indicatorHideDuration", type float
- * @see SetIndicatorHideDuration()
+ * @brief name "indicatorHideDuration", type float.
* @SINCE_1_0.0
+ * @see SetIndicatorHideDuration()
*/
INDICATOR_HIDE_DURATION,
/**
- * @brief name "scrollPositionIntervals", type Property::Array
- * @see SetScrollPositionIntervals()
+ * @brief name "scrollPositionIntervals", type Property::Array.
* @SINCE_1_0.0
+ * @see SetScrollPositionIntervals()
*/
SCROLL_POSITION_INTERVALS,
/**
- * @brief name "indicatorMinimumHeight", type float
+ * @brief name "indicatorMinimumHeight", type float.
* The minimum height for a variable size indicator.
* @SINCE_1_1.36
*/
INDICATOR_MINIMUM_HEIGHT,
/**
- * @brief name "indicatorStartPadding", type float
+ * @brief name "indicatorStartPadding", type float.
* The padding at the start of the indicator. For example, the top if scrollDirection is Vertical.
* @SINCE_1_1.36
*/
INDICATOR_START_PADDING,
/**
- * @brief name "indicatorEndPadding", type float
+ * @brief name "indicatorEndPadding", type float.
* The padding at the end of the indicator. For example, the bottom if scrollDirection is Vertical.
* @SINCE_1_1.36
*/
};
/**
- * @brief Create an uninitialized ScrollBar; this can be initialized with ScrollBar::New()
+ * @brief Creates 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& operator=( const ScrollBar& scrollBar );
/**
- * @brief Destructor
+ * @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
+ * @brief Creates 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.
+ * @param[in] direction The direction of scroll bar (either vertically or horizontally)
+ * @return A pointer to the created ScrollBar
*/
static ScrollBar New(Direction direction = Vertical);
/**
- * @brief Downcast a handle to ScrollBar handle.
+ * @brief Downcasts a handle to ScrollBar handle.
*
- * If handle points to a ScrollBar the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * 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
+ * @return Handle to a ScrollBar or an uninitialized handle
*/
static ScrollBar DownCast( BaseHandle handle );
/**
- * @brief Set the source of the scroll position properties.
- *
- * * @pre The handle to the object owing the scroll properties has been initialised and the property index must be vaild.
+ * @brief Sets the source of the scroll position properties.
*
* @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).
- * @param[in] propertyMaxScrollPosition The index of the maximum scroll position property (The maximum scroll position, type float).
- * @param[in] propertyScrollContentSize The index of the scroll content size property (The size of the scrollable content in actor coordinates, type float).
+ * @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)
+ * @param[in] propertyMaxScrollPosition The index of the maximum scroll position property (The maximum scroll position, type float)
+ * @param[in] propertyScrollContentSize The index of the scroll content size property (The size of the scrollable content in actor coordinates, type float)
+ * @pre The handle to the object owing the scroll properties has been initialised and the property index must be valid.
*/
void SetScrollPropertySource( Handle handle, Dali::Property::Index propertyScrollPosition, Dali::Property::Index propertyMinScrollPosition, Dali::Property::Index propertyMaxScrollPosition, Dali::Property::Index propertyScrollContentSize );
* @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
+ * @pre The scroll bar actor has been initialized.
*/
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
+ * @pre The scroll bar actor has been initialized.
*/
Actor GetScrollIndicator();
*
* @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.
- *
+ * @pre The scroll bar actor has been initialized.
*/
void SetScrollPositionIntervals( const Dali::Vector<float>& positions );
*
* @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.
+ * @pre The scroll bar actor has been initialized.
*
*/
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)
+ * @pre The scroll bar actor has been initialized.
*/
void SetScrollDirection( Direction direction );
* @brief Gets the direction of scroll bar.
*
* @SINCE_1_0.0
- * @return The direction of scroll bar.
+ * @return The direction of scroll bar
*/
Direction GetScrollDirection() const;
*
* @SINCE_1_0.0
* @param[in] policy The height policy of scroll indicator
- * @pre The scroll bar actor has been initialised.
- *
+ * @pre The scroll bar actor has been initialized.
*/
void SetIndicatorHeightPolicy( IndicatorHeightPolicy policy );
* @brief Sets the fixed height of scroll indicator.
*
* Normally the height of scroll indicator is changed dynamically according to the length of scroll content.
- * However, when the height policy of scroll indicator is set to be fixed, the height will keep fixed
+ * However, when the height policy of scroll indicator is set to be fixed, the height will be kept 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.
+ * @pre The scroll bar actor has been initialized.
*
*/
void SetIndicatorFixedHeight( float height );
float GetIndicatorFixedHeight() const;
/**
- * @brief Sets the duration in second for the scroll indicator to become fully visible
+ * @brief Sets the duration in seconds 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
void SetIndicatorShowDuration( float durationSeconds );
/**
- * @brief Gets the duration in second for the scroll indicator to become fully visible
+ * @brief Gets the duration in seconds 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
+ * @brief Sets the duration in seconds 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
void SetIndicatorHideDuration( float durationSeconds );
/**
- * @brief Gets the duration in second for the scroll indicator to become fully invisible
+ * @brief Gets the duration in seconds 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
+ * @brief Shows the scroll indicator.
* @SINCE_1_0.0
*/
void ShowIndicator();
/**
- * @brief Hides the scroll indicator
+ * @brief Hides the scroll indicator.
* @SINCE_1_0.0
*/
void HideIndicator();
* void YourCallbackName();
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
ScrollBar::PanFinishedSignalType& PanFinishedSignal();
* void YourCallbackName(float currentScrollPosition);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
ScrollBar::ScrollPositionIntervalReachedSignalType& ScrollPositionIntervalReachedSignal();
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL ScrollBar( Internal::ScrollBar& 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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL ScrollBar( Dali::Internal::CustomActor* internal );
/// @endcond
*/
/**
- * @brief Default item layout mode.
+ * @brief Enumeration for default item layout mode.
* @SINCE_1_0.0
*/
namespace DefaultItemLayout
{
/**
- * @brief The type of DefaultItemLayout
+ * @brief Enumeration for the type of DefaultItemLayout
* @SINCE_1_0.0
*/
enum Type
* @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.
+ * @param[in] type The type of layout required
+ * @return An ItemLayoutPtr to the newly created layout
*/
DALI_IMPORT_API ItemLayoutPtr New( Type type );
DALI_EXPORT_API virtual ~ItemFactory() {};
/**
- * @brief Query the number of items available from the factory.
+ * @brief Queries 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
+ * @return The number of items
*/
virtual unsigned int GetNumberOfItems() = 0;
/**
- * @brief Create an Actor to represent a visible item.
+ * @brief Creates 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.
+ * @param[in] itemId The ID of the newly visible item
+ * @return An actor, or an uninitialized pointer if the ID is out of range
*/
virtual Actor NewItem(unsigned int itemId) = 0;
/**
- * @brief Notify the factory the actor representing the item is removed from ItemView.
+ * @brief Notifies 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.
+ * @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) {};
/**
- * @brief Retrieve the extension for this control.
+ * @brief Retrieves the extension for this control.
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
struct ItemRange
{
/**
- * @brief Create a range of item identifiers.
+ * @brief Creates 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.
+ * @param[in] beginItem The first item within the range
+ * @param[in] endItem The past-the-end item
*/
ItemRange(unsigned int beginItem, unsigned int endItem)
: begin(beginItem),
* @brief Copy Constructor.
*
* @SINCE_1_0.0
- * @param[in] copy ItemRange we should copy from.
+ * @param[in] copy ItemRange we should copy from
*/
ItemRange(const ItemRange& copy)
: begin(copy.begin),
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] range The Range to assign from.
- * @return The updated range.
+ * @param[in] range The Range to assign from
+ * @return The updated range
*/
ItemRange& operator=(const ItemRange& range)
{
}
/**
- * @brief Test whether an item is within the range.
+ * @brief Tests 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.
+ * @param[in] itemId The item identifier
+ * @return true if the item is within the range
*/
bool Within(unsigned int itemId)
{
}
/**
- * @brief Create the intersection of two ranges.
+ * @brief Creates the intersection of two ranges.
*
* @SINCE_1_0.0
- * @param[in] second The second range.
- * @return The intersection.
+ * @param[in] second The second range
+ * @return The intersection
*/
ItemRange Intersection(const ItemRange& second)
{
/**
* @brief ItemView is a scrollable layout container.
*
- * Multiple ItemLayouts may be provided, to determine the logical position of each item a layout.
- * Actors are provided from an external ItemFactory, to display the currently visible items.
+ * Multiple ItemLayouts may be provided to determine the logical position of each item layout.
+ * Actors are provided from an external ItemFactory to display the currently visible items.
*
* Signals
* | %Signal Name | Method |
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_1.18
*/
enum PropertyRange
public:
/**
- * @brief Create an uninitialized ItemView; this can be initialized with ItemView::New().
+ * @brief Creates 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& operator=( const ItemView& itemView );
/**
- * @brief Destructor
+ * @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.
+ * @brief Creates 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.
+ * @param[in] factory The factory which provides ItemView with items
+ * @return A handle to a newly allocated Dali resource
*/
static ItemView New(ItemFactory& factory);
/**
- * @brief Downcast a handle to ItemView handle.
+ * @brief Downcasts a handle to ItemView handle.
*
- * If handle points to a ItemView the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
static ItemView DownCast( BaseHandle handle );
/**
- * @brief Query the number of layouts.
+ * @brief Queries the number of layouts.
*
* @SINCE_1_0.0
- * @return The number of layouts.
+ * @return The number of layouts
*/
unsigned int GetLayoutCount() const;
/**
- * @brief Add a layout.
+ * @brief Adds a layout.
*
* @SINCE_1_0.0
- * @param[in] layout The layout.
+ * @param[in] layout The layout
*/
void AddLayout(ItemLayout& layout);
/**
- * @brief Remove a layout.
+ * @brief Removes a layout.
*
* @SINCE_1_0.0
- * @param[in] layoutIndex The index of one of the ItemView layouts.
+ * @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.
+ * @brief Retrieves a layout.
*
* @SINCE_1_0.0
- * @param[in] layoutIndex The index of the layout to retrieve.
+ * @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.
+ * @brief Retrieves the currently active layout, if any.
*
* @SINCE_1_0.0
- * @return The layout, or an uninitialized pointer if no layout is active.
+ * @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.
+ * @brief Retrieves 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.
+ * @param[in] itemId The item identifier
+ * @return The current layout-position
*/
float GetCurrentLayoutPosition(ItemId itemId) const;
/**
- * @brief Activate one of the layouts; this will resize the ItemView
+ * @brief Activates one of the layouts; this will resize the ItemView
* & relayout actors within the ItemView.
*
* This is done by applying constraints from the new layout, and
* removing constraints from the previous layout.
*
* @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).
+ * @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.
+ * @brief Deactivates 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.
+ * @brief Sets 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.
+ * @brief Gets 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.
+ * @brief Sets 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.
+ * @param[in] distance The minimum swipe distance
*/
void SetMinimumSwipeDistance(float distance);
/**
- * @brief Get the minimum swipe distance in actor coordinates.
+ * @brief Gets the minimum swipe distance in actor coordinates.
*
* @SINCE_1_0.0
* @return The minimum swipe distance
*/
/**
- * @brief Move Actor constraint.
+ * @brief Moves Actor constraint.
*
* Moves an Actor in accordance to scroll position.
+ * @SINCE_1_0.0
* @param[in] current Current position
* @param[in] inputs The position input that Actor will move
- * @SINCE_1_0.0
*/
DALI_IMPORT_API void MoveActorConstraint( Vector3& current, const PropertyInputContainer& inputs );
/**
- * @brief Wrap Actor constraint.
+ * @brief Wraps Actor constraint.
*
* Wraps an Actors position in accordance to min/max bounds of domain.
+ * @SINCE_1_0.0
* @param[in] position Position to be wrapped
* @param[in] inputs The input that Actor's position will be wrapped
- * @SINCE_1_0.0
*/
DALI_IMPORT_API void WrapActorConstraint( Vector3& position, const PropertyInputContainer& inputs );
* ScrollView instance.
*
* Such effects are purely logical (i.e. physics), and may produce
- * properties that can be used with visual effects. Such as creating
+ * 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
public:
/**
- * @brief Create an uninitialized ScrollViewEffect; this can only be initialized with derived classes.
+ * @brief Creates 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
* @brief This constructor is used by Dali New() methods.
*
* @SINCE_1_0.0
- * @param [in] impl A pointer to a newly allocated Dali resource
+ * @param[in] impl A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL ScrollViewEffect(Internal::ScrollViewEffect *impl);
/// @endcond
*
* 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
+ * to 0.0 at the end of the path.
*
*
* ScrollView
public:
/**
- * @brief Create an initialized ScrollViewPagePathEffect.
+ * @brief Creates 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.
+ * @param[in] inputPropertyIndex Index of a property of the scroll-view which will be used as the input for the path
* @param[in] pageSize Size of a page in the scrollview
* @param[in] pageCount Total number of pages in the scrollview
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static ScrollViewPagePathEffect New(Path path, const Vector3& forward, Dali::Property::Index inputPropertyIndex, const Vector3& pageSize, unsigned int pageCount);
/**
- * @brief Create an uninitialized ScrollViewPagePathEffect; this can be initialized with ScrollViewPagePathEffect::New()
+ * @brief Creates 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();
/**
- * @brief Downcast a handle to ScrollViewPagePathEffect handle.
+ * @brief Downcasts a handle to ScrollViewPagePathEffect handle.
*
- * If handle points to a ScrollViewPagePathEffect the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * 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
+ * @return Handle to a ScrollViewPagePathEffect or an uninitialized handle
*/
static ScrollViewPagePathEffect DownCast( BaseHandle handle );
/**
* @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
+ * @param[in] page The page to be affected by this effect
+ * @param[in] pageOrder The order of the page in the scroll view
*/
void ApplyToPage( Actor page, unsigned int pageOrder );
/**
* @brief This constructor is used by Dali New() methods.
* @SINCE_1_0.0
- * @param [in] impl A pointer to a newly allocated Dali resource
+ * @param[in] impl A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL ScrollViewPagePathEffect( Internal::ScrollViewPagePathEffect *impl );
/// @endcond
*/
/**
- * @brief How axes/rotation or scale are clamped
+ * @brief Enumeration for how axes/rotation or scale are clamped.
* @SINCE_1_0.0
*/
enum ClampState
};
/**
- * @brief A 2 dimensional clamp
+ * @brief A 2 dimensional clamp.
* @SINCE_1_0.0
*/
struct ClampState2D
};
/**
- * @brief The snap type
+ * @brief Enumeration for the snap type.
* @SINCE_1_0.0
*/
enum SnapType
};
/**
- * @brief DirectionBias types.
+ * @brief Enumeration for DirectionBias types.
* @SINCE_1_0.0
*/
enum DirectionBias
* @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.
+ * @param[in] enabled Whether domain has been enabled or not
*/
explicit RulerDomain(float min, float max, bool enabled = true);
* 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.
- * @return The clamped value.
+ * @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
+ * @return The clamped value
*/
float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
* 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.
- * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
- * @return The clamped value.
+ * @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
+ * @param[out] clamped Whether clamping occurred and which size (None, Min or Max)
+ * @return The clamped value
*/
float Clamp(float x, float length, float scale, ClampState &clamped) const;
* @brief Returns (max-min) size of ruler.
*
* @SINCE_1_0.0
- * @return The size of the ruler from min to max.
+ * @return The size of the ruler from min to max
*/
float GetSize() const;
class RulerExtension;
/**
- * @brief Abstract class to define scroll axes.
+ * @brief Abstracts class to define scroll axes.
*
- * It can specify whether they are traversable, where their snap
- * points are and their domain.
+ * 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 Constructs ruler, default enabled, with limitless domain.
+ * @brief Constructs ruler, enabled by default, 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] 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"
* 0.5 round input (floor x + 0.5) "Used for Release"
* @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
- * @return The position representing this page point.
+ * @return The position representing this page point
*/
virtual float GetPositionFromPage(unsigned int page, unsigned int &volume, bool wrap) const = 0;
* @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.
+ * @return The page where this position resides
*/
virtual unsigned int GetPageFromPosition(float position, bool wrap) const = 0;
* @brief Returns the total number of pages within this Ruler.
*
* @SINCE_1_0.0
- * @return The number of pages in the Ruler.
+ * @return The number of pages in the Ruler
*/
virtual unsigned int GetTotalPages() const = 0;
* @brief Gets the ruler type.
*
* @SINCE_1_0.0
- * @return The ruler type.
+ * @return The ruler type
*/
Ruler::RulerType GetType() const;
void Disable();
/**
- * @brief Sets Domain.
+ * @brief Sets the Domain.
*
* @SINCE_1_0.0
- * @param[in] domain Ruler domain object.
+ * @param[in] domain Ruler domain object
*/
void SetDomain(RulerDomain domain);
/**
- * @brief Gets Domain.
+ * @brief Gets the Domain.
*
* @SINCE_1_0.0
* @return The domain
* 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.
- * @return The clamped value.
+ * @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
+ * @return The clamped value
*/
float Clamp(float x, float length = 0.0f, float scale = 1.0f) const;
* 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.
- * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
- * @return The clamped value.
+ * @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
+ * @param[out] clamped Whether clamping occurred and which size (None, Min or Max)
+ * @return The clamped value
*/
float Clamp(float x, float length, float scale, ClampState &clamped) const;
* @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] x 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
* 0 floor input (floor x) "Used for Flick Left"
* 0.5 round input (floor x + 0.5) "Used for Release"
* 1 ceil input (floor x + 1.0) "Used for Flick Right"
* @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.
- * @return the clamped value after snapping
+ * to be clamped
+ * @param[in] scale Scaling parameter which treats domain as scaled in calculations
+ * @return The clamped value after snapping
*/
float SnapAndClamp(float x, float bias = 0.5f, float length = 0.0f, float scale = 1.0f) const;
* @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] x 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
* 0 floor input (floor x) "Used for Flick Left"
* 0.5 round input (floor x + 0.5) "Used for Release"
* 1 ceil input (floor x + 1.0) "Used for Flick Right"
* @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.
- * @param[out] clamped Whether clamping occured and which size (None, Min or Max)
+ * to be clamped
+ * @param[in] scale Scaling parameter which treats domain as scaled in calculations
+ * @param[out] clamped Whether clamping occurred and which size (None, Min or Max)
* @return The clamped value after snapping
*/
float SnapAndClamp(float x, float bias, float length, float scale, ClampState &clamped) const;
{
public:
/**
- * @brief Constructor
+ * @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] spacing The spacing between each interval on this ruler.
+ * @param[in] spacing The spacing between each interval on this ruler
*/
FixedRuler(float spacing = 1.0f);
public:
/**
- * @brief Clamp signal event's data
+ * @brief Clamps signal event's data.
* @SINCE_1_0.0
*/
struct ClampEvent
};
/**
- * @brief Snap signal event's data.
+ * @brief Snaps signal event's data.
* @SINCE_1_0.0
*/
struct SnapEvent
};
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
* Creates another handle that points to the same real object.
*
* @SINCE_1_0.0
- * @param[in] handle to copy from
+ * @param[in] handle Handle to copy from
*/
ScrollView( const ScrollView& handle );
ScrollView& operator=( const ScrollView& handle );
/**
- * @brief Destructor
+ * @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.
+ * @brief Creates an initialized ScrollView.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static ScrollView New();
/**
- * @brief Downcast a handle to ScrollView handle.
+ * @brief Downcasts a handle to ScrollView handle.
*
- * If handle points to a ScrollView the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
public:
/**
- * @brief Get snap-animation's AlphaFunction.
+ * @brief Gets snap-animation's AlphaFunction.
*
* @SINCE_1_0.0
- * @return Current easing alpha function of the snap animation.
+ * @return Current easing alpha function of the snap animation
*/
AlphaFunction GetScrollSnapAlphaFunction() const;
/**
- * @brief Set snap-animation's AlphaFunction.
+ * @brief Sets snap-animation's AlphaFunction.
*
* @SINCE_1_0.0
- * @param[in] alpha Easing alpha function of the snap animation.
+ * @param[in] alpha Easing alpha function of the snap animation
*/
void SetScrollSnapAlphaFunction(AlphaFunction alpha);
/**
- * @brief Get flick-animation's AlphaFunction.
+ * @brief Gets flick-animation's AlphaFunction.
*
* @SINCE_1_0.0
- * @return Current easing alpha function of the flick animation.
+ * @return Current easing alpha function of the flick animation
*/
AlphaFunction GetScrollFlickAlphaFunction() const;
/**
- * @brief Set flick-animation's AlphaFunction.
+ * @brief Sets flick-animation's AlphaFunction.
*
* @SINCE_1_0.0
- * @param[in] alpha Easing alpha function of the flick animation.
+ * @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.
+ * @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.
+ * @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.
+ * @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.
+ * @param[in] time The time in seconds for the animation to take
*/
void SetScrollFlickDuration(float time);
/**
- * @brief Set X axis ruler.
+ * @brief Sets X axis ruler.
*
* Defines how scrolling horizontally is snapped, and
* the boundary (domain) in which the ScrollView can pan.
void SetRulerX(RulerPtr ruler);
/**
- * @brief Set Y axis ruler.
+ * @brief Sets Y axis ruler.
*
* Defines how scrolling vertically is snapped, and the boundary
* (domain) in which the ScrollView can pan.
void SetRulerY(RulerPtr ruler);
/**
- * @brief Set scroll sensibility of pan gesture.
+ * @brief Sets scroll sensibility of pan gesture.
*
* @SINCE_1_0.0
- * @param[in] sensitive true to enable scroll, false to disable scrolling
+ * @param[in] sensitive @c true to enable scroll, @c false to disable scrolling
* @note Unlike Actor::SetSensitive(), this determines whether this ScrollView
- * should react (e.g. pan), without disrupting the sensitivity of it's children.
+ * should react (e.g. pan), without disrupting the sensitivity of its children.
*
*/
void SetScrollSensitive(bool sensitive);
/**
- * @brief Set maximum overshoot amount.
+ * @brief Sets maximum overshoot amount.
*
* The final overshoot value is within 0.0f to 1.0f, but the maximum
* overshoot is in pixels (e.g. if you scroll 75 pixels beyond the
void SetMaxOvershoot(float overshootX, float overshootY);
/**
- * @brief Set Snap Overshoot animation's AlphaFunction.
+ * @brief Sets Snap Overshoot animation's AlphaFunction.
*
* @SINCE_1_0.0
- * @param[in] alpha Easing alpha function of the overshoot snap animation.
+ * @param[in] alpha Easing alpha function of the overshoot snap animation
*/
void SetSnapOvershootAlphaFunction(AlphaFunction alpha);
/**
- * @brief Set Snap Overshoot animation's Duration.
+ * @brief Sets 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
+ * @note Set duration to 0 seconds to disable Animation.
*
*/
void SetSnapOvershootDuration(float duration);
* 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.
+ * @param[in] enable Enables (true), or disables (false) Wrap Mode
* @note You must apply a position constraint that causes Wrapping
* to all children.
*
* @brief Returns state of Axis Auto Lock mode.
*
* @SINCE_1_0.0
- * @return Whether Axis Auto Lock mode has been enabled or not.
+ * @return Whether Axis Auto Lock mode has been enabled or not
*/
bool GetAxisAutoLock() const;
* only panning, until the pan gesture has completed.
*
* @SINCE_1_0.0
- * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode.
+ * @param[in] enable Enables (true), or disables (false) AxisAutoLock mode
*/
void SetAxisAutoLock(bool enable);
* should be locked to the Horizontal or Vertical axis.
*
* @SINCE_1_0.0
- * @return The gradient, a value between 0.0 and 1.0f.
+ * @return The gradient, a value between 0.0 and 1.0f
*/
float GetAxisAutoLockGradient() const;
* @brief Sets the gradient threshold at which a panning gesture should be locked to the
* Horizontal or Vertical axis.
*
- * By default this is 0.36 (0.36:1) which means angles less than 20
+ * By default, this is 0.36 (0.36:1) which means angles less than 20
* degrees to an axis will lock to that axis.
*
* @SINCE_1_0.0
* @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
* @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.
+ * all panning gestures will auto-lock either to the horizontal or vertical axis.
*
*/
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.
+ * @return Friction coefficient is returned
*/
float GetFrictionCoefficient() const;
* 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)
+ * @param[in] friction Friction coefficient must be greater than 0.0 (default = 1.0)
*/
void SetFrictionCoefficient(float friction);
* 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.
+ * @return The flick speed coefficient is returned
*/
float GetFlickSpeedCoefficient() const;
* 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).
+ * @param[in] speed The flick speed coefficient (default = 1.0)
*/
void SetFlickSpeedCoefficient(float speed);
/**
* @brief Sets the minimum pan distance required for a flick in pixels.
*
- * 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.
+ * 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
* each wheel event received in free panning mode.
*
* @SINCE_1_0.0
- * @return The step of scroll distance(pixel) in X and Y axes.
+ * @return The step of scroll distance(pixel) in X and Y axes
*/
Vector2 GetWheelScrollDistanceStep() const;
* 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.
+ * @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
* scroll to the next snap point towards the scroll direction while
/**
* @brief Retrieves current scroll position.
*
- * @returns The current scroll position.
* @SINCE_1_0.0
+ * @return The current scroll position
*/
Vector2 GetCurrentScrollPosition() const;
* @SINCE_1_0.0
* @note Pages start from 0 as the first page, not 1.
*
- * @returns The Current page.
+ * @return The Current page
*/
unsigned int GetCurrentPage() const;
* - 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] position The position to scroll to
* @note Contents will not snap to ruler snap points.
*
*/
* - 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] 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.
*
* - 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] 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.
* - 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] 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] 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
* - 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] 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] 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
* "(page) * ScrollViewSize.width, 0".
*
* @SINCE_1_0.0
- * @param[in] page to scroll to
+ * @param[in] page The 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.
* "(page) * ScrollViewSize.width, 0".
*
* @SINCE_1_0.0
- * @param[in] page to scroll to
+ * @param[in] page The 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
* "(page) * ScrollViewSize.width, 0".
*
* @SINCE_1_0.0
- * @param[in] page to scroll to
+ * @param[in] page The 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.
+ * @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.
* @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).
+ * @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.
*/
* @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).
+ * @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.
* If already at snap points, then will return false, and not scroll.
*
* @SINCE_1_0.0
- * @return True if Snapping necessary.
+ * @return True if Snapping necessary
*/
bool ScrollToSnapPoint();
void RemoveConstraintsFromChildren();
/**
- * @brief Apply Effect to ScrollView.
+ * @brief Applies 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.
+ * @brief Removes Effect from ScrollView.
*
* @SINCE_1_0.0
- * @param[in] effect The effect to remove.
+ * @param[in] effect The effect to remove
*/
void RemoveEffect(ScrollViewEffect effect);
* that ScrollView's properties.
*
* @SINCE_1_0.0
- * @param[in] child The actor to add to this ScrollView.
+ * @param[in] child The actor to add to this ScrollView
*/
void BindActor(Actor child);
/**
- * @brief Unbind Actor from this ScrollView.
+ * @brief Unbinds 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.
+ * @param[in] child The actor to be unbound
* @note This does not remove the child from the ScrollView container
*
*/
* @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.
+ * @param[in] threshold The threshold to apply around the axis
* @note If no threshold is specified, then the default threshold of PI * 0.25 radians (or 45 degrees) is used.
*/
void SetScrollingDirection( Radian direction, Radian threshold = PanGestureDetector::DEFAULT_THRESHOLD );
/**
- * @brief Remove a direction constraint from the scroll view.
+ * @brief Removes a direction constraint from the scroll view.
*
* @SINCE_1_0.0
* @param[in] direction The axis to stop constraining to.
* void YourCallbackName(const SnapEvent& event);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @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.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL ScrollView( Dali::Internal::CustomActor* internal );
/// @endcond
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the Scrollable class.
+ * @brief Enumeration for the instance of properties belonging to the Scrollable class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Scrollable class.
+ * @brief Enumeration for the instance of properties belonging to the Scrollable class.
* @SINCE_1_0.0
*/
enum
*
* Changes this handle to point to another real object.
* @SINCE_1_0.0
- * @param[in] handle to copy from
+ * @param[in] handle Handle to copy from
* @return A reference to this
*/
Scrollable& operator=( const Scrollable& handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~Scrollable();
/**
- * @brief Downcast a handle to Scrollable handle.
+ * @brief Downcasts a handle to Scrollable handle.
*
- * If handle points to a Scrollable the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * 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
void SetOvershootEnabled(bool enable);
/**
- * @brief Set the color of the overshoot effect.
+ * @brief Sets the color of the overshoot effect.
*
* @SINCE_1_0.0
- * @param[in] color The color of the overshoot effect.
+ * @param[in] color The color of the overshoot effect
*/
void SetOvershootEffectColor( const Vector4& color );
/**
- * @brief Get the color of the overshoot effect.
+ * @brief Gets the color of the overshoot effect.
* @SINCE_1_0.0
- * @return The color of the overshoot effect.
+ * @return The color of the overshoot effect
*/
Vector4 GetOvershootEffectColor() const;
/**
- * @brief Set the speed of overshoot animation in pixels per second.
+ * @brief Sets 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.
+ * @param[in] pixelsPerSecond The speed of the overshoot animation
*/
void SetOvershootAnimationSpeed( float pixelsPerSecond );
/**
- * @brief Get the speed of overshoot animation in pixels per second.
+ * @brief Gets the speed of overshoot animation in pixels per second.
* @SINCE_1_0.0
- * @return The speed of the overshoot animation.
+ * @return The speed of the overshoot animation
*/
float GetOvershootAnimationSpeed() const;
* void YourCallbackName(const Vector2& currentScrollPosition);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
ScrollStartedSignalType& ScrollStartedSignal();
* void YourCallbackName(const Vector2& currentScrollPosition);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
ScrollUpdatedSignalType& ScrollUpdatedSignal();
* void YourCallbackName(const Vector2& currentScrollPosition);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @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.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL Scrollable( Dali::Internal::CustomActor* internal );
/// @endcond
*/
/**
- * @brief Slider is a control to enable sliding an indicator between two values
+ * @brief Slider is a control to enable sliding an indicator between two values.
*
* Signals
* | %Signal Name | Method |
// Properties
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_1.39
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the Slider class.
+ * @brief Enumeration for the instance of properties belonging to the Slider class.
* @SINCE_1_1.39
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Slider class.
+ * @brief Enumeration for the instance of properties belonging to the Slider class.
* @SINCE_1_1.39
*/
enum
{
/**
- * @brief name "lowerBound", type float
+ * @brief name "lowerBound", type float.
* @SINCE_1_1.39
*/
LOWER_BOUND = PROPERTY_START_INDEX,
/**
- * @brief name "upperBound", type float
+ * @brief name "upperBound", type float.
* @SINCE_1_1.39
*/
UPPER_BOUND,
/**
- * @brief name "value", type float
+ * @brief name "value", type float.
* @SINCE_1_1.39
*/
VALUE,
/**
- * @brief name "trackVisual", type string if it is a url, map otherwise
+ * @brief name "trackVisual", type string if it is a url, map otherwise.
* @SINCE_1_1.39
*/
TRACK_VISUAL,
/**
- * @brief name "handleVisual", type string if it is a url, map otherwise
+ * @brief name "handleVisual", type string if it is a url, map otherwise.
* @SINCE_1_1.39
*/
HANDLE_VISUAL,
/**
- * @brief name "progressVisual", type string if it is a url, map otherwise
+ * @brief name "progressVisual", type string if it is a url, map otherwise.
* @SINCE_1_1.39
*/
PROGRESS_VISUAL,
/**
- * @brief name "popupVisual", type string if it is a url, map otherwise
+ * @brief name "popupVisual", type string if it is a url, map otherwise.
* @SINCE_1_1.39
*/
POPUP_VISUAL,
/**
- * @brief name "popupArrowVisual", type string if it is a url, map otherwise
+ * @brief name "popupArrowVisual", type string if it is a url, map otherwise.
* @SINCE_1_1.39
*/
POPUP_ARROW_VISUAL,
/**
- * @brief name "disabledColor", type Vector4
+ * @brief name "disabledColor", type Vector4.
* @SINCE_1_1.39
*/
DISABLED_COLOR,
/**
- * @brief name "valuePrecision", type int
+ * @brief name "valuePrecision", type int.
* @SINCE_1_1.39
*/
VALUE_PRECISION,
/**
- * @brief name "showPopup", type bool
+ * @brief name "showPopup", type bool.
* @SINCE_1_1.39
*/
SHOW_POPUP,
/**
- * @brief name "showValue", type bool
+ * @brief name "showValue", type bool.
* @SINCE_1_1.39
*/
SHOW_VALUE,
/**
- * @brief name "marks", type Property::Array<float>
+ * @brief name "marks", type Property::Array<float>.
* @SINCE_1_1.39
*/
MARKS,
/**
- * @brief name "snapToMarks", type bool
+ * @brief name "snapToMarks", type bool.
* @SINCE_1_1.39
*/
SNAP_TO_MARKS,
/**
- * @brief name "markTolerance", type float
+ * @brief name "markTolerance", type float.
* @SINCE_1_1.39
*/
MARK_TOLERANCE,
~Slider();
/**
- * @brief Downcast an Object handle to Slider.
+ * @brief Downcasts an Object handle to Slider.
*
- * If handle points to a Slider the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a Slider, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_1.39
* @param[in] handle Handle to an object
* @return handle to a Slider or an uninitialized handle
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_1.39
- * @param[in] implementation The Control implementation
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL Slider(Internal::Slider& implementation);
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
* @SINCE_1_1.39
- * @param[in] internal A pointer to the internal CustomActor
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL Slider( Dali::Internal::CustomActor* internal );
/// @endcond
* "url": "{DALI_IMAGE_DIR}gallery-small-1.jpg"
* },
* "properties": {
- * "cellIndex":[1,1], // property to specify the top-left cell this child occupies, if not set, the first available cell is used
- * "rowSpan":3, // property to specify how many rows this child occupies, if not set, default value is 1
- * "columnSpan": 2, // property to specify how many columns this child occupies, if nor set, default value is 1
- * "cellHorizontalAlignment": "left", // property to specify how to align horizontally inside the cells, if not set, default value is 'left'
- * "cellVerticalAlignment": "center" // property to specify how to align vertically inside the cells, if not set, default value is 'top'
+ * "cellIndex":[1,1], // Property to specify the top-left cell this child occupies, if not set, the first available cell is used
+ * "rowSpan":3, // Property to specify how many rows this child occupies, if not set, default value is 1
+ * "columnSpan": 2, // Property to specify how many columns this child occupies, if nor set, default value is 1
+ * "cellHorizontalAlignment": "left", // Property to specify how to align horizontally inside the cells, if not set, default value is 'left'
+ * "cellVerticalAlignment": "center" // Property to specify how to align vertically inside the cells, if not set, default value is 'top'
* }
* @endcode
* @SINCE_1_0.0
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the TableView class.
+ * @brief Enumeration for the instance of properties belonging to the TableView class.
*
* LayoutRows: set the height of the rows.
* It has the format as follows in script:
struct Property
{
/**
- * @brief An enumeration of properties belonging to the TableView class.
+ * @brief Enumeration for the instance of properties belonging to the TableView class.
*
* @SINCE_1_0.0
*/
};
/**
- * @brief An enumeration of child properties belonging to the TableView class.
+ * @brief Enumeration for the instance of child properties belonging to the TableView class.
* @SINCE_1_1.36
*/
struct ChildProperty
{
/**
- * @brief An enumeration of child properties belonging to the TableView class.
+ * @brief Enumeration for the instance of child properties belonging to the TableView class.
* @SINCE_1_1.36
*/
enum
};
/**
- * @brief Describes how the size of a row / column been set
+ * @brief Enumeration for describing how the size of a row / column has been set.
* @SINCE_1_0.0
*/
enum LayoutPolicy
};
/**
- * @brief Structure to specify layout position for child actor
+ * @brief Structure to specify layout position for child actor.
* @SINCE_1_0.0
*/
struct CellPosition
{
/**
- * @brief Constructor to initialise values to defaults for convenience
+ * @brief Constructor to initialise values to defaults for convenience.
* @SINCE_1_0.0
* @param[in] rowIndex The row index initialized
* @param[in] columnIndex The column index initialized
};
/**
- * @brief Create a TableView handle; this can be initialised with TableView::New()
- * Calling member functions with an uninitialised handle is not allowed.
+ * @brief Creates a TableView handle; this can be initialized with TableView::New().
+ * Calling member functions with an uninitialized handle is not allowed.
* @SINCE_1_0.0
*/
TableView();
/**
- * @brief 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[in] handle to copy from
+ * @param[in] handle Handle to copy from
*/
TableView( const TableView& handle );
/**
- * @brief 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
* @param[in] handle Handle to an object
* @return A reference to this
TableView& operator=( const TableView& handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~TableView();
/**
- * @brief Create the TableView control.
+ * @brief Creates 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.
+ * @return A handle to the TableView control
*/
static TableView New( unsigned int initialRows, unsigned int initialColumns );
/**
- * @brief Downcast a handle to TableView handle.
+ * @brief Downcasts a handle to TableView handle.
*
- * If handle points to a TableView the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * 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
+ * @return Handle to a TableView or an uninitialized handle
*/
static TableView DownCast( BaseHandle handle );
/**
- * @brief Adds a child to the table
- * If the row or column index is outside the table, the table gets resized bigger
+ * @brief Adds a child to the table.
+ * If the row or column index is outside the table, the table gets resized bigger.
* @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
+ * @param[in] child The child to add
+ * @param[in] position The position for the child
+ * @return @c true if the addition succeeded, @c false if the cell is already occupied
* @pre The child actor has been initialized.
*/
bool AddChild( Actor child, CellPosition position );
/**
- * @brief Returns a child from the given layout position
+ * @brief Returns a child from the given layout position.
* @SINCE_1_0.0
- * @param[in] position in the table
- * @return child that was in the cell or an uninitialized handle
+ * @param[in] position The position in the table
+ * @return Child that was in the cell or an uninitialized handle
* @note If there is no child in this position this method returns an uninitialized.
* Actor handle
*/
Actor GetChildAt( CellPosition position );
/**
- * @brief Removes a child from the given layout position
+ * @brief Removes a child from the given layout position.
* @SINCE_1_0.0
- * @param[in] position for the child to remove
- * @return child that was removed or an uninitialized handle
- * @note If there is no child in this position this method does nothing.
+ * @param[in] position The position for the child to remove
+ * @return Child that was removed or an uninitialized handle
+ * @note If there is no child in this position, this method does nothing.
*/
Actor RemoveChildAt( CellPosition position );
/**
- * @brief Finds the childs layout position
+ * @brief Finds the child's layout position.
* @SINCE_1_0.0
- * @param[in] child to search for
- * @param[out] position for the child
+ * @param[in] child The child to search for
+ * @param[out] position The position for the child
* @return true if the child was included in this TableView
*/
bool FindChildPosition( Actor child, CellPosition& position );
/**
- * @brief Insert a new row to given index
+ * @brief Inserts a new row to given index.
* @SINCE_1_0.0
- * @param [in] rowIndex of the new row
+ * @param[in] rowIndex The rowIndex of the new row
*/
void InsertRow( unsigned int rowIndex );
/**
- * @brief Delete a row from given index
- * Removed elements are deleted
+ * @brief Deletes a row from the given index.
+ * Removed elements are deleted.
* @SINCE_1_0.0
- * @param [in] rowIndex of the row to delete
+ * @param[in] rowIndex The rowIndex of the row to delete
*/
void DeleteRow( unsigned int rowIndex );
/**
- * @brief Delete a row from given index
+ * @brief Deletes a row from the given index.
* @SINCE_1_0.0
- * @param [in] rowIndex of the row to delete
- * @param [out] removed elements
+ * @param[in] rowIndex The rowIndex of the row to delete
+ * @param[out] removed The removed elements
*/
void DeleteRow( unsigned int rowIndex, std::vector<Actor>& removed );
/**
- * @brief Insert a new column to given index
+ * @brief Inserts a new column to the given index.
* @SINCE_1_0.0
- * @param [in] columnIndex of the new column
+ * @param[in] columnIndex The columnIndex of the new column
*/
void InsertColumn( unsigned int columnIndex );
/**
- * @brief Delete a column from given index.
- * Removed elements are deleted
+ * @brief Deletes a column from the given index.
+ * Removed elements are deleted.
* @SINCE_1_0.0
- * @param [in] columnIndex of the column to delete
+ * @param[in] columnIndex The columnIndex of the column to delete
*/
void DeleteColumn( unsigned int columnIndex );
/**
- * @brief Delete a column from given index
+ * @brief Deletes a column from the given index.
* @SINCE_1_0.0
- * @param [in] columnIndex of the column to delete
- * @param [out] removed elements
+ * @param[in] columnIndex The columnIndex of the column to delete
+ * @param[out] removed The removed elements
*/
void DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed );
/**
- * @brief Resize the TableView.
+ * @brief Resizes the TableView.
* @SINCE_1_0.0
- * @param[in] rows for the table
- * @param[in] columns for the table
+ * @param[in] rows The rows for the table
+ * @param[in] columns The columns for the table
* @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.
+ * If an actor spans to a removed row or column, it gets removed from the table.
*/
void Resize( unsigned int rows, unsigned int columns );
/**
- * @brief Resize the TableView.
+ * @brief Resizes the TableView.
* @SINCE_1_0.0
- * @param[in] rows for the table
- * @param[in] columns for the table
- * @param[out] removed actor handles
- * @note If the new size is smaller than old,
- * superfluous actors get removed.
+ * @param[in] rows The rows for the table
+ * @param[in] columns The columns for the table
+ * @param[out] removed The removed actor handles
+ * @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.
*/
void Resize( unsigned int rows, unsigned int columns, std::vector<Actor>& removed );
/**
- * @brief Set horizontal and vertical padding between cells
+ * @brief Sets horizontal and vertical padding between cells.
* @SINCE_1_0.0
- * @param[in] padding width and height
+ * @param[in] padding Width and height
*/
void SetCellPadding( Size padding );
/**
- * @brief Get the current padding as width and height.
+ * @brief Gets the current padding as width and height.
* @SINCE_1_0.0
- * @return the current padding as width and height
+ * @return The current padding as width and height
*/
Size GetCellPadding();
/**
- * @brief Specify this row as fitting its height to its children
+ * @brief Specifies 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 Check if the row is a fit row.
+ * @brief Checks if the row is a fit row.
*
* @SINCE_1_0.0
* @param[in] rowIndex The row to check
bool IsFitHeight( unsigned int rowIndex ) const;
/**
- * @brief Specify this column as fitting its width to its children
+ * @brief Specifies 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 Check if the column is a fit column.
+ * @brief Checks if the column is a fit column.
*
* @SINCE_1_0.0
* @param[in] columnIndex The column to check
bool IsFitWidth( unsigned int columnIndex ) const;
/**
- * @brief Sets a row to have fixed height
- * Setting a fixed height of 0 has no effect
+ * @brief Sets a row to have fixed height.
+ * Setting a fixed height of 0 has no effect.
* @SINCE_1_0.0
- * @param rowIndex for row with fixed height
- * @param height in world coordinate units
+ * @param rowIndex The rowIndex for row with fixed height
+ * @param height The height in world coordinate units
* @pre The row rowIndex must exist.
*/
void SetFixedHeight( unsigned int rowIndex, float height );
* @brief Gets a row's fixed height.
* @SINCE_1_0.0
* @param[in] rowIndex The row index with fixed height
- * @return height in world coordinate units.
+ * @return height The height in world coordinate units
* @pre The row rowIndex must exist.
* @note The returned value is valid if it has been set before.
*/
/**
* @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
+ * the remainder of the table height after subtracting Padding and Fixed height rows.
+ * Setting a relative height of 0 has no effect.
* @SINCE_1_0.0
- * @param rowIndex for row with relative height
+ * @param rowIndex The rowIndex for row with relative height
* @param heightPercentage between 0.0f and 1.0f
* @pre The row rowIndex must exist.
*/
* @brief Gets a row's relative height.
* @SINCE_1_0.0
* @param[in] rowIndex The row index with relative height
- * @return height in percentage units, between 0.0f and 1.0f.
+ * @return Height in percentage units, between 0.0f and 1.0f
* @pre The row rowIndex must exist.
* @note The returned value is valid if it has been set before.
*/
float GetRelativeHeight( unsigned int rowIndex ) const;
/**
- * @brief Sets a column to have fixed width
- * Setting a fixed width of 0 has no effect
+ * @brief Sets a column to have fixed width.
+ * Setting a fixed width of 0 has no effect.
* @SINCE_1_0.0
- * @param columnIndex for column with fixed width
- * @param width in world coordinate units
+ * @param columnIndex The columnIndex for column with fixed width
+ * @param width The width in world coordinate units
* @pre The column columnIndex must exist.
*/
void SetFixedWidth( unsigned int columnIndex, float width );
* @brief Gets a column's fixed width.
* @SINCE_1_0.0
* @param[in] columnIndex The column index with fixed width
- * @return width in world coordinate units.
+ * @return Width in world coordinate units
* @pre The column columnIndex must exist.
* @note The returned value is valid if it has been set before.
*/
/**
* @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
+ * the remainder of table width after subtracting Padding and Fixed width columns.
+ * Setting a relative width of 0 has no effect.
* @SINCE_1_0.0
- * @param columnIndex for column with fixed width
- * @param widthPercentage between 0.0f and 1.0f
+ * @param columnIndex The columnIndex for column with fixed width
+ * @param widthPercentage The widthPercentage between 0.0f and 1.0f
* @pre The column columnIndex must exist.
*/
void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
* @brief Gets a column's relative width.
* @SINCE_1_0.0
* @param[in] columnIndex The column index with relative width
- * @return width in percentage units, between 0.0f and 1.0f.
+ * @return Width in percentage units, between 0.0f and 1.0f
* @pre The column columnIndex must exist.
* @note The returned value is valid if it has been set before.
*/
/**
* @brief Gets the amount of rows in the table.
* @SINCE_1_0.0
- * @return the amount of rows in the table
+ * @return The amount of rows in the table
*/
unsigned int GetRows();
/**
* @brief Gets the amount of columns in the table.
* @SINCE_1_0.0
- * @return the amount of columns in the table
+ * @return The amount of columns in the table
*/
unsigned int GetColumns();
/**
- * @brief Set the alignment on a cell.
+ * @brief Sets the alignment on a cell.
*
* 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.
+ * @param[in] position The cell to set alignment on
+ * @param[in] horizontal The horizontal alignment
+ * @param[in] vertical The vertical alignment
*/
void SetCellAlignment( CellPosition position, HorizontalAlignment::Type horizontal, VerticalAlignment::Type vertical );
/**
* @brief Creates a handle using the Toolkit::Internal implementation.
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL TableView(Internal::TableView& 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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal );
/// @endcond
/**
* @brief A control which provides a multi-line editable text editor.
*
- * * Signals
+ * Signals
* | %Signal Name | Method | |
* |----------------------|--------------------------------|--------------------|
* | textChanged | @ref TextChangedSignal() | @SINCE_1_1.37 |
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_1.37
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the TextEditor class.
+ * @brief Enumeration for the instance of properties belonging to the TextEditor class.
* @SINCE_1_1.37
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the TextEditor class.
+ * @brief Enumeration for the instance of properties belonging to the TextEditor class.
* @SINCE_1_1.37
*/
enum
struct InputStyle
{
/**
- * @brief Mask used by the signal InputStyleChangedSignal().
- *
+ * @brief Enumeration for mask used by the signal InputStyleChangedSignal().
* @SINCE_1_2_2
*/
enum Mask
typedef Signal<void ( TextEditor, InputStyle::Mask ) > InputStyleChangedSignalType;
/**
- * @brief Create the TextEditor control.
+ * @brief Creates the TextEditor control.
*
* @SINCE_1_1.37
- * @return A handle to the TextEditor control.
+ * @return A handle to the TextEditor control
*/
static TextEditor New();
* @brief Copy constructor.
*
* @SINCE_1_1.37
- * @param[in] handle The handle to copy from.
+ * @param[in] handle The handle to copy from
*/
TextEditor( const TextEditor& handle );
* @brief Assignment operator.
*
* @SINCE_1_1.37
- * @param[in] handle The handle to copy from.
- * @return A reference to this.
+ * @param[in] handle The handle to copy from
+ * @return A reference to this
*/
TextEditor& operator=( const TextEditor& handle );
~TextEditor();
/**
- * @brief Downcast a handle to TextEditor.
+ * @brief Downcasts a handle to TextEditor.
*
- * If the BaseHandle points is a TextEditor the downcast returns a valid handle.
- * If not the returned handle is left empty.
+ * If the BaseHandle points is a TextEditor, the downcast returns a valid handle.
+ * If not, the returned handle is left empty.
*
* @SINCE_1_1.37
- * @param[in] handle Handle to an object.
- * @return handle to a TextEditor or an empty handle.
+ * @param[in] handle Handle to an object
+ * @return Handle to a TextEditor or an empty handle
*/
static TextEditor DownCast( BaseHandle handle );
* @endcode
*
* @SINCE_1_1.37
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
TextChangedSignalType& TextChangedSignal();
* @endcode
*
* @SINCE_1_2_2
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
InputStyleChangedSignalType& InputStyleChangedSignal();
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_1.37
- * @param[in] implementation The Control implementation.
+ * @param[in] implementation The Control implementation
*/
DALI_INTERNAL TextEditor( Internal::TextEditor& implementation );
* @brief Allows the creation of this Control from an Internal::CustomActor pointer.
*
* @SINCE_1_1.37
- * @param[in] internal A pointer to the internal CustomActor.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL TextEditor( Dali::Internal::CustomActor* internal );
/// @endcond
/**
* @brief A control which provides a single-line editable text field.
*
- * * Signals
+ * Signals
* | %Signal Name | Method | |
* |----------------------|--------------------------------|--------------------|
* | textChanged | @ref TextChangedSignal() | @SINCE_1_0.0 |
};
/**
- * @brief An enumeration of properties belonging to the TextField class.
+ * @brief Enumeration for the instance of properties belonging to the TextField class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the TextField class.
+ * @brief Enumeration for the instance of properties belonging to the TextField class.
* @SINCE_1_0.0
*/
enum
};
/**
- * @brief Specifies how the text is truncated when it does not fit
+ * @brief Enumeration for specifying how the text is truncated when it does not fit.
*
* The default value is \e EXCEED_POLICY_CLIP.
* @SINCE_1_0.0
typedef Signal<void ( TextField, InputStyle::Mask ) > InputStyleChangedSignalType;
/**
- * @brief Create the TextField control.
+ * @brief Creates the TextField control.
* @SINCE_1_0.0
- * @return A handle to the TextField control.
+ * @return A handle to the TextField control
*/
static TextField New();
* @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param[in] handle The handle to copy from.
+ * @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.
+ * @param[in] handle The handle to copy from
+ * @return A reference to this
*/
TextField& operator=( const TextField& handle );
~TextField();
/**
- * @brief Downcast a handle to TextField.
+ * @brief Downcasts a handle to TextField.
*
- * If the BaseHandle points is a TextField the downcast returns a valid handle.
- * If not the returned handle is left empty.
+ * 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.
+ * @param[in] handle Handle to an object
+ * @return Handle to a TextField or an empty handle
*/
static TextField DownCast( BaseHandle handle );
* void YourCallbackName( TextField textField );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
MaxLengthReachedSignalType& MaxLengthReachedSignal();
* @endcode
*
* @SINCE_1_2_2
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
InputStyleChangedSignalType& InputStyleChangedSignal();
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
};
public:
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
};
/**
- * @brief An enumeration of properties belonging to the TextLabel class.
+ * @brief Enumeration for the instance of properties belonging to the TextLabel class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the TextLabel class.
+ * @brief Enumeration for the instance of properties belonging to the TextLabel class.
* @SINCE_1_0.0
*/
enum
{
/**
- * @brief The type of rendering e.g. bitmap-based
- * @details name "renderingBackend", type INT, default RENDERING_SHARED_ATLAS
+ * @brief The type of rendering e.g. bitmap-based.
+ * @details name "renderingBackend", type INT, default RENDERING_SHARED_ATLAS.
* @SINCE_1_0.0
*/
RENDERING_BACKEND = PROPERTY_START_INDEX,
/**
- * @brief The text to display in UTF-8 format,
- * @details name "text", type STRING
+ * @brief The text to display in UTF-8 format.
+ * @details name "text", type STRING.
* @SINCE_1_0.0
*/
TEXT,
/**
- * @brief The requested font family to use,
- * @details name "fontFamily", type STRING
+ * @brief The requested font family to use.
+ * @details name "fontFamily", type STRING.
* @SINCE_1_0.0
*/
FONT_FAMILY,
/**
- * @brief The requested font style to use,
- * @details name "fontStyle", type STRING or MAP
+ * @brief The requested font style to use.
+ * @details name "fontStyle", type STRING or MAP.
* @SINCE_1_2.13
*/
FONT_STYLE,
/**
- * @brief The size of font in points
- * @details name "pointSize", type FLOAT
+ * @brief The size of font in points.
+ * @details name "pointSize", type FLOAT.
* @SINCE_1_0.0
*/
POINT_SIZE,
/**
- * @brief The single-line or multi-line layout option
- * @details name "multiLine", type BOOLEAN, default false
+ * @brief The single-line or multi-line layout option.
+ * @details name "multiLine", type BOOLEAN, default false.
* @SINCE_1_0.0
*/
MULTI_LINE,
/**
- * @brief The line horizontal alignment
- * @details name "horizontalAlignment", type STRING, values "BEGIN", "CENTER", "END", default BEGIN
+ * @brief The line horizontal alignment.
+ * @details name "horizontalAlignment", type STRING, values "BEGIN", "CENTER", "END", default BEGIN.
* @SINCE_1_0.0
*/
HORIZONTAL_ALIGNMENT,
/**
- * @brief The line vertical alignment
- * @details name "verticalAlignment", type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP
+ * @brief The line vertical alignment.
+ * @details name "verticalAlignment", type STRING, values "TOP", "CENTER", "BOTTOM" @SINCE_1_0.0, default TOP.
* @SINCE_1_0.0
*/
VERTICAL_ALIGNMENT,
/**
- * @brief The color of the text
- * @details name "textColor", type VECTOR4
+ * @brief The color of the text.
+ * @details name "textColor", type VECTOR4.
* @SINCE_1_0.0
*/
TEXT_COLOR,
/**
- * @brief The drop shadow offset 0 indicates no shadow
- * @details name "shadowOffset", type VECTOR2
* @DEPRECATED_1_1.37 Use SHADOW instead
+ * @brief The drop shadow offset 0 indicates no shadow.
+ * @details name "shadowOffset", type VECTOR2.
*/
SHADOW_OFFSET,
/**
- * @brief The color of a drop shadow
- * @details name "shadowColor", type VECTOR4
* @DEPRECATED_1_1.37 Use SHADOW instead
+ * @brief The color of a drop shadow.
+ * @details name "shadowColor", type VECTOR4
*/
SHADOW_COLOR,
/**
- * @brief The underline enabled flag
- * @details name "underlineEnabled", type BOOLEAN
* @DEPRECATED_1_1.37 Use UNDERLINE instead
+ * @brief The underline enabled flag.
+ * @details name "underlineEnabled", type BOOLEAN.
*/
UNDERLINE_ENABLED,
/**
- * @brief The color of the underline
- * @details name "underlineColor", type VECTOR4
* @DEPRECATED_1_1.37 Use UNDERLINE instead
+ * @brief The color of the underline.
+ * @details name "underlineColor", type VECTOR4.
*/
UNDERLINE_COLOR,
/**
- * @brief Overrides the underline height from font metrics
- * @details name "underlineHeight", type FLOAT
* @DEPRECATED_1_1.37 Use UNDERLINE instead
+ * @brief Overrides the underline height from font metrics.
+ * @details name "underlineHeight", type FLOAT.
*/
UNDERLINE_HEIGHT,
/**
- * @brief Whether the mark-up processing is enabled
- * @details name "enableMarkup", type BOOLEAN
+ * @brief Whether the mark-up processing is enabled.
+ * @details name "enableMarkup", type BOOLEAN.
* @SINCE_1_0.0
*/
ENABLE_MARKUP,
/**
- * @brief Start or stop auto scrolling,
- * @details name "enableAutoScroll", type BOOLEAN, default is false
+ * @brief Starts or stops auto scrolling.
+ * @details name "enableAutoScroll", type BOOLEAN, default is false.
* @SINCE_1_1.35
*/
ENABLE_AUTO_SCROLL,
/**
- * @brief Sets the speed of scrolling in pixels per second,
- * @details name "autoScrollSpeed", type INT, default in style sheet
+ * @brief Sets the speed of scrolling in pixels per second.
+ * @details name "autoScrollSpeed", type INT, default in style sheet.
* @SINCE_1_1.35
*/
AUTO_SCROLL_SPEED,
/**
- * @brief Number of complete loops when scrolling enabled
- * @details name "autoScrollLoopCount", type INT, default in style sheet
+ * @brief Number of complete loops when scrolling enabled.
+ * @details name "autoScrollLoopCount", type INT, default in style sheet.
* @SINCE_1_1.35
*/
AUTO_SCROLL_LOOP_COUNT,
/**
- * @brief Gap before before scrolling wraps
- * @details name "autoScrollGap", type INT, default in style sheet but can be overridden to prevent same text being show at start and end.
+ * @brief Gap before scrolling wraps.
+ * @details name "autoScrollGap", type INT, default in style sheet but can be overridden to prevent same text being shown at start and end.
* @SINCE_1_1.35
*/
AUTO_SCROLL_GAP,
};
/**
- * @brief Create the TextLabel control.
+ * @brief Creates the TextLabel control.
*
* @SINCE_1_0.0
- * @return A handle to the TextLabel control.
+ * @return A handle to the TextLabel control
*/
static TextLabel New();
/**
- * @brief Create the TextLabel control.
+ * @brief Creates the TextLabel control.
*
* @SINCE_1_0.0
- * @param[in] text The text to display.
- * @return A handle to the TextLabel control.
+ * @param[in] text The text to display
+ * @return A handle to the TextLabel control
*/
static TextLabel New( const std::string& text );
* @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param[in] handle The handle to copy from.
+ * @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.
+ * @param[in] handle The handle to copy from
+ * @return A reference to this
*/
TextLabel& operator=( const TextLabel& handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~TextLabel();
/**
- * @brief Downcast a handle to TextLabel.
+ * @brief Downcasts a handle to TextLabel.
*
- * If the BaseHandle points is a TextLabel the downcast returns a valid handle.
- * If not the returned handle is left empty.
+ * 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
+ * @return Handle to a TextLabel or an empty handle
*/
static TextLabel DownCast( BaseHandle handle );
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_0.0
- * @param[in] implementation The Control implementation.
+ * @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.
+ * @param[in] internal A pointer to the internal CustomActor
*/
explicit DALI_INTERNAL TextLabel( Dali::Internal::CustomActor* internal );
/// @endcond
typedef Signal< void (VideoView&) > VideoViewSignalType; ///< Video playback finished signal type @ SINCE_1_1.38
/**
- * @brief The start and end property ranges for this control.
+ * @brief Enumeration for the start and end property ranges for this control.
* @SINCE_1_0.0
*/
enum PropertyRange
enum
{
/**
- * @brief name "video", video file url as string type or Property::Map
+ * @brief name "video", video file url as string type or Property::Map.
* @SINCE_1_1.38
*/
VIDEO = PROPERTY_START_INDEX,
/**
- * @brief name "looping", looping status, true or false
+ * @brief name "looping", looping status, true or false.
* @SINCE_1_1.38
*/
LOOPING,
/**
- * @brief name "muted", mute status, true or false
+ * @brief name "muted", mute status, true or false.
* @SINCE_1_1.38
*/
MUTED,
/**
- * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" )
+ * @brief name "volume", left and right volume scalar as float type, Property::Map with two values ( "left" and "right" ).
* @SINCE_1_1.38
*/
VOLUME
/**
* @brief Creates an initialized VideoView.
- * If the string is empty, VideoView will not display anything
+ * If the string is empty, VideoView will not display anything.
*
* @SINCE_1_1.38
* @REMARK_INTERNET
static VideoView New( const std::string& url );
/**
- * @brief Create an uninitialized VideoView
+ * @brief Creates an uninitialized VideoView.
* @SINCE_1_1.38
*/
VideoView();
/**
- * @brief Destructor
+ * @brief Destructor.
*
- * This is non-virtual since derived Handel types must not contain data or virtual methods
+ * This is non-virtual since derived Handel types must not contain data or virtual methods.
* @SINCE_1_1.38
*/
~VideoView();
/*
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_1.38
* @param[in] videoView VideoView to copy. The copied VideoView will point at the same implementation
* @brief Assignment operator.
*
* @SINCE_1_1.38
- * @param[in] videoView The VideoView to assign from.
- * @return The updated VideoView.
+ * @param[in] videoView The VideoView to assign from
+ * @return The updated VideoView
*/
VideoView& operator=( const VideoView& videoView );
/**
- * @brief Downcast a handle to VideoView handle.
+ * @brief Downcasts a handle to VideoView handle.
*
- * If handle points to a VideoView the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If handle points to a VideoView, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_1.38
* @param[in] handle Handle to an object
- * @return handle to a VideoView or an uninitialized handle
+ * @return Handle to a VideoView or an uninitialized handle
*/
static VideoView DownCast( BaseHandle handle );
void Backward( int millisecond );
/**
- * @brief Connect to this signal to be notified when a video playback have finished.
+ * @brief Connects to this signal to be notified when a video playback is finished.
*
* @SINCE_1_1.38
- * @return A signal object to connect with.
+ * @return A signal object to connect with
*/
VideoViewSignalType& FinishedSignal();
* @brief Creates a handle using the Toolkit::Internal implementation.
*
* @SINCE_1_1.38
- * @param[in] implementation The VideoView implementation.
+ * @param[in] implementation The VideoView implementation
*/
DALI_INTERNAL VideoView( Internal::VideoView& implementation );
* @brief Allows the creation of this VideoView from an Internal::CustomActor pointer.
*
* @SINCE_1_1.38
- * @param[in] internal A pointer to the internal CustomActor.
+ * @param[in] internal A pointer to the internal CustomActor
*/
DALI_INTERNAL VideoView( Dali::Internal::CustomActor* internal );
/// @endcond
} // namespace ControlOrientation
/**
- * @brief Query whether an orientation is vertical.
+ * @brief Queries whether an orientation is vertical.
*
- * @param[in] orientation The orientation.
- * @return true if the orientation is vertical.
+ * @param[in] orientation The orientation
+ * @return true if the orientation is vertical
*/
DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation);
/**
- * @brief Query whether an orientation is horizontal.
+ * @brief Queries whether an orientation is horizontal.
*
* @SINCE_1_0.0
- * @param[in] orientation The orientation.
- * @return true if the orientation is horizontal.
+ * @param[in] orientation The orientation
+ * @return true if the orientation is horizontal
*/
DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation);
typedef Signal< void ( Actor ) > FocusedActorEnterKeySignalType;
/**
- * @brief Create a KeyboardFocusManager handle; this can be initialised with KeyboardFocusManager::New().
+ * @brief Creates a KeyboardFocusManager handle; this can be initialized with KeyboardFocusManager::New().
*
- * Calling member functions with an uninitialised handle is not allowed.
+ * Calling member functions with an uninitialized handle is not allowed.
* @SINCE_1_0.0
*/
KeyboardFocusManager();
/**
- * @brief Destructor
+ * @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.
+ * @brief Gets the singleton of KeyboardFocusManager object.
*
* @SINCE_1_0.0
- * @return A handle to the KeyboardFocusManager control.
+ * @return A handle to the KeyboardFocusManager control
*/
static KeyboardFocusManager Get();
/**
- * @brief Move the keyboard focus to the given actor.
+ * @brief Moves the keyboard focus to the given actor.
*
* Only one actor can be focused at the same time. The actor must
* be in the stage already and keyboard focusable.
bool SetCurrentFocusActor(Actor actor);
/**
- * @brief Get the current focused actor.
+ * @brief Gets the current focused actor.
*
* @SINCE_1_0.0
- * @return A handle to the current focused actor or an empty handle if no actor is focused.
+ * @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();
/**
- * @brief Move the focus to the next focusable actor in the focus
+ * @brief Moves the focus to the next focusable actor in the focus
* chain in the given direction (according to the focus traversal
* order).
*
bool MoveFocus(Control::KeyboardFocus::Direction direction);
/**
- * @brief Clear the focus from the current focused actor if any, so
+ * @brief Clears the focus from the current focused actor if any, so
* that no actor is focused in the focus chain.
*
* It will emit focus changed signal without current focused actor.
void ClearFocus();
/**
- * @brief Set whether the focus movement should be looped within the same focus group.
+ * @brief Sets whether the focus movement should be looped within the same focus group.
*
* The focus movement is not looped by default.
* @SINCE_1_0.0
void SetFocusGroupLoop(bool enabled);
/**
- * @brief Get whether the focus movement should be looped within the same focus group.
+ * @brief Gets whether the focus movement should be looped within the same focus group.
*
* @SINCE_1_0.0
* @return Whether the focus movement should be looped
bool GetFocusGroupLoop() const;
/**
- * @brief Set whether an actor is a focus group that can limit the
+ * @brief Sets whether an actor is a focus group that can limit the
* scope of focus movement to its child actors in the focus chain.
*
* Layout controls set themselves as focus groups by default.
*
* @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.
+ * @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.
+ * @brief Checks whether the actor is set as a focus group or not.
*
* @SINCE_1_0.0
- * @param actor The actor to be checked.
- * @return Whether the actor is set as a focus group.
+ * @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.
*/
Actor GetFocusGroup(Actor actor);
/**
- * @brief Set the focus indicator actor.
+ * @brief Sets the focus indicator actor.
*
* This will replace the default focus indicator actor in
* KeyboardFocusManager and will be added to the focused actor as a
void SetFocusIndicatorActor(Actor indicator);
/**
- * @brief Get the focus indicator actor.
+ * @brief Gets the focus indicator actor.
*
* @SINCE_1_0.0
* @return A handle to the focus indicator actor
* focus towards the given direction, but applications might want to
* change that. By connecting with this signal, they can check the
* proposed actor to focus and return a different actor if they
- * wish. This signal is only emitted when the navigation key is
+ * wish. This signal is only emitted when the navigation key is
* pressed and KeyboardFocusManager tries to move the focus
* automatically. It won't be emitted for focus movement by calling
* SetCurrentFocusActor directly.
* Actor YourCallbackName(Actor currentFocusedActor, Actor proposedActorToFocus, Control::KeyboardFocus::Direction direction);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
PreFocusChangeSignalType& PreFocusChangeSignal();
* void YourCallbackName(Actor originalFocusedActor, Actor currentFocusedActor);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
FocusChangedSignalType& FocusChangedSignal();
* void YourCallbackName(Actor currentFocusedActor, bool forward);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
FocusGroupChangedSignalType& FocusGroupChangedSignal();
* void YourCallbackName(Actor enterPressedActor);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @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.
+ * @param[in] impl A pointer to the object
*/
explicit DALI_INTERNAL KeyboardFocusManager(Internal::KeyboardFocusManager *impl);
/// @endcond
AsyncImageLoader();
/**
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_2_14
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
AsyncImageLoader& operator=( const AsyncImageLoader& handle );
/**
- * @brief Create a new loader to load the image asynchronously in a worker thread.
+ * @brief Creates a new loader to load the image asynchronously in a worker thread.
* @SINCE_1_2_14
*
- * @return The image loader.
+ * @return The image loader
*/
static AsyncImageLoader New();
/**
- * @brief Downcast a handle to AsyncImageLoader handle.
+ * @brief Downcasts a handle to AsyncImageLoader handle.
*
- * If the handle points to an AsyncImageLoader object the downcast produces
- * a valid handle. If not, the returned handle is left uninitialized.
+ * If the handle points to an AsyncImageLoader object, the downcast produces a valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_2_14
* @param[in] handle A handle to an object
static AsyncImageLoader DownCast( BaseHandle handle );
/**
- * @brief Start an image loading task.
+ * @brief Starts an image loading task.
* Note: When using this method, the following defaults will be used:
* fittingMode = FittingMode::DEFAULT
* samplingMode = SamplingMode::BOX_THEN_LINEAR
* @SINCE_1_2_14
* @REMARK_INTERNET
* @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @return The loading task id.
+ * @param[in] url The URL of the image file to load
+ * @return The loading task id
*/
uint32_t Load( const std::string& url );
/**
- * @brief Start an image loading task.
+ * @brief Starts an image loading task.
* Note: When using this method, the following defaults will be used:
* fittingMode = FittingMode::DEFAULT
* samplingMode = SamplingMode::BOX_THEN_LINEAR
* @SINCE_1_2_14
* @REMARK_INTERNET
* @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @return The loading task id.
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @return The loading task id
*/
uint32_t Load( const std::string& url, ImageDimensions dimensions );
/**
- * @brief Start an image loading task.
+ * @brief Starts an image loading task.
* @SINCE_1_2_14
* @REMARK_INTERNET
* @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
- * @return The loading task id.
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
+ * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
+ * @return The loading task id
*/
uint32_t Load( const std::string& url,
ImageDimensions dimensions,
bool orientationCorrection );
/**
- * @brief Cancel a image loading task if it is still queueing in the work thread.
+ * @brief Cancels an image loading task if it is still queueing in the work thread.
* @SINCE_1_2_14
*
* @param[in] loadingTaskId The task id returned when invoking the load call.
bool Cancel( uint32_t loadingTaskId );
/**
- * @brief Cancel all the loading tasks in the queue
+ * @brief Cancels all the loading tasks in the queue.
* @SINCE_1_2_14
*/
void CancelAll();
/**
- * @brief Signal emit for connected callback functions to get access to the loaded pixel data.
+ * @brief Signal emitted for connected callback functions to get access to the loaded pixel data.
*
* A callback of the following type may be connected:
* @code
* void YourCallbackName( uint32_t id, PixelData pixelData );
* @endcode
* @SINCE_1_2_14
- *
- * @return A reference to a signal object to Connect() with.
+ * @return A reference to a signal object to Connect() with
*/
ImageLoadedSignalType& ImageLoadedSignal();
*
* @note Not intended for application developers
* @SINCE_1_2_14
- *
- * @param[in] impl A pointer to the object.
+ * @param[in] impl A pointer to the object
*/
explicit DALI_INTERNAL AsyncImageLoader( Internal::AsyncImageLoader* impl );
/// @endcond
*/
/**
- * @brief Load an image synchronously.
+ * @brief Loads an image synchronously.
* Note: When using this method, the following defaults will be used:
* fittingMode = FittingMode::DEFAULT
* samplingMode = SamplingMode::BOX_THEN_LINEAR
* @SINCE_1_2_14
* @REMARK_INTERNET
* @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @return A PixelData object containing the image, or an invalid object on failure.
+ * @param[in] url The URL of the image file to load
+ * @return A PixelData object containing the image, or an invalid object on failure
*/
DALI_IMPORT_API PixelData Load( const std::string& url );
/**
- * @brief Load an image synchronously by specifying the target dimensions.
+ * @brief Loads an image synchronously by specifying the target dimensions.
* Note: When using this method, the following defaults will be used:
* fittingMode = FittingMode::DEFAULT
* samplingMode = SamplingMode::BOX_THEN_LINEAR
* @SINCE_1_2_14
* @REMARK_INTERNET
* @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @return A PixelData object containing the image, or an invalid object on failure.
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @return A PixelData object containing the image, or an invalid object on failure
*/
DALI_IMPORT_API PixelData Load( const std::string& url, ImageDimensions dimensions );
/**
- * @brief Load an image synchronously by specifying the target dimensions and options.
+ * @brief Loads an image synchronously by specifying the target dimensions and options.
* @SINCE_1_2_14
* @REMARK_INTERNET
* @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
- * @return A PixelData object containing the image, or an invalid object on failure.
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
+ * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
+ * @return A PixelData object containing the image, or an invalid object on failure
*/
DALI_IMPORT_API PixelData Load( const std::string& url,
ImageDimensions dimensions,
{
public:
- /// @brief Style Changed signal. Emitted after controls have been updated
+ /// @brief Style Changed signal. Emitted after controls have been updated.
typedef Signal< void ( StyleManager, StyleChange::Type ) > StyleChangedSignalType;
/**
- * @brief Create a StyleManager handle; this can be initialised with StyleManager::Get()
+ * @brief Creates a StyleManager handle; this can be initialized with StyleManager::Get().
*
- * Calling member functions with an uninitialised handle is not allowed.
+ * Calling member functions with an uninitialized handle is not allowed.
* @SINCE_1_1.32
*/
StyleManager();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_1.32
~StyleManager();
/**
- * @brief Get the singleton of StyleManager object.
+ * @brief Gets the singleton of StyleManager object.
*
* @SINCE_1_1.32
- * @return A handle to the StyleManager control.
+ * @return A handle to the StyleManager control
*/
static StyleManager Get();
/**
- * @brief Apply a new theme to the application. This will be merged
+ * @brief Applies a new theme to the application. This will be merged
* on top of the default Toolkit theme.
*
* If the application theme file doesn't style all controls that the
* On application startup, it is suggested that the theme file name is
* passed to Application::New instead of using this API to prevent
* controls being styled more than once.
- * @sa Application::New()
+ * @sa Application::New().
*
* @SINCE_1_1.32
* @param[in] themeFile If a relative path is specified, then this is relative
- * to the directory returned by Application::GetResourcePath().
+ * to the directory returned by Application::GetResourcePath()
*/
void ApplyTheme( const std::string& themeFile );
/**
- * @brief Apply the default Toolkit theme.
+ * @brief Applies the default Toolkit theme.
*
* Request that any application specific styling is removed
* and that the default Toolkit theme is re-applied.
void ApplyDefaultTheme();
/**
- * @brief Set a constant for use when building styles
+ * @brief Sets a constant for use when building styles.
*
* A constant is used in JSON files e.g. "myImage":"{RELATIVE_PATH}/image.jpg"
* where the string "{RELATIVE_PATH}" is substituted with the value.
void SetStyleConstant( const std::string& key, const Property::Value& value );
/**
- * @brief Return the style constant set for a specific key
+ * @brief Returns the style constant set for a specific key.
*
* @SINCE_1_1.32
* @param[in] key The key of the constant
* @param[out] valueOut The value of the constant if it exists
*
- * @return If the constant for key exists then return the constant in valueOut and return true
+ * @return If the constant for key exists, then return the constant in valueOut and return true
*/
bool GetStyleConstant( const std::string& key, Property::Value& valueOut );
/**
- * @brief Apply the specified style to the control.
+ * @brief Applies the specified style to the control.
*
* @SINCE_1_1.32
- * @param[in] control The control to which to apply the style.
+ * @param[in] control The control to which to apply the style
* @param[in] jsonFileName The name of the JSON style file to apply. If a
* relative path is specified, then this is relative to the directory
- * returned by Application::GetResourcePath().
- * @param[in] styleName The name of the style within the JSON file to apply.
+ * returned by Application::GetResourcePath()
+ * @param[in] styleName The name of the style within the JSON file to apply
*/
void ApplyStyle( Toolkit::Control control, const std::string& jsonFileName, const std::string& styleName );
* @code
* void YourCallbackName( StyleManager styleManager, StyleChange change );
* @endcode
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
StyleChangedSignalType& StyleChangedSignal();
*
* @note Not intended for application developers
* @SINCE_1_1.32
- * @param[in] impl A pointer to the object.
+ * @param[in] impl A pointer to the object
*/
explicit DALI_INTERNAL StyleManager( Internal::StyleManager *impl );
/// @endcond
{
/**
- * @brief The start and end property ranges.
+ * @brief Enumeration for the start and end property ranges.
* @SINCE_1_1.45
*/
enum PropertyRanges
projects / platform / core / uifw / dali-toolkit.git / commitdiff