dali-toolkit/devel-api/controls/page-turn-view/page-turn-portrait-view.h

   1 #ifndef DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H
   2 #define DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // INTERNAL INCLUDES
  22 #include <dali-toolkit/devel-api/controls/page-turn-view/page-turn-view.h>
  23
  24 namespace Dali
  25 {
  26 namespace Toolkit
  27 {
  28 namespace Internal DALI_INTERNAL
  29 {
  30 // Forward declarations
  31 class PageTurnPortraitView;
  32 } // namespace DALI_INTERNAL
  33
  34 /**
  35  * @brief PageTurnPortraitView provides a page turn view in portrait mode
  36  *
  37  * @SINCE_1_1.4
  38  */
  39 class DALI_TOOLKIT_API PageTurnPortraitView : public PageTurnView
  40 {
  41 public:
  42   /**
  43    * @brief Create an uninitialized PageTurnPortraitView; this can be initialized with PageTurnPortraitView::New()
  44    * Calling member functions with an uninitialized Dali::Object is not allowed.
  45    * @SINCE_1_1.4
  46    */
  47   PageTurnPortraitView();
  48
  49   /**
  50    * @brief Copy constructor.
  51    * @SINCE_1_1.4
  52    */
  53   PageTurnPortraitView(const PageTurnPortraitView& pageTurnPortraitView);
  54
  55   /**
  56    * @brief Assignment operator.
  57    * @SINCE_1_1.4
  58    */
  59   PageTurnPortraitView& operator=(const PageTurnPortraitView& pageTurnPortraitView);
  60
  61   /**
  62    * @brief Destructor
  63    *
  64    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  65    * @SINCE_1_1.4
  66    */
  67   ~PageTurnPortraitView();
  68
  69   /**
  70    * @brief Create an initialized  PageTurnPortraitView control
  71    * @SINCE_1_1.4
  72    * @param[in] pageFactory The factory which provides PageTurnView with pages.
  73    * @param[in] viewPageSize The size of the page
  74    * @return A handle to the PageTurnPortraitView control.
  75    */
  76   static PageTurnPortraitView New(PageFactory& pageFactory, const Vector2& viewPageSize);
  77
  78   /**
  79    * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnPortraitView the
  80    * downcast produces valid handle. If not the returned handle is left uninitialized.
  81    * @SINCE_1_1.4
  82    * @param[in] handle Handle to an object
  83    * @return handle to a PageTurnPortraitView or an uninitialized handle
  84    */
  85   static PageTurnPortraitView DownCast(BaseHandle handle);
  86
  87 public: // Not intended for application developers
  88   /// @cond internal
  89   /**
  90    * @brief Creates a handle using the Toolkit::Internal implementation.
  91    * @SINCE_1_1.4
  92    * @param[in]  implementation  The Control implementation.
  93    */
  94   DALI_INTERNAL PageTurnPortraitView(Internal::PageTurnPortraitView& implementation);
  95
  96   /**
  97    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
  98    * @SINCE_1_1.4
  99    * @param[in]  internal  A pointer to the internal CustomActor.
 100    */
 101   explicit DALI_INTERNAL PageTurnPortraitView(Dali::Internal::CustomActor* internal);
 102   /// @endcond
 103 };
 104
 105 } // namespace Toolkit
 106
 107 } // namespace Dali
 108
 109 #endif /* DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H */