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 Flora License, Version 1.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://floralicense.org/license/
  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  * @addtogroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE
  22  * @{
  23  */
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/dali.h>
  27
  28 namespace Dali DALI_IMPORT_API
  29 {
  30
  31 namespace Toolkit
  32 {
  33
  34 /**
  35  * @brief ItemFactory is an abstract interface 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  */
  38 class ItemFactory
  39 {
  40 public:
  41
  42   /**
  43    * @brief Virtual destructor.
  44    */
  45   virtual ~ItemFactory() = 0;
  46
  47   /**
  48    * @brief Query the number of items available from the factory.
  49    *
  50    * The maximum available item has an ID of GetNumberOfItems() - 1.
  51    * @return the number of items
  52    */
  53   virtual unsigned int GetNumberOfItems() = 0;
  54
  55   /**
  56    * @brief Create an Actor to represent a visible item.
  57    *
  58    * @param[in] itemId The ID of the newly visible item.
  59    * @return An actor, or an uninitialized pointer if the ID is out of range.
  60    */
  61   virtual Actor NewItem(unsigned int itemId) = 0;
  62 };
  63
  64 } // namespace Toolkit
  65
  66 } // namespace Dali
  67
  68 /**
  69  * @}
  70  */
  71 #endif // __DALI_TOOLKIT_ITEM_FACTORY_H__