inc/FUiScenesBackwardSceneTransition.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        FUiScenesBackwardSceneTransition.h
  20  * @brief       This is the header file for the %BackwardSceneTransition class.
  21  *
  22  * This header file contains the declarations of the %BackwardSceneTransition class.
  23  */
  24
  25 #ifndef _FUI_SCENES_BACKWARD_SCENE_TRANSITION_H_
  26 #define _FUI_SCENES_BACKWARD_SCENE_TRANSITION_H_
  27
  28 #include <FUiScenesSceneTransition.h>
  29
  30
  31 namespace Tizen { namespace Ui { namespace Scenes
  32 {
  33
  34 /**
  35  * @class       BackwardSceneTransition
  36  * @brief       This class is the %BackwardSceneTransition class of a Tizen native application.
  37  *
  38  * @since       2.0
  39  *
  40  * @final       This class is not intended for extension.
  41  *
  42  * The %BackwardSceneTransition class contains transition information, such as transition direction, transition destination,
  43  * animation type, history option, and destroy option. By default, the transition direction is set as SCENE_TRANSITION_DIRECTION_BACKWARD
  44  * and the history option is set as SCENE_HISTORY_OPTION_NO_HISTORY. @n
  45  *
  46  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/scene_management.htm">Scene Management</a>.
  47  */
  48 class _OSP_EXPORT_ BackwardSceneTransition
  49         : public Tizen::Ui::Scenes::SceneTransition
  50 {
  51 public:
  52         /**
  53          * This is the default constructor for this class.
  54          *
  55          * @since       2.0
  56          *
  57          * @remarks             Use this constructor for adjacent backward transition with default options
  58          *                              (SCENE_TRANSITION_ANIMATION_TYPE_NONE, SCENE_DESTROY_OPTION_DESTROY).
  59          */
  60         BackwardSceneTransition(void);
  61
  62         /**
  63          * Initializes this instance of %BackwardSceneTransition with the specified parameters.
  64          *
  65          * @since       2.0
  66          *
  67          * @param[in]   animationType           The transition animation type
  68          * @param[in]   destroyOption           The destroy option whether to destroy the current scene or not
  69          * @remarks             Use this constructor for adjacent backward transition.
  70          */
  71         BackwardSceneTransition(SceneTransitionAnimationType animationType,
  72                                                         SceneDestroyOption destroyOption = SCENE_DESTROY_OPTION_DESTROY);
  73
  74         /**
  75          * Initializes this instance of %BackwardSceneTransition with the specified parameters.
  76          *
  77          * @since       2.0
  78          *
  79          * @param[in]   destinationSceneId      The scene ID of transition destination
  80          * @param[in]   animationType           The transition animation type
  81          * @param[in]   destroyOption           The destroy option whether to destroy the current scene or not
  82          * @remarks             Use this constructor for non-adjacent backward transition.
  83          */
  84         BackwardSceneTransition(const SceneId& destinationSceneId,
  85                                                         SceneTransitionAnimationType animationType = SCENE_TRANSITION_ANIMATION_TYPE_NONE,
  86                                                         SceneDestroyOption destroyOption = SCENE_DESTROY_OPTION_DESTROY);
  87
  88         /**
  89          * This destructor overrides Tizen::Ui::Scenes::SceneTransition::~SceneTransition().
  90          *
  91          * @since       2.0
  92          */
  93         virtual ~BackwardSceneTransition(void);
  94
  95 protected:
  96         //
  97         // This method is for internal use only. Using this method can cause behavioral,
  98         // security-related, and consistency-related issues in the application.
  99         //
 100         // @since       2.0
 101         //
 102         virtual void BackwardSceneTransition_Reserved1(void) {}
 103
 104         //
 105         // This method is for internal use only. Using this method can cause behavioral,
 106         // security-related, and consistency-related issues in the application.
 107         //
 108         // @since       2.0
 109         //
 110         virtual void BackwardSceneTransition_Reserved2(void) {}
 111
 112         //
 113         // This method is for internal use only. Using this method can cause behavioral,
 114         // security-related, and consistency-related issues in the application.
 115         //
 116         // @since       2.0
 117         //
 118         virtual void BackwardSceneTransition_Reserved3(void) {}
 119
 120 }; // BackwardSceneTransition
 121 } } } // Tizen::Ui::Scenes
 122
 123 #endif // _FUI_SCENES_BACKWARD_SCENE_TRANSITION_H_