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