inc/FUiEffectsTypes.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 /**
  18  * @file  FUiEffectsTypes.h
  19  * @brief This is the header file for the effect-related types.
  20  *
  21  * This header file contains the declarations of the effect-related types.
  22  */
  23 #ifndef _FUI_EFFECTS_TYPES_H_
  24 #define _FUI_EFFECTS_TYPES_H_
  25
  26 namespace Tizen { namespace Ui { namespace Effects
  27 {
  28 /**
  29  * @enum EffectType
  30  *
  31  * Defines the types of effects.
  32  *
  33  * @since 2.0
  34  */
  35 enum EffectType
  36 {
  37         EFFECT_TYPE_TIME_BASED, /**< The effect model is not managed by user, that is, at the start of the effect @n
  38                                                           the final results and duration are known @n
  39                                                           For example, pressing the button leads to new form appearance with animation. */
  40
  41         EFFECT_TYPE_INTERACTIVE /**< The effect model is managed by user, that is, at the start of the effect it is @n
  42                                                           unknown when and how it will be finished */
  43 };
  44
  45
  46 /**
  47  * @enum EffectResult
  48  *
  49  * Defines the result of effects.
  50  *
  51  * @since 2.0
  52  */
  53 enum EffectResult
  54 {
  55         EFFECT_RESULT_INTERRUPTED = 1,  /**< The effect is interrupted (stopped) with EffectsManager::StopEffect() */
  56         EFFECT_RESULT_FINISHED,         /**< The effect is finished normally */
  57         EFFECT_RESULT_ERROR             /**< There is an error during the execution of the effect */
  58 };
  59
  60 }}} // Tizen::Ui::Effects
  61
  62 #endif // _FUI_EFFECTS_TYPES_H_
  63