dali-toolkit/public-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) 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 // EXTERNAL INCLUDES
  22 #include <dali/public-api/actors/actor.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 /**
  31  * PageFactory is an abstract interface for providing image actors to PageTurnView
  32  * Each image actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfPages()-1
  33  *
  34  * @since DALi 1.1.4
  35  */
  36 class DALI_IMPORT_API PageFactory
  37 {
  38 public:
  39
  40   /**
  41    * Virtual destructor
  42    */
  43   virtual ~PageFactory(){};
  44
  45   /**
  46    * Query the number of pages available from the factory.
  47    * The maximum available page has an ID of GetNumberOfPages()-1.
  48    */
  49   virtual unsigned int GetNumberOfPages() = 0;
  50
  51   /**
  52    * Create an actor to represent the page content.
  53    * @param[in] pageId The ID of the page to create.
  54    * @return An actor, or an uninitialized pointer if the ID is out of range.
  55    */
  56   virtual Actor NewPage( unsigned int pageId ) = 0;
  57 };
  58
  59 } // namespace Toolkit
  60
  61 } // namespace Dali
  62 #endif /* __DALI_TOOLKIT_PAGE_FACTORY_H__ */