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=116f658c34732903c43565709866a8139f1d4531;hp=a879c48320402a97a4838254a38af718826c1d1d;hb=b694e7e2ae624e206e1548b1a863c554eb9cd4d7;hpb=d6f58f1070d7dcf950a2517cabe91828178a4788 diff --git a/dali-toolkit/public-api/controls/alignment/alignment.h b/dali-toolkit/public-api/controls/alignment/alignment.h index a879c48..116f658 100644 --- a/dali-toolkit/public-api/controls/alignment/alignment.h +++ b/dali-toolkit/public-api/controls/alignment/alignment.h @@ -1,8 +1,8 @@ -#ifndef __DALI_ALIGNMENT_H__ -#define __DALI_ALIGNMENT_H__ +#ifndef DALI_ALIGNMENT_H +#define DALI_ALIGNMENT_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,48 +39,53 @@ class 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. + * 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 +class DALI_TOOLKIT_API Alignment : public Control { public: /** - * @brief Different types of alignment. + * @brief Enumeration for different types of alignment. + * @SINCE_1_0.0 */ 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 }; /** - * @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 { - 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 + * @brief Constructor. + * @SINCE_1_0.0 */ Padding() : left( 0.f ), @@ -91,8 +96,9 @@ public: } /** - * @brief Constructor + * @brief Constructor. * + * @SINCE_1_0.0 * @param[in] l Left padding * @param[in] r Right padding * @param[in] t Top padding @@ -113,56 +119,62 @@ public: }; /** - * @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. * - * @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. + * @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 */ static Alignment New( Type horizontal = HorizontalCenter, Type vertical = VerticalCenter ); /** * @brief Copy constructor. Creates another handle that points to the same real object. * - * @param[in] alignment Object to copy. + * @SINCE_1_0.0 + * @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 an Object handle to Alignment. + * @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 - * @return handle to a Alignment or an uninitialized handle + * @return A handle to a Alignment or an uninitialized handle */ static Alignment DownCast( BaseHandle handle ); /** - * @brief Sets the new alignment. By default ( HorizontalCenter | VerticalCenter ). + * @brief Sets the new alignment. By default, ( HorizontalCenter | VerticalCenter ). * - * @note there should only be one horizontal and one vertical policy - * @param [in] type The new alignment option. + * @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 ); /** - * @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. @@ -173,37 +185,42 @@ public: * } * @endcode * - * @return the alignment value. + * @SINCE_1_0.0 + * @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 * @see Scaling. - * @param[in] scaling The scaling property. */ void SetScaling( Scaling scaling ); /** * @brief Retrieves the scaling property. * + * @SINCE_1_0.0 + * @return The scaling * @see Scaling. - * @return The scaling. */ Scaling GetScaling() const; /** - * @brief Set a padding value. + * @brief Sets a padding value. * - * @param [in] padding The left, right, top, bottom padding values. + * @SINCE_1_0.0 + * @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. * - * @return The left, right, top, bottom padding values. + * @SINCE_1_0.0 + * @return The left, right, top, bottom padding values */ const Padding& GetPadding() const; @@ -211,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 */ @@ -218,26 +236,31 @@ public: public: // Not intended for application developers + /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * - * @param[in] implementation The Control implementation. + * @SINCE_1_0.0 + * @param[in] implementation The Control implementation */ DALI_INTERNAL Alignment( Internal::Alignment& implementation ); /** * @brief Allows the creation of this Control from an Internal::CustomActor pointer. * - * @param[in] internal A pointer to the internal CustomActor. + * @SINCE_1_0.0 + * @param[in] internal A pointer to the internal CustomActor */ explicit DALI_INTERNAL Alignment( Dali::Internal::CustomActor* internal ); + /// @endcond }; /** * @} */ + } // namespace Toolkit } // namespace Dali -#endif // __DALI_TOOLKIT_LAYOUT_H__ +#endif // DALI_ALIGNMENT_H