dali-toolkit/public-api/controls/scrollable/scroll-view/scroll-mode.h

   1 #ifndef DALI_TOOLKIT_SCROLL_VIEW_SCROLL_MODE_H
   2 #define DALI_TOOLKIT_SCROLL_VIEW_SCROLL_MODE_H
   3
   4 /*
   5  * Copyright (c) 2020 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 namespace Dali
  21 {
  22 namespace Toolkit
  23 {
  24 /**
  25  * @addtogroup dali_toolkit_controls_scroll_view
  26  * @{
  27  */
  28
  29 /**
  30  * @brief Properties to use in a Property::MAP when setting a ScrollView's scroll mode.
  31  * @SINCE_1_2.60
  32  */
  33 namespace ScrollMode
  34 {
  35 /**
  36  * @brief Properties to use in a Property::MAP when setting a ScrollView's scroll mode.
  37  * @SINCE_1_2.60
  38  */
  39 enum Type
  40 {
  41   /**
  42    * @brief Whether the content can be scrolled along the X axis or not.
  43    * @details Name "xAxisScrollEnabled", type Property::BOOLEAN.
  44    * @SINCE_1_2.60
  45    */
  46   X_AXIS_SCROLL_ENABLED,
  47
  48   /**
  49    * @brief When set, causes scroll view to snap to multiples of the
  50    * value of the interval while flicking along the X axis.
  51    * @details Name "xAxisSnapToInterval", type Property::FLOAT
  52    * @SINCE_1_2.60
  53    * @note By default, there is no snapping.
  54    */
  55   X_AXIS_SNAP_TO_INTERVAL,
  56
  57   /**
  58    * @brief When set, the scroll view is unable to scroll beyond the
  59    * value of the boundary along the X axis.
  60    * @details Name "xAxisScrollBoundary", type Property::FLOAT.
  61    * @SINCE_1_2.60
  62    * @note By default, there is no boundary.
  63    */
  64   X_AXIS_SCROLL_BOUNDARY,
  65
  66   /**
  67    * @brief Whether the content can be scrolled along the Y axis or not.
  68    * @details Name "yAxisScrollEnabled", type Property::BOOLEAN
  69    * @SINCE_1_2.60
  70    */
  71   Y_AXIS_SCROLL_ENABLED,
  72
  73   /**
  74    * @brief When set, causes scroll view to snap to multiples of the
  75    * value of the interval while flicking along the Y axis.
  76    * @details Name "yAxisSnapToInterval", type Property::FLOAT.
  77    * @SINCE_1_2.60
  78    * @note By default, there is no snapping.
  79    */
  80   Y_AXIS_SNAP_TO_INTERVAL,
  81
  82   /**
  83    * @brief When set, the scroll view is unable to scroll beyond the
  84    * value of the boundary along the Y axis.
  85    * @details Name "yAxisScrollBoundary", type Property::FLOAT.
  86    * @SINCE_1_2.60
  87    * @note By default, there is no boundary.
  88    */
  89   Y_AXIS_SCROLL_BOUNDARY
  90 };
  91
  92 } // namespace ScrollMode
  93
  94 /**
  95  * @}
  96  */
  97
  98 } // namespace Toolkit
  99
 100 } // namespace Dali
 101
 102 #endif // DALI_TOOLKIT_SCROLL_VIEW_SCROLL_MODE_H