dali/devel-api/object/property-helper-devel.h

   1 #ifndef __DALI_PROPERTY_HELPER_DEVEL_H__
   2 #define __DALI_PROPERTY_HELPER_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/public-api/object/type-registry-helper.h>
  23
  24 /**
  25  * @brief These macros are used internally by the property macros.
  26  * Use the the property macros in the section below this one (without the _INTERNAL postfix) when defining properties.
  27  * These internal macros exist as to perform the compile-time check on the enumeration order, the __COUNTER__ macro is used twice.
  28  * Using it twice within the same macro would result in two different values.
  29  */
  30 #define DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL( count, typeRegistrationObject, objectNamespace, objectType, develNamespace, text, valueType, enumIndex ) \
  31   Dali::PropertyRegistration DALI_TOKEN_PASTE( property, count ) ( typeRegistrationObject, text, objectNamespace:: develNamespace ::Property::enumIndex, Dali::Property::valueType, &objectType::SetProperty, &objectType::GetProperty ); \
  32   DALI_COMPILE_TIME_ASSERT( ( objectNamespace:: develNamespace ::Property::enumIndex - objectNamespace::objectType::PROPERTY_START_INDEX ) == count );
  33
  34 /**
  35  * @copydoc DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL
  36  */
  37 #define DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL_READ_ONLY( count, typeRegistrationObject, objectNamespace, objectType, develNamespace, text, valueType, enumIndex ) \
  38   Dali::PropertyRegistration DALI_TOKEN_PASTE( property, count ) ( typeRegistrationObject, text, objectNamespace:: develNamespace ::Property::enumIndex, Dali::Property::valueType, NULL, &objectType::GetProperty ); \
  39   DALI_COMPILE_TIME_ASSERT( ( objectNamespace:: develNamespace ::Property::enumIndex - objectNamespace::objectType::PROPERTY_START_INDEX ) == count );
  40
  41 /**
  42  * @copydoc DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL
  43  */
  44 #define DALI_DEVEL_ANIMATABLE_PROPERTY_REGISTRATION_INTERNAL( count, typeRegistrationObject, objectNamespace, objectType, develNamespace, text, valueType, enumIndex) \
  45   Dali::AnimatablePropertyRegistration DALI_TOKEN_PASTE( property, count ) ( typeRegistrationObject, text, objectNamespace:: develNamespace::Property::enumIndex, Dali::Property::valueType );
  46 /**
  47  * @brief These macros are used to define properties for implementations of CustomActor.
  48  *
  49  * These macros should be used when defining devel properties
  50  * They provide the following benefits:
  51  * - A standard and consistent way to define properties.
  52  * - Concise definition promotes readability, especially with large numbers of properties.
  53  * - Provides a built-in compile-time check. This checks the order of the properties within the enumeration match the order of the property macros. Note: This check is not performed for animatable properties.
  54  * - Enforces how properties are enumerated in the object handles header file.
  55  *
  56  * Note: The compile-type check will produce the following message on failure:
  57  *       error: invalid application of 'sizeof' to incomplete type 'Dali::CompileTimeAssertBool<false>'
  58  *
  59  * Macro usage example:
  60  *
  61  * Within the your object's implementation cpp:
  62  * @code
  63  * #include <dali/public-api/object/devel-property-helper.h>
  64  * ...
  65  * DALI_TYPE_REGISTRATION_BEGIN( MyApp::MyCustomActor, Dali::CustomActor, Create )
  66  * DALI_DEVEL_PROPERTY_REGISTRATION( MyApp, MyCustomActor, "myProperty", INTEGER, MY_DEVEL_PROPERTY )
  67  * DALI_TYPE_REGISTRATION_END()
  68  * @endcode
  69  *
  70  * Within your handle's header:
  71  *
  72  * @code
  73  * #include <dali/public-api/common/dali-common.h>
  74  *
  75  *
  76  * ///< @brief The start and end property ranges for this control.
  77  * enum PropertyRange
  78  * {
  79  *   PROPERTY_START_INDEX = Dali::PROPERTY_REGISTRATION_START_INDEX,
  80  *   PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000
  81  * };
  82  *
  83  * ///< @brief An enumeration of properties belonging to the Button class.
  84  * struct Property
  85  * {
  86  *   enum
  87  *   {
  88  *     MY_PROPERTY = PROPERTY_START_INDEX    ///< @brief name "myProperty", type Integer
  89  *   };
  90  * };
  91  * @endcode
  92  *
  93  * Using these macros have certain prerequisites on how the property enumeration is defined.
  94  * Please see the Programming Guide (within the generated Doxygen) for full details.
  95  */
  96 #define DALI_DEVEL_PROPERTY_REGISTRATION( objectNamespace, objectType, text, valueType, enumIndex ) \
  97   DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL( __COUNTER__, typeRegistration, objectNamespace, objectType, DALI_TOKEN_PASTE( Devel, objectType ), text, valueType, enumIndex  )
  98
  99 /**
 100  * @copydoc DALI_DEVEL_PROPERTY_REGISTRATION
 101  *
 102  * @note For Read Only properties
 103  */
 104 #define DALI_DEVEL_PROPERTY_REGISTRATION_READ_ONLY( objectNamespace, objectType, text, valueType, enumIndex ) \
 105   DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL_READ_ONLY( __COUNTER__, typeRegistration, objectNamespace, objectType, DALI_TOKEN_PASTE( Devel, objectType ), text, valueType, enumIndex  )
 106
 107 /**
 108  * @copydoc DALI_DEVEL_PROPERTY_REGISTRATION_INTERNAL
 109  *
 110  * @note Animatible property registration
 111  */
 112 #define DALI_DEVEL_ANIMATABLE_PROPERTY_REGISTRATION( objectNamespace, objectType, text, valueType, enumIndex ) \
 113   DALI_DEVEL_ANIMATABLE_PROPERTY_REGISTRATION_INTERNAL( __COUNTER__, typeRegistration, objectNamespace, objectType, DALI_TOKEN_PASTE( Devel, objectType ), text, valueType, enumIndex )
 114
 115
 116 #endif // __DALI_PROPERTY_HELPER_DEVEL_H__