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