X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fenums.h;h=e2529f2ebb7615071fa891431a2ff565f4858140;hp=f3f893f8460be1abb7bf1c905fe9e7928e4bce59;hb=185db7fdcfdd0e78434d56d9e4c046451932372f;hpb=d6f58f1070d7dcf950a2517cabe91828178a4788 diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index f3f893f..e2529f2 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_ENUMS_H__ -#define __DALI_TOOLKIT_ENUMS_H__ +#ifndef DALI_TOOLKIT_ENUMS_H +#define DALI_TOOLKIT_ENUMS_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. @@ -19,12 +19,13 @@ */ // INTERNAL INCLUDES -#include +#include namespace Dali { /** * @brief DALi Toolkit namespace. + * @SINCE_1_0.0 */ namespace Toolkit { @@ -35,38 +36,41 @@ namespace Toolkit /** * @brief Control Orientation namespace. + * @SINCE_1_0.0 */ namespace ControlOrientation { /** - * @brief The internal orientation of a control. + * @brief Enumeration for the internal orientation of a control. + * @SINCE_1_0.0 */ enum Type { - Up, ///< The contents of control are in a vertical layout, from top to bottom - Left, ///< The contents of control are in a horizontal layout, from left to right - Down, ///< The contents of control are in a vertical layout, from bottom to top - Right ///< The contents of control are in a horizontal layout, from right to left + Up, ///< The contents of control are in a vertical layout, from top to bottom @SINCE_1_0.0 + Left, ///< The contents of control are in a horizontal layout, from left to right @SINCE_1_0.0 + Down, ///< The contents of control are in a vertical layout, from bottom to top @SINCE_1_0.0 + Right ///< The contents of control are in a horizontal layout, from right to left @SINCE_1_0.0 }; } // 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); +DALI_TOOLKIT_API bool IsVertical(ControlOrientation::Type orientation); /** - * @brief Query whether an orientation is horizontal. + * @brief Queries whether an orientation is horizontal. * - * @param[in] orientation The orientation. - * @return True if the orientation is horizontal. + * @SINCE_1_0.0 + * @param[in] orientation The orientation + * @return true if the orientation is horizontal */ -DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation); +DALI_TOOLKIT_API bool IsHorizontal(ControlOrientation::Type orientation); /** * @} @@ -75,4 +79,4 @@ DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation); } // namespace Dali -#endif // __DALI_TOOLKIT_ENUMS_H__ +#endif // DALI_TOOLKIT_ENUMS_H