optional/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) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 //INTERNAL INCLUDES
  21 #include <dali-toolkit/public-api/controls/page-turn-view/page-turn-view.h>
  22
  23 namespace Dali DALI_IMPORT_API
  24 {
  25
  26 namespace Toolkit
  27 {
  28
  29 namespace Internal DALI_INTERNAL
  30 {
  31 // Forward declarations
  32 class PageTurnPortraitView;
  33 }
  34
  35 /**
  36  * PageTurnLandscapeView provides a page turn view in portrait mode
  37  */
  38 class PageTurnPortraitView : public PageTurnView
  39 {
  40 public:
  41   /**
  42    * Create an uninitialized PageTurnPortraitView; this can be initialized with PageTurnPortraitView::New()
  43    * Calling member functions with an uninitialized Dali::Object is not allowed.
  44    */
  45   PageTurnPortraitView();
  46
  47   /**
  48    * Copy constructor.
  49    */
  50   PageTurnPortraitView( const PageTurnPortraitView& pageTurnPortraitView );
  51
  52   /**
  53    * Assignment operator.
  54    */
  55   PageTurnPortraitView& operator=( const PageTurnPortraitView& pageTurnPortraitView );
  56
  57   /**
  58    * Virtual destructor.
  59    * Dali::Object derived classes typically do not contain member data.
  60    */
  61   virtual ~PageTurnPortraitView();
  62
  63   /**
  64    * Create an initialized  PageTurnPortraitView control
  65    * @param[in] pageFactory The factory which provides PageTurnView with pages.
  66    * @param[in] pageSize The size of the page
  67    * @return A handle to the PageTurnPortraitView control.
  68    */
  69   static PageTurnPortraitView New( PageFactory& pageFactory, const Vector2& pageSize );
  70
  71   /**
  72    * Downcast an Object handle to PageTurnPortraitView. If handle points to a PageTurnPortraitView the
  73    * downcast produces valid handle. If not the returned handle is left uninitialized.
  74    * @param[in] handle Handle to an object
  75    * @return handle to a PageTurnPortraitView or an uninitialized handle
  76    */
  77   static PageTurnPortraitView DownCast( BaseHandle handle );
  78
  79 public: // Not intended for application developers
  80
  81   /**
  82    * Creates a handle using the Toolkit::Internal implementation.
  83    * @param[in]  implementation  The Control implementation.
  84    */
  85   PageTurnPortraitView( Internal::PageTurnPortraitView& implementation );
  86
  87   /**
  88    * Allows the creation of this Control from an Internal::CustomActor pointer.
  89    * @param[in]  internal  A pointer to the internal CustomActor.
  90    */
  91   PageTurnPortraitView( Dali::Internal::CustomActor* internal );
  92 };
  93
  94 } // namespace Toolkit
  95
  96 } // namespace Dali
  97
  98 #endif /* __DALI_TOOLKIT_PAGE_TURN_PORTRAIT_VIEW_H__ */