Move the logic of constraint application from ItemView to the layout

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

diff --git a/capi/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h b/capi/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
index d7b04c6..f8a09f8 100644 (file)
--- a/capi/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
+++ b/capi/dali-toolkit/public-api/controls/scrollable/item-view/item-view.h
@@ -1,21 +1,22 @@
 #ifndef __DALI_TOOLKIT_ITEM_VIEW_H__
 #define __DALI_TOOLKIT_ITEM_VIEW_H__
 
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+/*
+ * Copyright (c) 2014 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
 
 /**
  * @addtogroup CAPI_DALI_TOOLKIT_ITEM_VIEW_MODULE
@@ -43,6 +44,7 @@ class ItemView;
 class ScrollConnector;
 class ItemFactory;
 class ItemLayout;
+struct ItemRange;
 
 typedef IntrusivePtr<ItemLayout> ItemLayoutPtr;
 
@@ -74,11 +76,11 @@ public:
   ItemView& operator=( const ItemView& itemView );
 
   /**
-   * @brief Virtual destructor.
+   * @brief Destructor
    *
-   * Dali::Object derived classes typically do not contain member data.
+   * This is non-virtual since derived Handle types must not contain data or virtual methods.
    */
-  virtual ~ItemView();
+  ~ItemView();
 
   /**
    * @brief Create an initialized ItemView.
@@ -175,6 +177,22 @@ public:
   void DeactivateCurrentLayout();
 
   /**
+   * @brief Set default the alpha function used when applying constraints e.g. during ActivateLayout().
+   *
+   * @deprecated Use SetAlphaFunction() in the layout
+   * @param[in] func The default alpha function to use.
+   */
+  void SetDefaultAlphaFunction(AlphaFunction func);
+
+  /**
+   * @brief Retrieve the default alpha function used when applying constraints
+   *
+   * @deprecated Use GetAlphaFunction() in the layout
+   * @return The default alpha function.
+   */
+  AlphaFunction GetDefaultAlphaFunction() const;
+
+  /**
    * @brief Set the minimum swipe speed in pixels per second; A pan
    * gesture must exceed this to trigger a swipe.
    *
@@ -266,18 +284,19 @@ public:
   void ScrollToItem(ItemId itemId, float durationSeconds);
 
   /**
-   * @brief Set the interval between refreshes, during which new items are requested from ItemFactory.
+   * @brief Set the interval between refreshes. When the layout-position of items is changed by this interval,
+   * new items are requested from ItemFactory.
    *
-   * @param[in] intervalMilliseconds The refresh interval in milliseconds.
+   * @param[in] intervalLayoutPositions The refresh interval in layout position.
    */
-  void SetRefreshInterval(unsigned int intervalMilliseconds);
+  void SetRefreshInterval(float intervalLayoutPositions);
 
   /**
-   * @brief Get the interval between refreshes in milliseconds.
+   * @brief Get the interval between refreshes in layout position.
    *
    * @return  The refresh interval
    */
-  unsigned int GetRefreshInterval() const;
+  float GetRefreshInterval() const;
 
   /**
    * @brief Given the Item ID, this returns the accompanying actor.
@@ -366,6 +385,43 @@ public:
    */
   void ReplaceItems(const ItemContainer& replacementItems, float durationSeconds);
 
+  /**
+   * @brief Set the parent origin of the items
+   *
+   * A relayout will occur for all the items if the parent origin is different than the current one.
+   * @param[in] parentOrigin New parent origin position vector
+   */
+  void SetItemsParentOrigin( const Vector3& parentOrigin );
+
+  /**
+   * @brief Get the parent origin of the items
+   *
+   * @return The current parent origin of the items
+   */
+  Vector3 GetItemsParentOrigin() const;
+
+  /**
+   * @brief Set the anchor point of the items
+   *
+   * A relayout will occur for all the items if the anchor point is different than the current one.
+   * @param[in] anchorPoint New anchor point position vector
+   */
+  void SetItemsAnchorPoint( const Vector3& anchorPoint );
+
+  /**
+   * @brief Get the anchor point of the items
+   *
+   * @return The current anchor point of the items
+   */
+  Vector3 GetItemsAnchorPoint() const;
+
+  /**
+   * @brief Get the range of items that are currently in ItemView.
+   *
+   * @param[out] range The range of items.
+   */
+  void GetItemsRange(ItemRange& range);
+
 public: // Not intended for application developers
 
   /**