/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] button Handle to an object
*/
Button( const Button& button );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] button Handle to an object
- * @return A reference to this
*/
Button& operator=( const Button& button );
/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] checkBox Handle to an object
*/
CheckBoxButton( const CheckBoxButton& checkBox );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] checkBox Handle to an object
- * @return A reference to this
*/
CheckBoxButton& operator=( const CheckBoxButton& checkBox );
/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] pushButton Handle to an object
*/
PushButton( const PushButton& pushButton );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] pushButton Handle to an object
- * @return A reference to this
*/
PushButton& operator=( const PushButton& pushButton );
/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] radioButton Handle to an object
*/
RadioButton( const RadioButton& radioButton );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] radioButton Handle to an object
- * @return A reference to this
*/
RadioButton& operator=( const RadioButton& radioButton );
// Construction
- /**
- * @brief Flags for the constructor
- * @SINCE_1_0.0
- */
+ // Flags for the constructor
enum ControlBehaviour
{
REQUIRES_STYLE_CHANGE_SIGNALS = 1 << ( CustomActorImpl::ACTOR_FLAG_COUNT + 0 ), ///< True if needs to monitor style change signals such as theme/font change @SINCE_1_0.0
*/
struct KeyboardFocus
{
- /**
- * @brief Keyboard focus direction
- * @SINCE_1_0.0
- */
enum Direction
{
LEFT, ///< Move keyboard focus towards the left direction @SINCE_1_0.0
/**
* @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 Create 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.
*/
static Model3dView New( const std::string& objUrl, const std::string& mtlUrl, const std::string& imagesUrl );
/**
* @brief Copy constructor.
* @SINCE_1_1.4
- * @param[in] model3dView Handle to an object
*/
Model3dView( const Model3dView& model3dView );
/**
* @brief Assignment operator.
* @SINCE_1_1.4
- * @param[in] model3dView Handle to an object
- * @return reference to this
*/
Model3dView& operator=( const Model3dView& model3dView );
/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] scrollBar Handle to an object
*/
ScrollBar( const ScrollBar& scrollBar );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] scrollBar Handle to an object
- * @return A reference to this
*/
ScrollBar& operator=( const ScrollBar& scrollBar );
namespace DefaultItemLayout
{
-/**
- * @brief The type of DefaultItemLayout
- * @SINCE_1_0.0
- */
enum Type
{
DEPTH, ///< Items arranged in a grid, scrolling along the Z-Axis. @SINCE_1_0.0
{
public:
- /**
- * @brief The start and end property ranges for this control.
- * @SINCE_1_1.18
- */
enum PropertyRange
{
PROPERTY_START_INDEX = Toolkit::Scrollable::PROPERTY_END_INDEX + 1, ///< @SINCE_1_1.18
/**
* @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] itemView Handle to an object
*/
ItemView( const ItemView& itemView );
/**
* @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] itemView Handle to an object
- * @return A reference to this
*/
ItemView& operator=( const ItemView& itemView );
* @brief Move Actor constraint.
*
* Moves an Actor in accordance to scroll position.
- * @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.
*
* Wraps an Actors position in accordance to min/max bounds of domain.
- * @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 );
*
* Creates another handle that points to the same real object.
* @SINCE_1_1.39
- * @param[in] handle Handle to an object
*/
Slider( const Slider& handle );
*
* Changes this handle to point to another real object.
* @SINCE_1_1.39
- * @param[in] handle Handle to an object
- * @return A reference to this
*/
Slider& operator=( const Slider& handle );
/**
* @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
- * @param[in] rowSpan The row span initialized
- * @param[in] columnSpan The column span initialized
*/
CellPosition( unsigned int rowIndex = 0, unsigned int columnIndex = 0,
unsigned int rowSpan = 1, unsigned int columnSpan = 1 )
/**
* @brief Copy constructor. Creates another handle that points to the same real object
* @SINCE_1_0.0
- * @param[in] handle to copy from
+ * @param handle to copy from
*/
TableView( const TableView& handle );
/**
* @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 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.
* @pre The row rowIndex must exist.
* @note The returned value is valid if it has been set before.
/**
* @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.
* @pre The row rowIndex must exist.
* @note The returned value is valid if it has been set before.
/**
* @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.
* @pre The column columnIndex must exist.
* @note The returned value is valid if it has been set before.
/**
* @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.
* @pre The column columnIndex must exist.
* @note The returned value is valid if it has been set before.
// Signal
typedef Signal< void (VideoView&) > VideoViewSignalType; ///< Video playback finished signal type @ SINCE_1_1.38
- /**
- * @brief The start and end property ranges for this control.
- * @SINCE_1_0.0
- */
enum PropertyRange
{
PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
namespace Toolkit
{
-/**
- * @brief The start and end property ranges.
- * @SINCE_1_1.45
- */
enum PropertyRanges
{
VISUAL_PROPERTY_BASE_START_INDEX = CORE_PROPERTY_MAX_INDEX + 1, ///< Visual Property Base Start Index. @SINCE_1_1.45