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