class AccessibilityManager;
}
/**
- * @addtogroup dali_toolkit_accessibility_manager
+ * @addtogroup dali_toolkit_managers
* @{
*/
/**
- * @brief Manages registration of actors in a accessibility focus chain and changing the
+ * @brief Manages registration of actors in an accessibility focus chain and changing the
* focused actor within that chain.
*
* This class provides the functionality of registering the focus order and description
* @brief Accessibility Action Signal.
*
* The connected signal callback should return true if handled.
+ * @SINCE_1_0.0
*/
typedef Signal< bool ( AccessibilityManager& ) > AccessibilityActionSignalType; ///< Generic signal type @SINCE_1_0.0
typedef Signal< bool ( AccessibilityManager&, const Dali::TouchEvent& )> AccessibilityActionScrollSignalType; ///< Scroll signal type @SINCE_1_0.0
public:
/// @brief Focus changed signal
+ /// @SINCE_1_0.0
typedef Signal< void ( Actor, Actor ) > FocusChangedSignalType;
/// @brief Focus overshooted signal
+ /// @SINCE_1_0.0
typedef Signal< void ( Actor, FocusOvershotDirection ) > FocusOvershotSignalType;
/// @brief Focused actor activated signal
+ /// @SINCE_1_0.0
typedef Signal< void ( Actor ) > FocusedActorActivatedSignalType;
/**
/**
* @brief Get the actor that has the specified focus order.
*
- * It will return an empty handle if the actor is not in the stage
- * or has a focus order of 0.
+ * It will return an empty handle if no actor in the stage
+ * has the specified focus order.
*
* @SINCE_1_0.0
* @param order The focus order of the actor
* @brief Clear 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
+ * It will emit focus changed signal without current focused actor.
* @SINCE_1_0.0
* @pre The AccessibilityManager has been initialized.
*/
*/
FocusedActorActivatedSignalType& FocusedActorActivatedSignal();
- public: // Accessibility action signals.
+ public: // Accessibility action signals
/**
* @brief This is emitted when accessibility(screen-reader) feature turned on or off.
/**
* @brief This is emitted when accessibility action is received to scroll left to the
- * previous page (by two finger swipe left)
+ * previous page (by two finger swipe left).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to scroll right to the
- * next page (by two finger swipe right)
+ * next page (by two finger swipe right).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to scroll up to the
- * previous page (by one finger swipe left and right)
+ * previous page (by one finger swipe left and right).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to scroll down to the
- * next page (by one finger swipe right and left)
+ * next page (by one finger swipe right and left).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to move the focus to
- * the first item on the screen (by one finger swipe up and down)
+ * the first item on the screen (by one finger swipe up and down).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to move the focus to
- * the last item on the screen (by one finger swipe down and up)
+ * the last item on the screen (by one finger swipe down and up).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to focus and read from the
- * first item on the top continously (by three fingers single tap)
+ * first item on the top continously (by three fingers single tap).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to move the focus to and
- * read from the next item continously (by three fingers double tap)
+ * read from the next item continously (by three fingers double tap).
*
* A callback of the following type may be connected:
* @code
/**
* @brief This is emitted when accessibility action is received to zoom (by one finger
- * triple tap)
+ * triple tap).
*
* A callback of the following type may be connected:
* @code
*/
enum Type
{
- HorizontalLeft = 1,
- HorizontalCenter = 2,
- HorizontalRight = 4,
- VerticalTop = 8,
- VerticalCenter = 16,
- VerticalBottom = 32
+ HorizontalLeft = 1, ///< Horizontal left alignment @SINCE_1_0.0
+ HorizontalCenter = 2, ///< Horizontal center alignment @SINCE_1_0.0
+ HorizontalRight = 4, ///< Horizontal right alignment @SINCE_1_0.0
+ VerticalTop = 8, ///< Vertical top alignment @SINCE_1_0.0
+ VerticalCenter = 16, ///< Vertical center alignment @SINCE_1_0.0
+ VerticalBottom = 32 ///< Vertical bottom alignment @SINCE_1_0.0
};
/**
~Alignment();
/**
- * @brief Downcast an Object handle to Alignment.
+ * @brief Downcast a handle to Alignment handle.
*
* If handle points to a Alignment the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a Alignment or an uninitialized handle
+ * @return A handle to a Alignment or an uninitialized handle
*/
static Alignment DownCast( BaseHandle handle );
*
* @SINCE_1_0.0
* @param [in] type The new alignment option.
- * @note there should only be one horizontal and one vertical policy
+ * @note There should only be one horizontal and one vertical policy.
*/
void SetAlignmentType( Type type );
Button& operator=( const Button& button );
/**
- * @brief Downcast an Object handle to Button.
+ * @brief Downcast a handle to Button handle.
*
* If handle points to a Button the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a Button or an uninitialized handle
+ * @return A handle to a Button or an uninitialized handle
*/
static Button DownCast( BaseHandle handle );
void SetDisabled( bool disabled );
/**
+ * @brief Returns if the button is disabled.
* @SINCE_1_0.0
* @return \e true if the button is \e disabled.
*/
void SetAutoRepeating( bool autoRepeating );
/**
+ * @brief Returns if the autorepeating property is set.
* @SINCE_1_0.0
* @return \e true if the \e autorepeating property is set.
*/
void SetInitialAutoRepeatingDelay( float initialAutoRepeatingDelay );
/**
+ * @brief Gets the initial autorepeating delay in seconds.
* @SINCE_1_0.0
* @return the initial autorepeating delay in seconds.
*/
void SetNextAutoRepeatingDelay( float nextAutoRepeatingDelay );
/**
+ * @brief Gets the next autorepeating delay in seconds.
* @SINCE_1_0.0
* @return the next autorepeating delay in seconds.
*/
void SetTogglableButton( bool togglable );
/**
+ * @brief Returns if the togglable property is set.
* @SINCE_1_0.0
* @return \e true if the \e togglable property is set.
*/
void SetSelected( bool selected );
/**
+ * @brief Returns if the selected property is set and the button is togglable.
* @SINCE_1_0.0
- * @return \e true if the \e selected property is set and the button is togglable.
+ * @return \e true if the button is \e selected.
*/
bool IsSelected() const;
// Deprecated API
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use SetLabelText.
*
* @brief Sets the label with an actor.
*
void SetLabel( Actor label );
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use SetUnselectedImage.
*
* @brief Sets the button image.
*
void SetButtonImage( Image image );
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use SetSelectedImage( const std::string& filename ).
*
* @brief Sets the selected image.
*
* @brief Gets the button image.
*
* @SINCE_1_0.0
+ * @remarks Avoid using this method as it's a legacy code.
* @return An actor with the button image.
*/
Actor GetButtonImage() const;
* @brief Gets the selected image.
*
* @SINCE_1_0.0
+ * @remarks Avoid using this method as it's a legacy code.
* @return An actor with the selected image.
*/
Actor GetSelectedImage() const;
/**
* @brief This signal is emitted when the button's state is changed.
+ *
* The application can get the state by calling IsSelected().
*
* A callback of the following type may be connected:
*
* 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 setting images or actors with CheckBoxButton::SetBackgroundImage,
- * CheckBoxButton::SetSelectedImage, CheckBoxButton::SetDisabledBackgroundImage and CheckBoxButton::SetDisabledSelectedImage.
+ * The button's appearance could be modified by Button::SetUnselectedImage, Button::SetBackgroundImage,
+ * Button::SetSelectedImage, Button::SetSelectedBackgroundImage, Button::SetDisabledBackgroundImage,
+ * Button::SetDisabledImage, and Button::SetDisabledSelectedImage.
*
* When the button is not disabled, if it's not selected it only shows the \e background image. The \e selected image is shown over the
* \e background image when the box is selected (\e background image is not replaced by \e selected image).
*
* When the button is disabled, \e background image and \e selected image are replaced by \e disabled images.
*
- * CheckBoxButton doesn't have a text. However, a Dali::Toolkit::TableView with a Dali::TextActor or a Dali::Toolkit::TextView
- * and a CheckBoxButton could be used instead.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API CheckBoxButton : public Button
public:
/**
- * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New()
+ * @brief Create an uninitialized CheckBoxButton; this can be initialized with CheckBoxButton::New().
* Calling member functions with an uninitialized Dali::Object is not allowed.
* @SINCE_1_0.0
*/
static CheckBoxButton New();
/**
- * @brief Downcast an Object handle to CheckBoxButton. If handle points to a CheckBoxButton the
+ * @brief Downcast a handle to CheckBoxButton handle.
+ *
+ * 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
static PushButton New();
/**
- * @brief Downcast an Object handle to PushButton.
+ * @brief Downcast a handle to PushButton handle.
*
* If handle points to a PushButton the downcast produces valid
* handle. If not the returned handle is left uninitialized.
using Button::SetButtonImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetUnselectedImage.
*
* @brief Sets the unselected image with an Actor.
*
using Button::SetBackgroundImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetBackgroundImage.
*
* @brief Sets the background image with an Actor.
*
using Button::SetSelectedImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedImage( const std::string& filename ).
*
* @brief Sets the selected image with an Actor.
*
using Button::SetSelectedBackgroundImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetSelectedBackgroundImage.
*
* @brief Sets the selected background image with an Actor.
*
using Button::SetDisabledBackgroundImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledBackgroundImage.
*
* @brief Sets the disabled background image with an Actor.
*
using Button::SetDisabledImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledImage.
*
* @brief Sets the disabled image with an Actor.
*
using Button::SetDisabledSelectedImage;
/**
- * @DEPRECATED_1_0.50
+ * @DEPRECATED_1_0.50. Instead, use Button::SetDisabledSelectedImage.
*
* @brief Sets the disabled selected image with an Actor.
*
*
* Radio buttons are designed to select one of many option at the same time.
*
- * Every button have its own \e label and \e state, which can be modified by RadioButton::SetLabel and Button::SetSelected.
+ * Every button have its own \e label and \e state, which can be modified by Button::SetLabelText and Button::SetSelected.
*
* RadioButton can change its current state using Button::SetSelected.
*
* When \e selected RadioButton is set to \e unselected no other RadioButtons in his group is set to \e selected.
*
* A Button::StateChangedSignal() is emitted when the RadioButton change its state to \e selected or \e unselected.
+ *
+ * Usage example: -
+ *
+ * @code
+ * // in Creating a DALi Application
+ *
+ * // Create a group to bind two or more RadioButtons together
+ * Actor radioGroup = Actor::New();
+ * radioGroup.SetParentOrigin( ParentOrigin::CENTER );
+ * Stage::GetCurrent().Add( radioGroup );
+ *
+ * // Make the first RadioButton and add it to its parent
+ * RadioButton button1 = RadioButton::New();
+ * button1.SetLabelText( "button1" );
+ * button1.SetBackgroundColor( Color::WHITE );
+ * button1.SetPosition( 0, -40 );
+ * radioGroup.Add( button1 );
+ *
+ * // Make more RadioButtons and add them to their parent
+ * RadioButton button2 = RadioButton::New();
+ * button2.SetLabelText( "button2" );
+ * button2.SetBackgroundColor( Color::WHITE );
+ * button2.SetPosition( 0, 40 );
+ * radioGroup.Add( button2 );
+ *
+ * @endcode
* @SINCE_1_0.0
*/
class DALI_IMPORT_API RadioButton: public Button
static RadioButton New( const std::string& label );
/**
- * @brief Downcast an Object handle to RadioButton.
+ * @brief Downcast a handle to RadioButton handle.
*
* If handle points to a RadioButton the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a RadioButton or an uninitialized handle
+ * @return A handle to a RadioButton or an uninitialized handle
*/
static RadioButton DownCast( BaseHandle handle );
/**
* @brief This method should be overridden by deriving classes when they wish to respond
- * the accessibility zoom action
+ * the accessibility zoom action.
*
* @SINCE_1_0.0
* @return true if the zoom action has been consumed by this control
};
/**
- * @brief Get implementation from the handle
+ * @brief Get implementation from the handle.
*
* @SINCE_1_0.0
* @param handle
DALI_IMPORT_API Internal::Control& GetImplementation( Dali::Toolkit::Control& handle );
/**
- * @brief Get implementation from the handle
+ * @brief Get implementation from the handle.
*
* @SINCE_1_0.0
* @param handle
/**
* @brief Copy constructor.
*
- * Creates another handle that points to the same real object
+ * Creates another handle that points to the same real object.
* @SINCE_1_0.0
* @param[in] uiControl Handle to copy
*/
Control(const Control& uiControl);
/**
- * @brief Dali::Control is intended as a base class
+ * @brief Dali::Control is intended as a base class.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
/**
* @brief Assignment operator.
*
- * Changes this handle to point to another real object
+ * Changes this handle to point to another real object.
* @SINCE_1_0.0
* @param[in] handle Object to assign this to
* @return reference to this
public:
/**
- * @brief Downcast an Object handle to Control.
+ * @brief Downcast a handle to Control handle.
*
* If handle points to a Control the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a Control or an uninitialized handle
+ * @return A handle to a Control or an uninitialized handle
*/
static Control DownCast( BaseHandle handle );
*
* The key event can originate from a virtual or physical keyboard.
* @SINCE_1_0.0
- * @return True if the control has foucs, False otherwise.
* @pre The Control has been initialized.
* @pre The Control should be on the stage before setting keyboard focus.
*/
/**
* @brief Quries whether the control has key input focus.
*
- * Note: The control can be set to have the focus and still not receive all the key events if another control has over ridden it.
- * 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()
* @SINCE_1_0.0
* @return true if this control has keyboard input focus
* @pre The Control has been initialized.
* @pre The Control should be on the stage before setting keyboard focus.
+ * @note The control can be set to have the focus and still not receive all the key events if another control has over ridden it.
+ * As the key input focus mechanism works like a stack, the top most control receives all the key events, and passes on the
+ * unhandled events to the controls below in the stack. A control in the stack will regain key input focus when there are no more
+ * controls above it in the focus stack.
+ * To query for the conrol which is on top of the focus stack use Dali::Toolkit::KeyInputFocusManager::GetCurrentKeyboardFocusActor().
*/
bool HasKeyInputFocus();
KeyEventSignalType& KeyEventSignal();
/**
- * @brief This signal is emitted when the control gets Key Input Focus
+ * @brief This signal is emitted when the control gets Key Input Focus.
*
* A callback of the following type may be connected:
* @code
* If the \e border parameter is set to \e true, the Dali::ImageActor's style is set to Dali::ImageActor::STYLE_NINE_PATCH.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release. We do recommend not to use it.
* @param[in] color The ImageActor's color.
* @param[in] border If \e true, a border is created. By default, the value is set to \e false.
* @param[in] borderColor The color for the ImageActor's border. By default, the value is set to Color::WHITE.
* @param[in] borderSize The size for the ImageActor's border. By default, the value is set to 1 pixel. It supports under 10 pixel for clear result of gl blend
* @return a handle to the new ImageActor
+ * @see Control
*/
DALI_IMPORT_API ImageActor CreateSolidColorActor( const Vector4& color, bool border = false, const Vector4& borderColor = Color::WHITE, const unsigned int borderSize = 1 );
} // namespace Toolkit
*
* Usage example:-
*
- * // initialise\n
- * GaussianBlurView gaussianBlurView = GaussianBlurView::New();\n
+ * @code
+ * // Initialise
+ * GaussianBlurView gaussianBlurView = GaussianBlurView::New();
*
- * // create and add some visible actors to the GaussianBlurView, all these child actors will therefore get blurred.\n
- * Image image = Image::New(...);\n
- * ImageActor imageActor = ImageActor::New(image);\n
- * gaussianBlurView.Add(imageActor);\n
- * ...\n
+ * // Create and add some visible actors to the GaussianBlurView, all these child actors will therefore get blurred.
+ * Image image = Image::New(...);
+ * ImageView imageView = ImageView::New(image);
+ * gaussianBlurView.Add(imageView);
+ * ...
*
- * // Start rendering the GaussianBlurView\n
- * Stage::GetCurrent().Add(gaussianBlurView);\n
- * gaussianBlurView.Activate();\n
- * ...\n
+ * // Start rendering the GaussianBlurView
+ * Stage::GetCurrent().Add(gaussianBlurView);
+ * gaussianBlurView.Activate();
+ * ...
*
- * // animate the strength of the blur - this can fade between no blur and full blur. See GetBlurStrengthPropertyIndex().\n
- * Animation blurAnimation = Animation::New( ... );\n
- * blurAnimation.AnimateTo( Property( gaussianBlurView, gaussianBlurView.GetBlurStrengthPropertyIndex() ), ... );\n
- * blurAnimation.Play();\n
+ * // Animate the strength of the blur - this can fade between no blur and full blur. See GetBlurStrengthPropertyIndex().
+ * Animation blurAnimation = Animation::New( ... );
+ * blurAnimation.AnimateTo( Property( gaussianBlurView, gaussianBlurView.GetBlurStrengthPropertyIndex() ), ... );
+ * blurAnimation.Play();
*
- * ...\n
- * // Stop rendering the GaussianBlurView\n
- * Stage::GetCurrent().Remove(gaussianBlurView);\n
- * gaussianBlurView.Deactivate();\n
+ * ...
+ * // Stop rendering the GaussianBlurView
+ * Stage::GetCurrent().Remove(gaussianBlurView);
+ * gaussianBlurView.Deactivate();
+ * @endcode
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use this class.
*/
class DALI_IMPORT_API GaussianBlurView : public Control
{
typedef Signal< void (GaussianBlurView source) > GaussianBlurViewSignal;
/**
- * @brief Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New()
+ * @brief Create an uninitialized GaussianBlurView; this can be initialized with GaussianBlurView::New().
* Calling member functions with an uninitialized Dali::Object is not allowed.
* @SINCE_1_0.0
*/
GaussianBlurView();
/**
- * @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
*/
GaussianBlurView(const GaussianBlurView& 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
*/
GaussianBlurView& operator=(const GaussianBlurView& ZoomView);
~GaussianBlurView();
/**
- * @brief Downcast an Object handle to GaussianBlurView. If handle points to a GaussianBlurView the
+ * @brief Downcast a handle to GaussianBlurView handle.
+ *
+ * If handle points to a GaussianBlurView the
* downcast produces valid handle. If not the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a GaussianBlurView or an uninitialized handle
+ * @return A handle to a GaussianBlurView or an uninitialized handle
*/
static GaussianBlurView DownCast( BaseHandle handle );
/**
* @brief Adds a child Actor to this Actor.
- * NOTE! if the child already has a parent, it will be removed from old parent
- * and reparented to this actor. This may change childs position, color, shader effect,
- * scale etc as it now inherits them from this actor
* @SINCE_1_0.0
* @param [in] child The child.
* @pre This Actor (the parent) has been initialized.
* @pre The actor is not the Root actor
* @post The child will be referenced by its parent. This means that the child will be kept alive,
* even if the handle passed into this method is reset or destroyed.
+ * @note If the child already has a parent, it will be removed from old parent
+ * and reparented to this actor. This may change childs position, color, shader effect,
+ * scale etc as it now inherits them from this actor.
*/
void Add(Actor child);
/**
* @brief Removes a child Actor from this Actor.
+ *
* If the actor was not a child of this actor, this is a no-op.
* @SINCE_1_0.0
* @param [in] child The child.
void Activate();
/**
- * @brief Render the GaussianBlurView once. Must be called after you Add() it to the stage.
+ * @brief Render the GaussianBlurView once.
+ *
+ * Must be called after you Add() it to the stage.
* Only works with a gaussian blur view created with blurUserImage = true.
* Listen to the Finished signal to determine when the rendering has completed.
* @SINCE_1_0.0
void Deactivate();
/**
- * @brief Sets a custom image to be blurred and a render target to receive the blurred result. If this is called the children of the GaussianBlurObject will not be rendered blurred,
+ * @brief Sets a custom image to be blurred and a render target to receive the blurred result.
+ *
+ * If this is called the children of the GaussianBlurObject will not be rendered blurred,
* instead the inputImage will get blurred.
* To retrieve the blurred image the user can either pass a handle on a render target they own as the second parameter to SetUserImageAndOutputRenderTarget( ... ), or they
* can pass NULL for this parameter and instead call GetBlurredRenderTarget() which will return a handle on a render target created internally to the GaussianBlurView object.
void SetUserImageAndOutputRenderTarget(Image inputImage, FrameBufferImage outputRenderTarget);
/**
- * @brief Get the index of the property that can be used to fade the blur in / out. This is the overall strength of the blur.
+ * @brief Get the index of the property that can be used to fade the blur in / out.
+ *
+ * This is the overall strength of the blur.
* User can use this to animate the blur. A value of 0.0 is zero blur and 1.0 is full blur. Default is 1.0.
* Note that if you set the blur to 0.0, the result will be no blur BUT the internal rendering will still be happening. If you wish to turn the blur off, you should remove
* the GaussianBlurView object from the stage also.
/**
* @brief Get the final blurred image.
+ *
* Use can call this function to get the blurred result as an image, to use as they wish. It is not necessary to call this unless you specifically require it.
* @SINCE_1_0.0
* @return A handle on the blurred image, contained in a render target.
ImageView& operator=( const ImageView& imageView );
/**
- * @brief Downcast an Object handle to ImageView.
+ * @brief Downcast a handle to ImageView handle.
*
* If handle points to a ImageView the downcast produces valid
* handle. If not the returned handle is left uninitialized.
* @brief Gets the Image
*
* @SINCE_1_0.0
+ * @remarks Calls to this method should be avoided as this may return an empty handle if the image has not been created yet.
* @return The Image currently set to this ImageView
*/
Image GetImage() const;
static ScrollBar New(Direction direction = Vertical);
/**
- * @brief Downcast an Object handle to ScrollBar. If handle points to a ScrollBar the
+ * @brief Downcast a handle to ScrollBar handle.
+ *
+ * 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
/**
* @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
* regardless of the length of scroll content.
/**
* @brief Signal emitted when panning is finished on the scroll indicator.
+ *
* Signal only emitted when the source of the scroll position properties are set.
*
* A callback of the following type may be connected:
/**
* @brief Signal emitted when the current scroll position of the scrollable content
* goes above or below the values specified by SCROLL_POSITION_INTERVALS property.
+ *
* Signal only emitted when the source of the scroll position properties are set.
*
* A callback of the following type may be connected:
* @{
*/
+/**
+ * @brief Default item layout mode.
+ * @SINCE_1_0.0
+ */
namespace DefaultItemLayout
{
};
/**
- * @brief Creates a built-in default item-layout
+ * @brief Creates a built-in default item-layout.
*
* @SINCE_1_0.0
* @param[in] type The type of layout required.
/**
* @brief ItemFactory is for providing actors to ItemView.
+ *
* Each actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfItems()-1.
* @SINCE_1_0.0
*/
virtual void ItemReleased(unsigned int itemId, Actor actor) {};
/**
- * @brief Retrieve the extension for this control
+ * @brief Retrieve the extension for this control.
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
*
* @param[in] actor The actor to constrain.
* @param[in] itemId The ID of the item represented by the actor.
- * @param[in] layoutSize the current size of the item view instance.
+ * @param[in] layoutSize The current size of the item view instance.
* @param[in] itemViewActor The item view instance which requests the application of constraints.
*/
DALI_IMPORT_API virtual void ApplyConstraints( Actor& actor, const int itemId, const Vector3& layoutSize, const Actor& itemViewActor ) = 0;
* @brief Gets the position of a given item
*
* @SINCE_1_0.0
- * @param[in] itemID id of the item we want to get its position
- * @param[in] currentLayoutPosition the current layout position of the item view instance
- * @param[in] layoutSize the current size of the item view instance
+ * @param[in] itemID The id of the item we want to get its position
+ * @param[in] currentLayoutPosition The current layout position of the item view instance
+ * @param[in] layoutSize The current size of the item view instance
* @return The item position (x,y,z)
*/
DALI_IMPORT_API virtual Vector3 GetItemPosition(int itemID, float currentLayoutPosition, const Vector3& layoutSize) const = 0;
typedef unsigned int ItemId; ///< Unique identity for each item in the view. @SINCE_1_0.0
-typedef std::vector<ItemId> ItemIdContainer;
-typedef ItemIdContainer::iterator ItemIdIter;
-typedef ItemIdContainer::const_iterator ConstItemIdIter;
+typedef std::vector<ItemId> ItemIdContainer; ///< Item id container type @SINCE_1_0.0
+typedef ItemIdContainer::iterator ItemIdIter; ///< Item id iterator type @SINCE_1_0.0
+typedef ItemIdContainer::const_iterator ConstItemIdIter; ///< Item id const iterator type @SINCE_1_0.0
-typedef std::pair<ItemId, Actor> Item;
+typedef std::pair<ItemId, Actor> Item; ///< Item type @SINCE_1_0.0
-typedef std::vector<Item> ItemContainer;
-typedef ItemContainer::iterator ItemIter;
-typedef ItemContainer::const_iterator ConstItemIter;
+typedef std::vector<Item> ItemContainer; ///< Item container type @SINCE_1_0.0
+typedef ItemContainer::iterator ItemIter; ///< Item iterator type @SINCE_1_0.0
+typedef ItemContainer::const_iterator ConstItemIter; ///< Item const iterator type @SINCE_1_0.0
class ItemView;
class ItemLayout;
static ItemView New(ItemFactory& factory);
/**
- * @brief Downcast an Object handle to ItemView.
+ * @brief Downcast a handle to ItemView handle.
*
* If handle points to a ItemView the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a ItemView or an uninitialized handle
+ * @return A handle to a ItemView or an uninitialized handle
*/
static ItemView DownCast( BaseHandle handle );
void ScrollToItem(ItemId itemId, float durationSeconds);
/**
- * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
+ * @brief Set the interval between refreshes.
+ *
+ * When the layout-position of items is changed by this interval,
* new items are requested from ItemFactory.
*
* @SINCE_1_0.0
void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
/**
- * @brief Set the parent origin of the items
+ * @brief Set the parent origin of the items.
*
* A relayout will occur for all the items if the parent origin is different than the current one.
* @SINCE_1_0.0
void SetItemsParentOrigin( const Vector3& parentOrigin );
/**
- * @brief Get the parent origin of the items
+ * @brief Get the parent origin of the items.
*
* @SINCE_1_0.0
* @return The current parent origin of the items
Vector3 GetItemsParentOrigin() const;
/**
- * @brief Set the anchor point of the items
+ * @brief Set the anchor point of the items.
*
* A relayout will occur for all the items if the anchor point is different than the current one.
* @SINCE_1_0.0
void SetItemsAnchorPoint( const Vector3& anchorPoint );
/**
- * @brief Get the anchor point of the items
+ * @brief Get the anchor point of the items.
*
* @SINCE_1_0.0
* @return The current anchor point of the items
/**
* @brief ScrollView Page Path Effect.
+ *
* This effect causes Actors to follow a given path. The opacity of the actor will be 0.0 at
* the beginning of the path and will go to 1.0 as it is approximating to half of the path to return
* to 0.0 at the end of the path
ScrollViewPagePathEffect();
/**
- * @brief Downcast an Object handle to ScrollViewPagePathEffect. If handle points to a ScrollViewPagePathEffect the
+ * @brief Downcast a handle to ScrollViewPagePathEffect handle.
+ *
+ * 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
/**
* @brief Copy constructor.
*
- * Creates another handle that points to the same real object
+ * Creates another handle that points to the same real object.
*
* @SINCE_1_0.0
* @param[in] handle to copy from
/**
* @brief Assignment operator.
*
- * Changes this handle to point to another real object
+ * Changes this handle to point to another real object.
* @SINCE_1_0.0
* @param[in] handle The handle to copy from
* @return A reference to this
static ScrollView New();
/**
- * @brief Downcast an Object handle to ScrollView.
+ * @brief Downcast a handle to ScrollView handle.
*
* If handle points to a ScrollView the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a ScrollView or an uninitialized handle
+ * @return A handle to a ScrollView or an uninitialized handle
*/
static ScrollView DownCast( BaseHandle handle );
void SetRulerY(RulerPtr ruler);
/**
- * @brief Set Scroll's touch sensitivity.
+ * @brief Set scroll sensibility of pan gesture.
*
* @SINCE_1_0.0
* @param[in] sensitive true to enable scroll, false to disable scrolling
- * @note Unlike SetSensitive(), this determines whether this ScrollView
+ * @note Unlike Actor::SetSensitive(), this determines whether this ScrollView
* should react (e.g. pan), without disrupting the sensitivity of it's children.
*
*/
* 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
* edge of a scrollable area and the maximum overshoot is 100 then
- * the final overshoot value will be 0.75f)
+ * the final overshoot value will be 0.75f).
*
* @SINCE_1_0.0
- * @param[in] overshootX the maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
- * @param[in] overshootY the maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
+ * @param[in] overshootX The maximum number of horizontally scrolled pixels before overshoot X reaches 1.0f
+ * @param[in] overshootY The maximum number of vertically scrolled pixels before overshoot Y reaches 1.0f
*/
void SetMaxOvershoot(float overshootX, float overshootY);
void SetWrapMode(bool enable);
/**
- * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted
+ * @brief Gets the current distance needed to scroll for ScrollUpdatedSignal to be emitted.
*
* @SINCE_1_0.0
* @return Current scroll update distance
int GetScrollUpdateDistance() const;
/**
- * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted
+ * @brief Sets the distance needed to scroll for ScrollUpdatedSignal to be emitted.
*
* The scroll update distance tells ScrollView how far to move before ScrollUpdatedSignal the informs application.
- * Each time the ScrollView crosses this distance the signal will be emitted
+ * Each time the ScrollView crosses this distance the signal will be emitted.
*
* @SINCE_1_0.0
* @param[in] distance The distance for ScrollView to move before emitting update signal
* By default this is 0.36 (0.36:1) which means angles less than 20
* degrees to an axis will lock to that axis.
*
- * @note: Specifying a value of 1.0 (the maximum value accepted) indicates that
- * all panning gestures will auto-lock. Either to the horizontal or vertical axis.
- *
* @SINCE_1_0.0
* @param[in] gradient A value between 0.0 and 1.0 (auto-lock for all angles)
+ * @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.
+ *
*/
void SetAxisAutoLockGradient(float gradient);
void SetFlickSpeedCoefficient(float speed);
/**
- * @brief Returns the minimum pan distance required for a flick gesture in pixels
+ * @brief Returns the minimum pan distance required for a flick gesture in pixels.
*
* @SINCE_1_0.0
* @return Minimum pan distance vector with separate x and y distance
Vector2 GetMinimumDistanceForFlick() const;
/**
- * @brief Sets the minimum pan distance required for a flick in pixels
+ * @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
void SetMinimumDistanceForFlick( const Vector2& distance );
/**
- * @brief Returns the minimum pan speed required for a flick gesture in pixels per second
+ * @brief Returns the minimum pan speed required for a flick gesture in pixels per second.
*
* @SINCE_1_0.0
* @return Minimum pan speed
float GetMinimumSpeedForFlick() const;
/**
- * @brief Sets the minimum pan speed required for a flick in pixels per second
+ * @brief Sets the minimum pan speed required for a flick in pixels per second.
*
* @SINCE_1_0.0
* @param[in] speed The minimum pan speed for a flick
* @SINCE_1_0.0
* @param[in] step The step of scroll distance(pixel) in X and Y axes.
*
- * @note: If snap points are defined in the rulers, it will always
+ * @note If snap points are defined in the rulers, it will always
* scroll to the next snap point towards the scroll direction while
* receiving the wheel events.
*
* a grid fashion, increasing from left to right until the end of
* the X-domain.
*
- * @note: Pages start from 0 as the first page, not 1.
+ * @SINCE_1_0.0
+ * @note Pages start from 0 as the first page, not 1.
*
* @returns The Current page.
- * @SINCE_1_0.0
*/
unsigned int GetCurrentPage() const;
void ScrollTo(const Vector2& position, float duration);
/**
- * @brief Scrolls View to position specified (contents will scroll to this position)
+ * @brief Scrolls View to position specified (contents will scroll to this position).
*
* Position 0,0 is the origin. Increasing X scrolls contents left, while
* increasing Y scrolls contents up.
* @note Contents will not snap to ruler snap points.
* Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
* wrap mode, the application developer can decide whether to scroll left or right
- * to get to the target page
+ * to get to the target page.
*
*/
void ScrollTo(const Vector2& position, float duration,
DirectionBias horizontalBias, DirectionBias verticalBias);
/**
- * @brief Scrolls View to position specified (contents will scroll to this position)
+ * @brief Scrolls View to position specified (contents will scroll to this position).
*
* Position 0,0 is the origin. Increasing X scrolls contents left, while
* increasing Y scrolls contents up.
* @note Contents will not snap to ruler snap points.
* Biasing parameters are provided such that in scenarios with 2 or 2x2 pages in
* wrap mode, the application developer can decide whether to scroll left or right
- * to get to the target page
+ * to get to the target page.
*
*/
void ScrollTo(const Vector2& position, float duration, AlphaFunction alpha,
*
* @SINCE_1_0.0
* @param[in] constraint The constraint to apply
- * @note this affects all existing and future Actors that are added to scrollview.
+ * @note This affects all existing and future Actors that are added to scrollview.
*/
void ApplyConstraintToChildren(Constraint constraint);
* @brief Removes all constraints that will affect the children of ScrollView.
*
* @SINCE_1_0.0
- * @note this removes all constraints from actors that have been added
+ * @note This removes all constraints from actors that have been added
* to scrollview.
*/
void RemoveConstraintsFromChildren();
* Once Unbound, this ScrollView will not affect the actor.
* @SINCE_1_0.0
* @param[in] child The actor to be unbound.
- * @note this does not remove the child from the ScrollView container
+ * @note This does not remove the child from the ScrollView container
*
*/
void UnbindActor(Actor child);
/**
* @brief Signal emitted when the ScrollView has started to snap or flick (it tells the target
- * position, scale, rotation for the snap or flick)
+ * position, scale, rotation for the snap or flick).
*
* A callback of the following type may be connected:
* @code
/**
* @brief Copy constructor.
*
- * Creates another handle that points to the same real object
+ * Creates another handle that points to the same real object.
*
* @SINCE_1_0.0
* @param handle to copy from
/**
* @brief Assignment operator.
*
- * Changes this handle to point to another real object
+ * Changes this handle to point to another real object.
* @SINCE_1_0.0
* @param[in] handle to copy from
* @return A reference to this
~Scrollable();
/**
- * @brief Downcast an Object handle to Scrollable.
+ * @brief Downcast a handle to Scrollable handle.
*
* If handle points to a Scrollable the downcast produces valid
* handle. If not the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return handle to a Scrollable or an uninitialized handle
+ * @return A handle to a Scrollable or an uninitialized handle
*/
static Scrollable DownCast( BaseHandle handle );
* @brief Checks if scroll overshoot has been enabled or not.
*
* @SINCE_1_0.0
- * @return Whether the scroll obvershoot is enabled
+ * @return Whether the scroll overshoot is enabled
*/
bool IsOvershootEnabled() const;
* @brief Sets whether to enables or disable scroll overshoot.
*
* @SINCE_1_0.0
- * @param[in] enable Whether to enable the scroll obvershoot or not
+ * @param[in] enable Whether to enable the scroll overshoot or not
*/
void SetOvershootEnabled(bool enable);
/**
* @brief Set the speed of overshoot animation in pixels per second.
+ *
* When the speed is not greater than 0, the overshoot is set instantly with no animation.
* @SINCE_1_0.0
* @param[in] pixelsPerSecond The speed of the overshoot animation.
static TableView New( unsigned int initialRows, unsigned int initialColumns );
/**
- * @brief Downcast an Object handle to TableView. If handle points to a TableView the
+ * @brief Downcast a handle to TableView handle.
+ *
+ * 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
/**
* @brief Returns a child from the given layout position
- * Note! if there is no child in this position this method returns an uninitialized
- * Actor handle
* @SINCE_1_0.0
* @param[in] position in the table
* @return child that was in the cell or an uninitialized handle
+ * @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
- * Note! if there is no child in this position this method does nothing
* @SINCE_1_0.0
* @param[in] position for the child to remove
* @return child that was removed or an uninitialized handle
+ * @note If there is no child in this position this method does nothing.
*/
Actor RemoveChildAt( CellPosition position );
void DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed );
/**
- * @brief Resize the TableView. Note! if the new size is smaller than old,
- * superfluous actors get removed. If you want to relayout removed children,
- * use the variant that returns the removed Actors and reinsert them into the table
- * If an actor spans to a removed row or column it gets removed from the table
+ * @brief Resize the TableView.
* @SINCE_1_0.0
* @param[in] rows for the table
* @param[in] 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.
*/
void Resize( unsigned int rows, unsigned int columns );
/**
- * @brief Resize the TableView. Note! if the new size is smaller than old,
- * superfluous actors get removed.
- * If an actor spans to a removed row or column it gets removed from the table
+ * @brief Resize 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.
+ * 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 );
void SetCellPadding( Size padding );
/**
+ * @brief Get the current padding as width and height.
* @SINCE_1_0.0
* @return the current padding as width and height
*/
/**
* @brief Gets a row's fixed height.
- * Note! The returned value is valid if it has been set before.
* @SINCE_1_0.0
* @return height in world coordinate units.
* @pre The row rowIndex must exist.
+ * @note The returned value is valid if it has been set before.
*/
float GetFixedHeight( unsigned int rowIndex ) const;
/**
* @brief Gets a row's relative height.
- * Note! The returned value is valid if it has been set before.
* @SINCE_1_0.0
* @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 Gets a column's fixed width.
- * Note! The returned value is valid if it has been set before.
* @SINCE_1_0.0
* @return width in world coordinate units.
* @pre The column columnIndex must exist.
+ * @note The returned value is valid if it has been set before.
*/
float GetFixedWidth( unsigned int columnIndex ) const;
/**
* @brief Gets a column's relative width.
- * Note! The returned value is valid if it has been set before.
* @SINCE_1_0.0
* @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.
*/
float GetRelativeWidth( unsigned int columnIndex ) const;
/**
+ * @brief Gets the amount of rows in the table.
* @SINCE_1_0.0
* @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
*/
class KeyboardFocusManager;
}
/**
- * @addtogroup dali_toolkit_focus_manager
+ * @addtogroup dali_toolkit_managers
* @{
*/
* @brief Clear 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
+ * It will emit focus changed signal without current focused actor.
* @SINCE_1_0.0
* @pre The KeyboardFocusManager has been initialized.
*/
projects / platform / core / uifw / dali-toolkit.git / commitdiff