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

   1 #ifndef DALI_TOOLKIT_DEVEL_API_SCROLL_VIEW_SCROLL_MODE_H
   2 #define DALI_TOOLKIT_DEVEL_API_SCROLL_VIEW_SCROLL_MODE_H
   3 /*
   4  * Copyright (c) 2017 Samsung Electronics Co., Ltd.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 namespace Dali
  19 {
  20 namespace Toolkit
  21 {
  22 namespace ScrollMode
  23 {
  24
  25 enum Type
  26 {
  27   /**
  28    * @brief True if the content can be scrolled in X axis or false if
  29    * not.
  30    *
  31    * @details Name "xAxisScrollEnabled", type Property::BOOLEAN
  32    */
  33   X_AXIS_SCROLL_ENABLED,
  34
  35   /**
  36    * @brief When set, causes scroll view to snap to multiples of the
  37    * value of the interval in the X axis while flicking.
  38    *
  39    * By default, there is no snapping.
  40    * @details Name "xAxisSnapToInterval", type Property::FLOAT
  41    */
  42   X_AXIS_SNAP_TO_INTERVAL,
  43
  44   /**
  45    * @brief When set, causes scroll view unable to scroll beyond the
  46    * value of the boundary in the X axis.
  47    *
  48    * By default, there is no boundary.
  49    * @details Name "xAxisScrollBoundary", type Property::FLOAT
  50    */
  51   X_AXIS_SCROLL_BOUNDARY,
  52
  53   /**
  54    * @brief True if the content can be scrolled in Y axis or false if
  55    * not.
  56    *
  57    * @details Name "yAxisScrollEnabled", type Property::BOOLEAN
  58    */
  59   Y_AXIS_SCROLL_ENABLED,
  60
  61   /**
  62    * @brief When set, causes scroll view to snap to multiples of the
  63    * value of the interval in the Y axis while flicking.
  64    *
  65    * By default, there is no snapping.
  66    * @details Name "yAxisSnapToInterval", type Property::FLOAT
  67    */
  68   Y_AXIS_SNAP_TO_INTERVAL,
  69
  70   /**
  71    * @brief When set, causes scroll view unable to scroll beyond the
  72    * value of the boundary in the Y axis.
  73    *
  74    * By default, there is no boundary.
  75    * @details Name "yAxisScrollBoundary", type Property::FLOAT
  76    */
  77   Y_AXIS_SCROLL_BOUNDARY
  78 };
  79
  80 } // ScrollMode
  81 } // toolkit
  82 } // Dali
  83
  84 #endif //DALI_TOOLKIT_DEVEL_API_SCROLL_VIEW_SCROLL_MODE_H