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