X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fcontrols%2Falignment%2Falignment.h;h=8f0e1d52d19830f97bfdc4424f0f15b1d3a8cace;hp=1f34eb5fe14c139ab2a52810b422009198cf209c;hb=502a6996c58f8b8de2dd530235852d53d01d2ac0;hpb=b3aff14cae6b3af637e75171422c16661878ba8e diff --git a/dali-toolkit/public-api/controls/alignment/alignment.h b/dali-toolkit/public-api/controls/alignment/alignment.h index 1f34eb5..8f0e1d5 100644 --- a/dali-toolkit/public-api/controls/alignment/alignment.h +++ b/dali-toolkit/public-api/controls/alignment/alignment.h @@ -31,11 +31,16 @@ namespace Internal DALI_INTERNAL { class Alignment; } +/** + * @addtogroup dali_toolkit_controls_alignment + * @{ + */ /** * @brief Alignment is a container which provides an easy way to align other actors inside its boundary. * * Additionaly it provides a scaling property to resize the contained actors @see Scaling. + * @SINCE_1_0.0 * @note The use of scaling property will override all constraints applied to actors. * * All actors added to an alignment are going to be set with the same anchor point and parent origin. And, if the scaling property is set to a value @@ -46,6 +51,7 @@ class DALI_IMPORT_API Alignment : public Control public: /** * @brief Different types of alignment. + * @SINCE_1_0.0 */ enum Type { @@ -59,24 +65,27 @@ public: /** * @brief Scaling determines how actors are scaled, to match the alignment's boundary. + * @SINCE_1_0.0 */ enum Scaling { - ScaleNone, ///< The original size is kept. - ScaleToFill, ///< Scale added actors to fill alignment's boundary. Aspect ratio is not maintained. - ScaleToFitKeepAspect, ///< Scale added actors to fit within the alignment's boundary. Aspect ratio is maintained. - ScaleToFillKeepAspect, ///< Scale added actors to fill the alignment's boundary. Aspect ratio is maintained, and the actor may exceed the alignment's boundary. - ShrinkToFit, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is not maintained - ShrinkToFitKeepAspect, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is maintained + ScaleNone, ///< The original size is kept. @SINCE_1_0.0 + ScaleToFill, ///< Scale added actors to fill alignment's boundary. Aspect ratio is not maintained. @SINCE_1_0.0 + ScaleToFitKeepAspect, ///< Scale added actors to fit within the alignment's boundary. Aspect ratio is maintained. @SINCE_1_0.0 + ScaleToFillKeepAspect, ///< Scale added actors to fill the alignment's boundary. Aspect ratio is maintained, and the actor may exceed the alignment's boundary. @SINCE_1_0.0 + ShrinkToFit, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is not maintained @SINCE_1_0.0 + ShrinkToFitKeepAspect, ///< If added actors are larger than the alignment's boundary it will be shrunk down to fit. Aspect ratio is maintained @SINCE_1_0.0 }; /** * @brief Structure describing the padding values. + * @SINCE_1_0.0 */ struct Padding { /** * @brief Constructor + * @SINCE_1_0.0 */ Padding() : left( 0.f ), @@ -89,6 +98,7 @@ public: /** * @brief Constructor * + * @SINCE_1_0.0 * @param[in] l Left padding * @param[in] r Right padding * @param[in] t Top padding @@ -112,12 +122,14 @@ public: * @brief Create an Alignment handle; this can be initialised with Alignment::New(). * * Calling member functions with an uninitialised handle is not allowed. + * @SINCE_1_0.0 */ Alignment(); /** * @brief Creates an alignment control. * + * @SINCE_1_0.0 * @param [in] horizontal Specifies how to align actors horizontally. Could be HorizontalLeft, HorizontalCenter or HorizontalRight. By default HorizontalCenter. * @param [in] vertical Specifies how to align actors vertically. Could be VerticalTop, VerticalCenter or VerticalBottom. By default VerticalCenter. * @return A handle to the Alignment control. @@ -127,6 +139,7 @@ public: /** * @brief Copy constructor. Creates another handle that points to the same real object. * + * @SINCE_1_0.0 * @param[in] alignment Object to copy. */ Alignment(const Alignment& alignment); @@ -135,6 +148,7 @@ public: * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~Alignment(); @@ -144,6 +158,7 @@ public: * 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 */ @@ -152,8 +167,9 @@ public: /** * @brief Sets the new alignment. By default ( HorizontalCenter | VerticalCenter ). * - * @note there should only be one horizontal and one vertical policy + * @SINCE_1_0.0 * @param [in] type The new alignment option. + * @note there should only be one horizontal and one vertical policy */ void SetAlignmentType( Type type ); @@ -169,6 +185,7 @@ public: * } * @endcode * + * @SINCE_1_0.0 * @return the alignment value. */ Type GetAlignmentType() const; @@ -176,22 +193,25 @@ public: /** * @brief Sets how added actors scale to fit the alignment's boundary. * - * @see Scaling. + * @SINCE_1_0.0 * @param[in] scaling The scaling property. + * @see Scaling. */ void SetScaling( Scaling scaling ); /** * @brief Retrieves the scaling property. * - * @see Scaling. + * @SINCE_1_0.0 * @return The scaling. + * @see Scaling. */ Scaling GetScaling() const; /** * @brief Set a padding value. * + * @SINCE_1_0.0 * @param [in] padding The left, right, top, bottom padding values. */ void SetPadding( const Padding& padding ); @@ -199,6 +219,7 @@ public: /** * @brief Get the padding values. * + * @SINCE_1_0.0 * @return The left, right, top, bottom padding values. */ const Padding& GetPadding() const; @@ -207,6 +228,7 @@ public: * @brief Assignment operator. * * Changes this handle to point to another real object. + * @SINCE_1_0.0 * @param[in] alignment Object to copy * @return A reference to this */ @@ -217,6 +239,7 @@ public: // Not intended for application developers /** * @brief Creates a handle using the Toolkit::Internal implementation. * + * @SINCE_1_0.0 * @param[in] implementation The Control implementation. */ DALI_INTERNAL Alignment( Internal::Alignment& implementation ); @@ -224,11 +247,15 @@ public: // Not intended for application developers /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * + * @SINCE_1_0.0 * @param[in] internal A pointer to the internal CustomActor. */ explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal ); }; +/** + * @} + */ } // namespace Toolkit } // namespace Dali