capi/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) 2014 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 /**
  22  * @addtogroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE
  23  * @{
  24  */
  25
  26 // INTERNAL INCLUDES
  27 #include <dali/dali.h>
  28
  29 namespace Dali DALI_IMPORT_API
  30 {
  31
  32 namespace Toolkit
  33 {
  34
  35 /**
  36  * @brief ItemFactory is for providing actors to ItemView.
  37  * Each actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfItems()-1.
  38  */
  39 class ItemFactory
  40 {
  41 public:
  42
  43   /**
  44    * @brief Virtual destructor.
  45    */
  46   virtual ~ItemFactory() = 0;
  47
  48   /**
  49    * @brief Query the number of items available from the factory.
  50    *
  51    * The maximum available item has an ID of GetNumberOfItems() - 1.
  52    * @return the number of items
  53    */
  54   virtual unsigned int GetNumberOfItems() = 0;
  55
  56   /**
  57    * @brief Create an Actor to represent a visible item.
  58    *
  59    * @param[in] itemId The ID of the newly visible item.
  60    * @return An actor, or an uninitialized pointer if the ID is out of range.
  61    */
  62   virtual Actor NewItem(unsigned int itemId) = 0;
  63
  64   /**
  65    * @brief Notify the factory the actor representing the item is removed from ItemView.
  66    *
  67    * @param[in] itemId The ID of the released item.
  68    * @param[in] actor The actor that represents the released item.
  69    */
  70   virtual void ItemReleased(unsigned int itemId, Actor actor) {};
  71 };
  72
  73 } // namespace Toolkit
  74
  75 } // namespace Dali
  76
  77 /**
  78  * @}
  79  */
  80 #endif // __DALI_TOOLKIT_ITEM_FACTORY_H__