dali-toolkit/devel-api/controls/page-turn-view/page-factory.h

   1 #ifndef DALI_TOOLKIT_PAGE_FACTORY_H
   2 #define DALI_TOOLKIT_PAGE_FACTORY_H
   3
   4 /*
   5  * Copyright (c) 2020 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/rendering/texture.h>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali-toolkit/public-api/dali-toolkit-common.h>
  26
  27 namespace Dali
  28 {
  29 namespace Toolkit
  30 {
  31 /**
  32  * @brief PageFactory is an abstract interface for providing textures to PageTurnView
  33  * Each page is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1
  34  *
  35  * @SINCE_1_1.4
  36  */
  37 class DALI_TOOLKIT_API PageFactory
  38 {
  39 public:
  40   class Extension; ///< Forward declare future extension interface
  41
  42   /**
  43    * @brief Virtual destructor
  44    */
  45   virtual ~PageFactory(){};
  46
  47   /**
  48    * @brief Query the number of pages available from the factory.
  49    *
  50    * The maximum available page has an ID of GetNumberOfPages()-1.
  51    * @return The page count.
  52    */
  53   virtual unsigned int GetNumberOfPages() = 0;
  54
  55   /**
  56    * @brief Return the texture for the page
  57    *
  58    * For double-sided page( PageTurnLandscapeView ), the left half of texture is used as page front side, and the right half as page back side.
  59    *
  60    * @note Must return a valid texture handle!
  61    *
  62    * @param[in] pageId The ID of the page to create.
  63    * @return An actor, or an uninitialized pointer if the ID is out of range.
  64    */
  65   virtual Texture NewPage(unsigned int pageId) = 0;
  66
  67   /**
  68    * @brief Retrieve the extension for this factory
  69    *
  70    * @return The extension if available, NULL otherwise.
  71    */
  72   virtual Extension* GetExtension()
  73   {
  74     return NULL;
  75   }
  76 };
  77
  78 } // namespace Toolkit
  79
  80 } // namespace Dali
  81 #endif /* DALI_TOOLKIT_PAGE_FACTORY_H */