dali-toolkit/devel-api/controls/scroll-bar/scroll-bar-devel.h

   1 #ifndef DALI_TOOLKIT_SCROLL_BAR_DEVEL_H
   2 #define DALI_TOOLKIT_SCROLL_BAR_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2017 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/scroll-bar/scroll-bar.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace DevelScrollBar
  31 {
  32
  33 namespace Property
  34 {
  35
  36 /**
  37  * @brief ScrollBar is a UI component that can be linked to the scrollable objects
  38  * indicating the current scroll position of the scrollable object.
  39  *
  40  * Actions
  41  * | %Action Name           | Attributes              | Description                               |
  42  * |------------------------|-------------------------|-------------------------------------------|
  43  * | ShowIndicator          | Doesn't have attributes | Shows the scroll-indicator                |
  44  * | HideIndicator          | Doesn't have attributes | Hides the scroll-indicator                |
  45  * | ShowTransientIndicator | Doesn't have attributes | Shows the scroll-indicator for short time |
  46  */
  47
  48 /**
  49  * @brief Enumeration for the instance of properties belonging to the ScrollBar class.
  50  */
  51 enum
  52 {
  53   SCROLL_DIRECTION          = Dali::Toolkit::ScrollBar::Property::SCROLL_DIRECTION,
  54   INDICATOR_HEIGHT_POLICY   = Dali::Toolkit::ScrollBar::Property::INDICATOR_HEIGHT_POLICY,
  55   INDICATOR_FIXED_HEIGHT    = Dali::Toolkit::ScrollBar::Property::INDICATOR_FIXED_HEIGHT,
  56   INDICATOR_SHOW_DURATION   = Dali::Toolkit::ScrollBar::Property::INDICATOR_SHOW_DURATION,
  57   INDICATOR_HIDE_DURATION   = Dali::Toolkit::ScrollBar::Property::INDICATOR_HIDE_DURATION,
  58   SCROLL_POSITION_INTERVALS = Dali::Toolkit::ScrollBar::Property::SCROLL_POSITION_INTERVALS,
  59   INDICATOR_MINIMUM_HEIGHT  = Dali::Toolkit::ScrollBar::Property::INDICATOR_MINIMUM_HEIGHT,
  60   INDICATOR_START_PADDING   = Dali::Toolkit::ScrollBar::Property::INDICATOR_START_PADDING,
  61   INDICATOR_END_PADDING     = Dali::Toolkit::ScrollBar::Property::INDICATOR_END_PADDING,
  62
  63   /**
  64    * @brief The duration that transient indicators will remain fully visible.
  65    * @details name "indicatorTransientDuration", type float.
  66    */
  67   INDICATOR_TRANSIENT_DURATION = INDICATOR_END_PADDING + 1
  68 };
  69
  70 } // namespace Property
  71
  72 } // namespace DevelScrollBar
  73
  74 } // namespace Toolkit
  75
  76 } // namespace Dali
  77
  78 #endif // DALI_TOOLKIT_SCROLL_BAR_DEVEL_H