2 // Open Service Platform
3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
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
9 // http://floralicense.org/license/
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.
19 * @file FUiScenesSceneTransition.h
20 * @brief This is the header file for the %SceneTransition class.
22 * This header file contains the declarations of the %SceneTransition class.
25 #ifndef _FUI_SCENES_SCENE_TRANSITION_H_
26 #define _FUI_SCENES_SCENE_TRANSITION_H_
28 #include <FBaseString.h>
29 #include <FUiScenesTypes.h>
32 namespace Tizen { namespace Ui { namespace Scenes
36 * @class SceneTransition
37 * @brief This class is the %SceneTransition class of a Tizen native application.
41 * The %SceneTransition class contains transition information, such as transition direction, transition destination,
42 * animation type, history option, and destroy option. @n
44 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/scene_management.htm">Scene Management</a>.
46 class _OSP_EXPORT_ SceneTransition
47 : public Tizen::Base::Object
51 * This is the default constructor for this class.
55 SceneTransition(void);
58 * Copying of objects using this copy constructor is allowed.
62 * @param[in] rhs An instance of %SceneTransition
64 SceneTransition(const SceneTransition& rhs);
67 * Initializes this instance of %SceneTransition with the specified parameters.
71 * @param[in] direction The transition direction
72 * @param[in] destinationSceneId The scene ID of transition destination
73 * @param[in] animationType The transition animation type
74 * @param[in] historyOption The history option whether to add the current scene to the history or not
75 * @param[in] destroyOption The destroy option whether to destroy the current scene or not
77 SceneTransition(SceneTransitionDirection direction, const SceneId& destinationSceneId,
78 SceneTransitionAnimationType animationType,
79 SceneHistoryOption historyOption, SceneDestroyOption destroyOption);
82 * Assigns the value of the specified instance to the current instance of %SceneTransition.
86 * @param[in] rhs An instance of %SceneTransition
88 SceneTransition& operator =(const SceneTransition& rhs);
91 * Checks whether the specified instance of %SceneTransition equals the current instance.
95 * @return @c true if the specified instance equals the current instance, @n
97 * @param[in] rhs An instance of %SceneTransition
98 * @remarks This method returns @c false if the specified object is not Scene.
100 virtual bool Equals(const Object& rhs) const;
103 * Gets the hash value of the current instance.
107 * @return The hash value of the current instance
109 virtual int GetHashCode(void) const;
112 * This destructor overrides Tizen::Base::Object::~Object().
116 virtual ~SceneTransition(void);
119 // result SetTransitionId(TransitionId& transitionId);
122 * Sets the scene transition direction.
126 * @return An error code
127 * @param[in] direction The transition direction
128 * @exception E_SUCCESS The method is successful.
129 * @exception E_INVALID_ARG The specified input parameter is invalid.
132 result SetDirection(SceneTransitionDirection direction);
135 * Gets the scene transition direction.
139 * @return The direction of scene transition
142 SceneTransitionDirection GetDirection(void) const;
145 * Sets the scene transition destination scene.
149 * @return An error code
150 * @param[in] sceneId The scene ID of transition destination
151 * @exception E_SUCCESS The method is successful.
152 * @exception E_INVALID_ARG The specified input parameter is invalid.
155 result SetDestinationSceneId(const SceneId& sceneId);
158 * Gets the scene transition destination scene.
162 * @return The scene ID of transition destination
165 SceneId GetDestinationSceneId(void) const;
168 * Sets the scene transition animation type.
172 * @return An error code
173 * @param[in] animationType The transition animation type
174 * @exception E_SUCCESS The method is successful.
175 * @exception E_INVALID_ARG The specified input parameter is invalid.
178 result SetAnimationType(SceneTransitionAnimationType animationType);
181 * Gets the scene transition animation type.
185 * @return The transition animation type
188 SceneTransitionAnimationType GetAnimationType(void) const;
191 * Sets the scene transition history option.
195 * @return An error code
196 * @param[in] historyOption The history option whether to add the current scene to the history or not
197 * @exception E_SUCCESS The method is successful.
198 * @exception E_INVALID_ARG The specified input parameter is invalid.
201 result SetHistoryOption(SceneHistoryOption historyOption);
204 * Gets the scene transition history option.
208 * @return The history option
211 SceneHistoryOption GetHistoryOption(void) const;
214 * Sets the scene transition destroy option.
218 * @return An error code
219 * @param[in] destroyOption The destroy option whether to destroy the current scene or not
220 * @exception E_SUCCESS The method is successful.
221 * @exception E_INVALID_ARG The specified input parameter is invalid.
224 result SetDestroyOption(SceneDestroyOption destroyOption);
227 * Gets the scene transition destroy option.
231 * @return The destroy option
234 SceneDestroyOption GetDestroyOption(void) const;
238 // This method is for internal use only. Using this method can cause behavioral,
239 // security-related, and consistency-related issues in the application.
243 virtual void SceneTransition_Reserved1(void) {}
246 // This method is for internal use only. Using this method can cause behavioral,
247 // security-related, and consistency-related issues in the application.
251 virtual void SceneTransition_Reserved2(void) {}
254 // This method is for internal use only. Using this method can cause behavioral,
255 // security-related, and consistency-related issues in the application.
259 virtual void SceneTransition_Reserved3(void) {}
262 friend class _SceneTransitionImpl;
263 class _SceneTransitionImpl* __pSceneTransitionImpl;
265 }; // SceneTransition
266 } } } // Tizen::Ui::Scenes
268 #endif // _FUI_SCENES_SCENE_TRANSITION_H_