dali/public-api/object/property-index-ranges.h

   1 #ifndef __DALI_PROPERTY_INDEX_RANGES_H__
   2 #define __DALI_PROPERTY_INDEX_RANGES_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/public-api/common/dali-common.h>
  23
  24 namespace Dali
  25 {
  26
  27 /**
  28  * @brief These are the property index ranges.
  29  *
  30  * Enumerations are being used here rather than static constants so that switch statements can be
  31  * used to compare property indices.
  32  */
  33 enum PropertyRanges
  34 {
  35   DEFAULT_ACTOR_PROPERTY_START_INDEX            = 0,          ///< Start index for Actor (and other base classes).
  36   DEFAULT_ACTOR_PROPERTY_MAX_COUNT              = 10000,      ///< Actor range: 0 to 9999
  37
  38   DEFAULT_DERIVED_HANDLE_PROPERTY_START_INDEX   = DEFAULT_ACTOR_PROPERTY_START_INDEX,         ///< For non-Actor objects.
  39
  40   DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX    = DEFAULT_ACTOR_PROPERTY_START_INDEX + DEFAULT_ACTOR_PROPERTY_MAX_COUNT, ///< Property start index for classes deriving directly from Actor.
  41
  42   DEFAULT_PROPERTY_MAX_COUNT_PER_DERIVATION     = 10000,      ///< Second-level and onwards derived objects should increment their start index by this.
  43
  44   DEFAULT_GESTURE_DETECTOR_PROPERTY_START_INDEX = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< Used by PanGestureDetector.
  45
  46   PROPERTY_REGISTRATION_START_INDEX             = 10000000,   ///< The index when registering a property should start from this number.
  47   DEFAULT_PROPERTY_MAX_COUNT                    = PROPERTY_REGISTRATION_START_INDEX,          ///< Default Property Range: 0 to 9999999
  48
  49   PROPERTY_REGISTRATION_MAX_INDEX               = 19999999,   ///< The maximum index supported when registering a property
  50   PROPERTY_CUSTOM_START_INDEX                   = 50000000,   ///< The index at which custom properties start
  51 };
  52
  53 } // namespace Dali
  54
  55 #endif // __DALI_PROPERTY_INDEX_RANGES_H__