(ScrollBar) Moved all properties to Public 44/153944/3
authorAdeel Kazmi <adeel.kazmi@samsung.com>
Tue, 3 Oct 2017 16:45:05 +0000 (17:45 +0100)
committerAdeel Kazmi <adeel.kazmi@samsung.com>
Tue, 3 Oct 2017 18:56:46 +0000 (19:56 +0100)
Change-Id: Ib68bc51803b0014ec35fcfd5d60ad8b0939b78ea

automated-tests/src/dali-toolkit/utc-Dali-ScrollBar.cpp
build/tizen/dali-toolkit/Makefile.am
dali-toolkit/devel-api/controls/scroll-bar/scroll-bar-devel.h [deleted file]
dali-toolkit/devel-api/file.list
dali-toolkit/internal/controls/scroll-bar/scroll-bar-impl.cpp
dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h

index f3a377c..d4401ea 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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,7 +21,6 @@
 #include <dali-toolkit-test-suite-utils.h>
 #include <dali-toolkit/dali-toolkit.h>
 #include <dali/integration-api/events/pan-gesture-event.h>
-#include <dali-toolkit/devel-api/controls/scroll-bar/scroll-bar-devel.h>
 
 using namespace Dali;
 using namespace Toolkit;
@@ -1540,7 +1539,7 @@ int UtcDaliToolkitScrollBarActionShowTransientIndicator(void)
 
   // Get the default duration to hide the indicator
   float hideDuration = scrollBar.GetProperty<float>( ScrollBar::Property::INDICATOR_HIDE_DURATION );
-  float transientDuration = scrollBar.GetProperty<float>( DevelScrollBar::Property::INDICATOR_TRANSIENT_DURATION );
+  float transientDuration = scrollBar.GetProperty<float>( ScrollBar::Property::INDICATOR_TRANSIENT_DURATION );
   float totalVisibleDuration = hideDuration + transientDuration;
 
   // Check that the default duration is greater than 0
@@ -1600,7 +1599,7 @@ int UtcDaliToolkitScrollBarActionShowTransientIndicatorImmediate(void)
 
   // Get the default duration to hide the indicator
   float hideDuration = scrollBar.GetProperty<float>( ScrollBar::Property::INDICATOR_HIDE_DURATION );
-  float transientDuration = scrollBar.GetProperty<float>( DevelScrollBar::Property::INDICATOR_TRANSIENT_DURATION );
+  float transientDuration = scrollBar.GetProperty<float>( ScrollBar::Property::INDICATOR_TRANSIENT_DURATION );
   float totalVisibleDuration = hideDuration + transientDuration;
 
   // Check that the default duration is greater than 0
@@ -1685,7 +1684,7 @@ int UtcDaliToolkitScrollBarActionShowTransientIndicatorDuringHide(void)
 
   // Get the default duration to hide the indicator
   float hideDuration = scrollBar.GetProperty<float>( ScrollBar::Property::INDICATOR_HIDE_DURATION );
-  float transientDuration = scrollBar.GetProperty<float>( DevelScrollBar::Property::INDICATOR_TRANSIENT_DURATION );
+  float transientDuration = scrollBar.GetProperty<float>( ScrollBar::Property::INDICATOR_TRANSIENT_DURATION );
   float totalVisibleDuration = hideDuration + transientDuration;
 
   // Check that the default duration is greater than 0
index 587d3b6..4fbd30a 100644 (file)
@@ -137,7 +137,6 @@ develapibuttonsdir =            $(develapicontrolsdir)/buttons
 develapieffectsviewdir =        $(develapicontrolsdir)/effects-view
 develapigaussianblurviewdir =   $(develapicontrolsdir)/gaussian-blur-view
 develapimagnifierdir =          $(develapicontrolsdir)/magnifier
-develapiscrollbardir =          $(develapicontrolsdir)/scroll-bar
 develapinavigationviewdir =     $(develapicontrolsdir)/navigation-view
 develapipageturnviewdir =       $(develapicontrolsdir)/page-turn-view
 develapipopupdir =              $(develapicontrolsdir)/popup
@@ -166,7 +165,6 @@ develapieffectsview_HEADERS =       $(devel_api_effects_view_header_files)
 develapifocusmanager_HEADERS =      $(devel_api_focus_manager_header_files)
 develapigaussianblurview_HEADERS =  $(devel_api_gaussian_blur_view_header_files)
 develapiimageloader_HEADERS =       $(devel_api_image_loader_header_files)
-develapiscrollbar_HEADERS =         $(devel_api_scroll_bar_header_files)
 develapimagnifier_HEADERS =         $(devel_api_magnifier_header_files)
 develapinavigationview_HEADERS =    $(devel_api_navigation_view_header_files)
 develapipageturnview_HEADERS =      $(devel_api_page_turn_view_header_files)
diff --git a/dali-toolkit/devel-api/controls/scroll-bar/scroll-bar-devel.h b/dali-toolkit/devel-api/controls/scroll-bar/scroll-bar-devel.h
deleted file mode 100644 (file)
index 7d16c75..0000000
+++ /dev/null
@@ -1,78 +0,0 @@
-#ifndef DALI_TOOLKIT_SCROLL_BAR_DEVEL_H
-#define DALI_TOOLKIT_SCROLL_BAR_DEVEL_H
-
-/*
- * Copyright (c) 2017 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.
- *
- */
-
-// INTERNAL INCLUDES
-#include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
-
-namespace Dali
-{
-
-namespace Toolkit
-{
-
-namespace DevelScrollBar
-{
-
-namespace Property
-{
-
-/**
- * @brief ScrollBar is a UI component that can be linked to the scrollable objects
- * indicating the current scroll position of the scrollable object.
- *
- * Actions
- * | %Action Name           | Attributes              | Description                               |
- * |------------------------|-------------------------|-------------------------------------------|
- * | ShowIndicator          | Doesn't have attributes | Shows the scroll-indicator                |
- * | HideIndicator          | Doesn't have attributes | Hides the scroll-indicator                |
- * | ShowTransientIndicator | Doesn't have attributes | Shows the scroll-indicator for short time |
- */
-
-/**
- * @brief Enumeration for the instance of properties belonging to the ScrollBar class.
- */
-enum
-{
-  SCROLL_DIRECTION          = Dali::Toolkit::ScrollBar::Property::SCROLL_DIRECTION,
-  INDICATOR_HEIGHT_POLICY   = Dali::Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY,
-  INDICATOR_FIXED_HEIGHT    = Dali::Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT,
-  INDICATOR_SHOW_DURATION   = Dali::Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION,
-  INDICATOR_HIDE_DURATION   = Dali::Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION,
-  SCROLL_POSITION_INTERVALS = Dali::Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS,
-  INDICATOR_MINIMUM_HEIGHT  = Dali::Toolkit::ScrollBar::Property::INDICATOR_MINIMUM_HEIGHT,
-  INDICATOR_START_PADDING   = Dali::Toolkit::ScrollBar::Property::INDICATOR_START_PADDING,
-  INDICATOR_END_PADDING     = Dali::Toolkit::ScrollBar::Property::INDICATOR_END_PADDING,
-
-  /**
-   * @brief The duration that transient indicators will remain fully visible.
-   * @details name "indicatorTransientDuration", type float.
-   */
-  INDICATOR_TRANSIENT_DURATION = INDICATOR_END_PADDING + 1
-};
-
-} // namespace Property
-
-} // namespace DevelScrollBar
-
-} // namespace Toolkit
-
-} // namespace Dali
-
-#endif // DALI_TOOLKIT_SCROLL_BAR_DEVEL_H
index caad422..9c657a4 100644 (file)
@@ -70,9 +70,6 @@ devel_api_builder_header_files = \
 devel_api_effects_view_header_files = \
   $(devel_api_src_dir)/controls/effects-view/effects-view.h
 
-devel_api_scroll_bar_header_files = \
-  $(devel_api_src_dir)/controls/scroll-bar/scroll-bar-devel.h
-
 devel_api_magnifier_header_files = \
   $(devel_api_src_dir)/controls/magnifier/magnifier.h
 
index 4360f1e..45cf8b7 100755 (executable)
@@ -32,7 +32,6 @@
 // INTERNAL INCLUDES
 #include <dali-toolkit/internal/controls/scrollable/item-view/item-view-impl.h>
 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
-#include <dali-toolkit/devel-api/controls/scroll-bar/scroll-bar-devel.h>
 
 using namespace Dali;
 
@@ -166,8 +165,7 @@ DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "scrollPositionIntervals",
 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorMinimumHeight",            FLOAT,  INDICATOR_MINIMUM_HEIGHT     )
 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorStartPadding",             FLOAT,  INDICATOR_START_PADDING      )
 DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorEndPadding",               FLOAT,  INDICATOR_END_PADDING        )
-
-DALI_DEVEL_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorTransientDuration", FLOAT,  INDICATOR_TRANSIENT_DURATION )
+DALI_PROPERTY_REGISTRATION( Toolkit, ScrollBar, "indicatorTransientDuration",        FLOAT,  INDICATOR_TRANSIENT_DURATION )
 
 DALI_SIGNAL_REGISTRATION(   Toolkit, ScrollBar, "panFinished",                       PAN_FINISHED_SIGNAL                     )
 DALI_SIGNAL_REGISTRATION(   Toolkit, ScrollBar, "scrollPositionIntervalReached",     SCROLL_POSITION_INTERVAL_REACHED_SIGNAL )
@@ -722,7 +720,7 @@ void ScrollBar::SetProperty( BaseObject* object, Property::Index index, const Pr
         scrollBarImpl.ApplyConstraints();
         break;
       }
-      case Toolkit::DevelScrollBar::Property::INDICATOR_TRANSIENT_DURATION:
+      case Toolkit::ScrollBar::Property::INDICATOR_TRANSIENT_DURATION:
       {
         scrollBarImpl.mTransientIndicatorDuration = value.Get<float>();
         break;
@@ -801,7 +799,7 @@ Property::Value ScrollBar::GetProperty( BaseObject* object, Property::Index inde
         value = scrollBarImpl.mIndicatorEndPadding;
         break;
       }
-      case Toolkit::DevelScrollBar::Property::INDICATOR_TRANSIENT_DURATION:
+      case Toolkit::ScrollBar::Property::INDICATOR_TRANSIENT_DURATION:
       {
         value = scrollBarImpl.mTransientIndicatorDuration;
         break;
index 3bd0adc..2a9df0d 100755 (executable)
@@ -2,7 +2,7 @@
 #define __DALI_TOOLKIT_SCROLL_BAR_H__
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2017 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.
@@ -78,59 +78,84 @@ public:
     enum
     {
       /**
-       * @brief name "scrollDirection", type std::string.
+       * @brief The scrolling direction of the indicator.
+       * @details Name "scrollDirection", type Property::STRING.
+       *          Possible values are "Vertical" and "Horizontal".
        * @SINCE_1_0.0
        * @see SetScrollDirection()
        */
       SCROLL_DIRECTION = PROPERTY_START_INDEX,
+
       /**
-       * @brief name "indicatorHeightPolicy", type std::string.
+       * @brief The indicator height policy.
+       * @details Name "indicatorHeightPolicy", type Property::STRING.
+       *          Possible values are "Variable" and "Fixed".
        * @SINCE_1_0.0
        * @see SetIndicatorHeightPolicy()
        */
       INDICATOR_HEIGHT_POLICY,
+
       /**
-       * @brief name "indicatorFixedHeight", type float.
+       * @brief The fixed height of the indicator.
+       * @details Name "indicatorFixedHeight", type Property::FLOAT.
        * @SINCE_1_0.0
        * @see SetIndicatorFixedHeight()
        */
       INDICATOR_FIXED_HEIGHT,
+
       /**
-       * @brief name "indicatorShowDuration", type float.
+       * @brief The duration in seconds to show the indicator.
+       * @details Name "indicatorShowDuration", type Property::FLOAT.
        * @SINCE_1_0.0
        * @see SetIndicatorShowDuration()
        */
       INDICATOR_SHOW_DURATION,
+
       /**
-       * @brief name "indicatorHideDuration", type float.
+       * @brief The duration in seconds to hide the indicator.
+       * @details Name "indicatorHideDuration", type Property::FLOAT.
        * @SINCE_1_0.0
        * @see SetIndicatorHideDuration()
        */
       INDICATOR_HIDE_DURATION,
+
       /**
-       * @brief name "scrollPositionIntervals", type Property::Array.
+       * @brief The intervals at which point a notification is emitted.
+       * @details Name "scrollPositionIntervals", type Property::ARRAY.
        * @SINCE_1_0.0
        * @see SetScrollPositionIntervals()
        */
       SCROLL_POSITION_INTERVALS,
+
       /**
-       * @brief name "indicatorMinimumHeight", type float.
-       * The minimum height for a variable size indicator.
+       * @brief The minimum height for a variable size indicator.
+       * @details Name "indicatorMinimumHeight", type Property::FLOAT.
        * @SINCE_1_1.36
        */
       INDICATOR_MINIMUM_HEIGHT,
+
       /**
-       * @brief name "indicatorStartPadding", type float.
-       * The padding at the start of the indicator. For example, the top if scrollDirection is Vertical.
+       * @brief The padding at the start of the indicator.
+       * @details Name "indicatorStartPadding", type Property::FLOAT.
+       *          For example, the padding at the top if scrollDirection is Vertical.
        * @SINCE_1_1.36
        */
       INDICATOR_START_PADDING,
+
       /**
-       * @brief name "indicatorEndPadding", type float.
-       * The padding at the end of the indicator. For example, the bottom if scrollDirection is Vertical.
+       * @brief The padding at the end of the indicator.
+       * @details Name "indicatorEndPadding", type Property::FLOAT.
+       *          For example, the padding at the bottom if scrollDirection is Vertical.
        * @SINCE_1_1.36
        */
-      INDICATOR_END_PADDING
+      INDICATOR_END_PADDING,
+
+      /**
+       * @brief The duration that transient indicators will remain fully visible.
+       * @details name "indicatorTransientDuration", type Property::FLOAT.
+       * @SINCE_1_2.60
+       */
+      INDICATOR_TRANSIENT_DURATION,
     };
   };