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