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