X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fpage-turn-view%2Fpage-turn-portrait-view.h;h=5983fbc61c2b45f75d8aaaeba40b5b28b7d2d7ca;hb=1d82abb8a1a514ce0af63004706135fb7883f89b;hp=d237e502939768209277d49a172a53b41089780c;hpb=c3f7ea6cb0c0b75c2276193aff88b5c7a679a2d5;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/devel-api/controls/page-turn-view/page-turn-portrait-view.h b/dali-toolkit/devel-api/controls/page-turn-view/page-turn-portrait-view.h index d237e50..5983fbc 100644 --- a/dali-toolkit/devel-api/controls/page-turn-view/page-turn-portrait-view.h +++ b/dali-toolkit/devel-api/controls/page-turn-view/page-turn-portrait-view.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H__ -#define __DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H__ +#ifndef DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H +#define DALI_TOOLKIT_PAGE_TURN_PORTRAIT_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,87 @@ namespace Dali { - namespace Toolkit { - namespace Internal DALI_INTERNAL { // Forward declarations class PageTurnPortraitView; -} +} // namespace DALI_INTERNAL /** - * PageTurnLandscapeView provides a page turn view in portrait mode + * @brief PageTurnPortraitView provides a page turn view in portrait mode + * + * @SINCE_1_1.4 */ -class DALI_IMPORT_API PageTurnPortraitView : public PageTurnView +class DALI_TOOLKIT_API PageTurnPortraitView : public PageTurnView { public: /** - * Create an uninitialized PageTurnPortraitView; this can be initialized with PageTurnPortraitView::New() + * @brief Create an uninitialized PageTurnPortraitView; this can be initialized with PageTurnPortraitView::New() * Calling member functions with an uninitialized Dali::Object is not allowed. + * @SINCE_1_1.4 */ PageTurnPortraitView(); /** - * Copy constructor. + * @brief Copy constructor. + * @SINCE_1_1.4 */ - PageTurnPortraitView( const PageTurnPortraitView& pageTurnPortraitView ); + PageTurnPortraitView(const PageTurnPortraitView& pageTurnPortraitView); /** - * Assignment operator. + * @brief Assignment operator. + * @SINCE_1_1.4 */ - PageTurnPortraitView& operator=( const PageTurnPortraitView& pageTurnPortraitView ); + PageTurnPortraitView& operator=(const PageTurnPortraitView& pageTurnPortraitView); /** * @brief Destructor * * This is non-virtual since derived Handle types must not contain data or virtual methods. + * @SINCE_1_1.4 */ ~PageTurnPortraitView(); /** - * Create an initialized PageTurnPortraitView control + * @brief Create an initialized PageTurnPortraitView control + * @SINCE_1_1.4 * @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 PageTurnPortraitView control. */ - static PageTurnPortraitView New( PageFactory& pageFactory, const Vector2& pageSize ); + static PageTurnPortraitView New(PageFactory& pageFactory, const Vector2& viewPageSize); /** - * Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnPortraitView the + * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnPortraitView the * downcast produces valid handle. If not the returned handle is left uninitialized. + * @SINCE_1_1.4 * @param[in] handle Handle to an object * @return handle to a PageTurnPortraitView or an uninitialized handle */ - static PageTurnPortraitView DownCast( BaseHandle handle ); + static PageTurnPortraitView 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_1.4 * @param[in] implementation The Control implementation. */ - DALI_INTERNAL PageTurnPortraitView( Internal::PageTurnPortraitView& implementation ); + DALI_INTERNAL PageTurnPortraitView(Internal::PageTurnPortraitView& 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_1.4 * @param[in] internal A pointer to the internal CustomActor. */ - explicit DALI_INTERNAL PageTurnPortraitView( Dali::Internal::CustomActor* internal ); + explicit DALI_INTERNAL PageTurnPortraitView(Dali::Internal::CustomActor* internal); + /// @endcond }; } // namespace Toolkit } // namespace Dali -#endif /* __DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H__ */ +#endif /* DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H */