X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fpage-turn-view%2Fpage-turn-landscape-view.h;h=1c136e2977b01dba17179868e21c27d93e04240f;hb=d44300a6f74767fb66b96d5583a60779a50c4c65;hp=7430fcce7e3f53731a8a4f8fbecd11b7a28cc6a0;hpb=f58b8383147de70affa1e3949cf1c6757d705d3c;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/devel-api/controls/page-turn-view/page-turn-landscape-view.h b/dali-toolkit/devel-api/controls/page-turn-view/page-turn-landscape-view.h index 7430fcc..1c136e2 100644 --- a/dali-toolkit/devel-api/controls/page-turn-view/page-turn-landscape-view.h +++ b/dali-toolkit/devel-api/controls/page-turn-view/page-turn-landscape-view.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H__ -#define __DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H__ +#ifndef DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H +#define DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -23,78 +23,86 @@ namespace Dali { - namespace Toolkit { - namespace Internal DALI_INTERNAL { // Forward declarations class PageTurnLandscapeView; -} +} // namespace DALI_INTERNAL /** - * PageTurnLandscapeView provides a page turn view in landscape mode + * @brief PageTurnLandscapeView provides a page turn view in landscape mode + * @SINCE_1_0.0 */ -class DALI_IMPORT_API PageTurnLandscapeView : public PageTurnView +class DALI_TOOLKIT_API PageTurnLandscapeView : public PageTurnView { public: /** - * Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New() + * @brief Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New() * Calling member functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_0.0 */ PageTurnLandscapeView(); /** - * Copy constructor. + * @brief Copy constructor. + * @SINCE_1_0.0 */ - PageTurnLandscapeView( const PageTurnLandscapeView& pageTurnLandscapeView ); + PageTurnLandscapeView(const PageTurnLandscapeView& pageTurnLandscapeView); /** - * Assignment operator. + * @brief Assignment operator. + * @SINCE_1_0.0 */ - PageTurnLandscapeView& operator=( const PageTurnLandscapeView& pageTurnLandscapeView ); + PageTurnLandscapeView& operator=(const PageTurnLandscapeView& pageTurnLandscapeView); /** * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_0.0 */ ~PageTurnLandscapeView(); /** - * Create an initialized PageTurnLandscapeView control + * @brief Create an initialized PageTurnLandscapeView control + * @SINCE_1_0.0 * @param[in] pageFactory The factory which provides PageTurnView with pages. - * @param[in] pageSize The size of the page + * @param[in] viewPageSize The size of the page * @return A handle to the PageTurnLandscapeView control. */ - static PageTurnLandscapeView New( PageFactory& pageFactory, const Vector2& pageSize ); + static PageTurnLandscapeView New(PageFactory& pageFactory, const Vector2& viewPageSize); /** - * Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView the + * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView 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 PageTurnLandscapeView or an uninitialized handle */ - static PageTurnLandscapeView DownCast( BaseHandle handle ); + static PageTurnLandscapeView DownCast(BaseHandle handle); public: // Not intended for application developers - + /// @cond internal /** - * Creates a handle using the Toolkit::Internal implementation. + * @brief Creates a handle using the Toolkit::Internal implementation. + * @SINCE_1_0.0 * @param[in] implementation The Control implementation. */ - DALI_INTERNAL PageTurnLandscapeView( Internal::PageTurnLandscapeView& implementation ); + DALI_INTERNAL PageTurnLandscapeView(Internal::PageTurnLandscapeView& implementation); /** - * Allows the creation of this Control from an Internal::CustomActor pointer. + * @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 PageTurnLandscapeView( Dali::Internal::CustomActor* internal ); + explicit DALI_INTERNAL PageTurnLandscapeView(Dali::Internal::CustomActor* internal); + /// @endcond }; } // namespace Toolkit } // namespace Dali -#endif /* __DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H__ */ +#endif /* DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H */