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