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