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