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

   1 #ifndef DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H
   2 #define DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_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 PageTurnLandscapeView;
  32 } // namespace DALI_INTERNAL
  33
  34 /**
  35  * @brief PageTurnLandscapeView provides a page turn view in landscape mode
  36  * @SINCE_1_0.0
  37  */
  38 class DALI_TOOLKIT_API PageTurnLandscapeView : public PageTurnView
  39 {
  40 public:
  41   /**
  42    * @brief Create an uninitialized PageTurnLandscapeView; this can be initialized with PageTurnLandscapeView::New()
  43    * Calling member functions with an uninitialized Dali::Object is not allowed.
  44    * @SINCE_1_0.0
  45    */
  46   PageTurnLandscapeView();
  47
  48   /**
  49    * @brief Copy constructor.
  50    * @SINCE_1_0.0
  51    */
  52   PageTurnLandscapeView(const PageTurnLandscapeView& pageTurnLandscapeView);
  53
  54   /**
  55    * @brief Assignment operator.
  56    * @SINCE_1_0.0
  57    */
  58   PageTurnLandscapeView& operator=(const PageTurnLandscapeView& pageTurnLandscapeView);
  59
  60   /**
  61    * @brief Destructor
  62    *
  63    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  64    * @SINCE_1_0.0
  65    */
  66   ~PageTurnLandscapeView();
  67
  68   /**
  69    * @brief Create an initialized PageTurnLandscapeView control
  70    * @SINCE_1_0.0
  71    * @param[in] pageFactory The factory which provides PageTurnView with pages.
  72    * @param[in] viewPageSize The size of the page
  73    * @return A handle to the PageTurnLandscapeView control.
  74    */
  75   static PageTurnLandscapeView New(PageFactory& pageFactory, const Vector2& viewPageSize);
  76
  77   /**
  78    * @brief Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnLandscapeView the
  79    * downcast produces valid handle. If not the returned handle is left uninitialized.
  80    * @SINCE_1_0.0
  81    * @param[in] handle Handle to an object
  82    * @return handle to a PageTurnLandscapeView or an uninitialized handle
  83    */
  84   static PageTurnLandscapeView DownCast(BaseHandle handle);
  85
  86 public: // Not intended for application developers
  87   /// @cond internal
  88   /**
  89    * @brief Creates a handle using the Toolkit::Internal implementation.
  90    * @SINCE_1_0.0
  91    * @param[in]  implementation  The Control implementation.
  92    */
  93   DALI_INTERNAL PageTurnLandscapeView(Internal::PageTurnLandscapeView& implementation);
  94
  95   /**
  96    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
  97    * @SINCE_1_0.0
  98    * @param[in]  internal  A pointer to the internal CustomActor.
  99    */
 100   explicit DALI_INTERNAL PageTurnLandscapeView(Dali::Internal::CustomActor* internal);
 101   /// @endcond
 102 };
 103
 104 } // namespace Toolkit
 105
 106 } // namespace Dali
 107
 108 #endif /* DALI_TOOLKIT_PAGE_TURN_LANDSCAPE_VIEW_H */