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