inc/FUiScenesTypes.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 /**
  19  * @file        FUiScenesTypes.h
  20  * @brief       This is the header file for the common data types used by the scene management.
  21  *
  22  * This header file contains the declarations of the common data types and constants used by the scene management.
  23  */
  24
  25 #ifndef _FUI_SCENES_TYPES_H_
  26 #define _FUI_SCENES_TYPES_H_
  27
  28
  29 #include <FBaseString.h>
  30
  31
  32 namespace Tizen { namespace Ui { namespace Scenes
  33 {
  34
  35 /**
  36  * The scene ID.
  37  *
  38  * @since       2.0
  39  */
  40 typedef Tizen::Base::String     SceneId;
  41
  42 /**
  43  * The transition ID.
  44  *
  45  * @since       2.0
  46  */
  47 typedef Tizen::Base::String     SceneTransitionId;
  48
  49 /**
  50  * @enum        SceneTransitionDirection
  51  *
  52  * Defines the scene transition directions whether forward or backward.
  53  *
  54  * @since       2.0
  55  */
  56 enum SceneTransitionDirection
  57 {
  58         SCENE_TRANSITION_DIRECTION_FORWARD,                             /**< The transition is forward */
  59         SCENE_TRANSITION_DIRECTION_BACKWARD,                    /**< The transition is backward */
  60 };
  61
  62 /**
  63  * @enum        SceneHistoryOption
  64  *
  65  * Defines the scene history operation options whether to add to history or not.
  66  *
  67  * @since       2.0
  68  */
  69 enum SceneHistoryOption
  70 {
  71         SCENE_HISTORY_OPTION_ADD_HISTORY,                               /**< The current scene would be added to history */
  72         SCENE_HISTORY_OPTION_NO_HISTORY,                                /**< The current scene would not be added to history */
  73 };
  74
  75 /**
  76  * @enum        SceneDestroyOption
  77  *
  78  * Defines the scene destroy options.
  79  *
  80  * @since       2.0
  81  */
  82 enum SceneDestroyOption
  83 {
  84         SCENE_DESTROY_OPTION_KEEP,                                              /**< The current scene will not be destroyed */
  85         SCENE_DESTROY_OPTION_DESTROY,                                   /**< The current scene will be destroyed after the transition is completed */
  86 };
  87
  88 /**
  89  * @enum        SceneTransitionAnimationType
  90  *
  91  * Defines the scene transition animation types.
  92  *
  93  * @since       2.0
  94  *
  95  * @see         Tizen::Ui::Animations::FrameAnimatorFormTransitionAnimation
  96  */
  97 enum SceneTransitionAnimationType
  98 {
  99         SCENE_TRANSITION_ANIMATION_TYPE_NONE,          /**< No transition animation */
 100         SCENE_TRANSITION_ANIMATION_TYPE_CUSTOM,        /**< The custom transition animation with ISceneAnimationProvider */
 101         SCENE_TRANSITION_ANIMATION_TYPE_LEFT,          /**< The transition animation using translate left animation */
 102         SCENE_TRANSITION_ANIMATION_TYPE_RIGHT,         /**< The transition animation using translate right animation */
 103         SCENE_TRANSITION_ANIMATION_TYPE_FADE_IN_OUT,   /**< The transition animation using alpha animation */
 104         SCENE_TRANSITION_ANIMATION_TYPE_ZOOM_IN,       /**< The transition animation using scale animation */
 105         SCENE_TRANSITION_ANIMATION_TYPE_ZOOM_OUT,      /**< The transition animation using scale animation */
 106         SCENE_TRANSITION_ANIMATION_TYPE_DEPTH_IN,      /**< The transition animation using scale and alpha animation */
 107         SCENE_TRANSITION_ANIMATION_TYPE_DEPTH_OUT,     /**< The transition animation using scale and alpha animation */
 108 };
 109 } } } // Tizen::Ui::Scenes
 110
 111 #endif  //_FUI_SCENES_TYPES_H_