Purge underscored header file barriers

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / controls / scrollable / item-view / item-factory.h

diff --git a/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h b/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h
index e02c62b..49ed6d3 100644 (file)
--- a/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h
+++ b/dali-toolkit/public-api/controls/scrollable/item-view/item-factory.h
@@ -1,8 +1,8 @@
-#ifndef __DALI_TOOLKIT_ITEM_FACTORY_H__
-#define __DALI_TOOLKIT_ITEM_FACTORY_H__
+#ifndef DALI_TOOLKIT_ITEM_FACTORY_H
+#define DALI_TOOLKIT_ITEM_FACTORY_H
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2019 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,52 +21,81 @@
 // EXTERNAL INCLUDES
 #include <dali/public-api/actors/actor.h>
 
+// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
+
 namespace Dali
 {
 
 namespace Toolkit
 {
+/**
+ * @addtogroup dali_toolkit_controls_item_view
+ * @{
+ */
 
 /**
  * @brief ItemFactory is for providing actors to ItemView.
+ *
  * Each actor is identified by a unique ID, and has a linear order from 0 to GetNumberOfItems()-1.
+ * @SINCE_1_0.0
  */
 class ItemFactory
 {
 public:
 
+  class Extension; ///< Forward declare future extension interface
+
   /**
    * @brief Virtual destructor.
+   * @SINCE_1_0.0
    */
-  DALI_EXPORT_API virtual ~ItemFactory() = 0;
+  DALI_TOOLKIT_API virtual ~ItemFactory() {};
 
   /**
-   * @brief Query the number of items available from the factory.
+   * @brief Queries the number of items available from the factory.
    *
    * The maximum available item has an ID of GetNumberOfItems() - 1.
-   * @return the number of items
+   * @SINCE_1_0.0
+   * @return The number of items
    */
   virtual unsigned int GetNumberOfItems() = 0;
 
   /**
-   * @brief Create an Actor to represent a visible item.
+   * @brief Creates an Actor to represent a visible item.
    *
-   * @param[in] itemId The ID of the newly visible item.
-   * @return An actor, or an uninitialized pointer if the ID is out of range.
+   * @SINCE_1_0.0
+   * @param[in] itemId The ID of the newly visible item
+   * @return An actor, or an uninitialized pointer if the ID is out of range
    */
   virtual Actor NewItem(unsigned int itemId) = 0;
 
   /**
-   * @brief Notify the factory the actor representing the item is removed from ItemView.
+   * @brief Notifies the factory the actor representing the item is removed from ItemView.
    *
-   * @param[in] itemId The ID of the released item.
-   * @param[in] actor The actor that represents the released item.
+   * @SINCE_1_0.0
+   * @param[in] itemId The ID of the released item
+   * @param[in] actor The actor that represents the released item
    */
   virtual void ItemReleased(unsigned int itemId, Actor actor) {};
+
+  /**
+   * @brief Retrieves the extension for this control.
+   *
+   * @SINCE_1_0.0
+   * @return The extension if available, NULL otherwise
+   */
+  virtual Extension* GetExtension()
+  {
+    return NULL;
+  }
 };
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali
 
-#endif // __DALI_TOOLKIT_ITEM_FACTORY_H__
+#endif // DALI_TOOLKIT_ITEM_FACTORY_H