dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h

   1 #ifndef __DALI_TOOLKIT_ITEM_FACTORY_H__
   2 #define __DALI_TOOLKIT_ITEM_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  * @brief ItemFactory is for providing actors to ItemView.
  32  * Each actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfItems()-1.
  33  */
  34 class ItemFactory
  35 {
  36 public:
  37
  38   class Extension; ///< Forward declare future extension interface
  39
  40   /**
  41    * @brief Virtual destructor.
  42    */
  43   DALI_EXPORT_API virtual ~ItemFactory() = 0;
  44
  45   /**
  46    * @brief Query the number of items available from the factory.
  47    *
  48    * The maximum available item has an ID of GetNumberOfItems() - 1.
  49    * @return the number of items
  50    */
  51   virtual unsigned int GetNumberOfItems() = 0;
  52
  53   /**
  54    * @brief Create an Actor to represent a visible item.
  55    *
  56    * @param[in] itemId The ID of the newly visible item.
  57    * @return An actor, or an uninitialized pointer if the ID is out of range.
  58    */
  59   virtual Actor NewItem(unsigned int itemId) = 0;
  60
  61   /**
  62    * @brief Notify the factory the actor representing the item is removed from ItemView.
  63    *
  64    * @param[in] itemId The ID of the released item.
  65    * @param[in] actor The actor that represents the released item.
  66    */
  67   virtual void ItemReleased(unsigned int itemId, Actor actor) {};
  68
  69   /**
  70    * Retrieve the extension for this control
  71    *
  72    * @return The extension if available, NULL otherwise
  73    */
  74   virtual Extension* GetExtension()
  75   {
  76     return NULL;
  77   }
  78 };
  79
  80 } // namespace Toolkit
  81
  82 } // namespace Dali
  83
  84 #endif // __DALI_TOOLKIT_ITEM_FACTORY_H__