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 FUiScenesISceneEventListener.h
20 * @brief This is the header file for the %ISceneEventListener interface.
22 * This header file contains the declarations of the %ISceneEventListener interface.
25 #ifndef _FUI_SCENES_ISCENE_EVENT_LISTENER_H_
26 #define _FUI_SCENES_ISCENE_EVENT_LISTENER_H_
28 #include <FBaseTypes.h>
29 #include <FBaseString.h>
30 #include <FBaseRtIEventListener.h>
31 #include <FUiScenesTypes.h>
34 namespace Tizen { namespace Base { namespace Collection
40 namespace Tizen { namespace Ui { namespace Scenes
44 * @interface ISceneEventListener
45 * @brief This interface is the listener interface for receiving the scene transition events.
49 * The %ISceneEventListener interface is the listener interface for receiving the scene transition events.
50 * The class that processes a scene transition event implements this interface and registers using
51 * the SceneManager::AddSceneEventListener() method.
53 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/scene_management.htm">Scene Management</a>.
55 class _OSP_EXPORT_ ISceneEventListener
56 : virtual public Tizen::Base::Runtime::IEventListener
60 * This polymorphic destructor should be overridden if required. This way,
61 * the destructors of the derived classes are called when the destructor of this interface is called.
65 virtual ~ISceneEventListener(void) {}
68 * Called after setting as current scene. @n
69 * The UI element (Tizen::Ui::Controls::Form or Tizen::Ui::Controls::Panel)
70 * has been added to a container (Frame or Form) and is ready to update.
74 * @param[in] previousSceneId The scene ID of the deactivated scene
75 * @param[in] currentSceneId The scene ID of the newly activated scene
76 * @param[in] pArgs A pointer to an argument list that is user-specified
77 * @remarks The argument list must be cleaned up to free memory.
79 virtual void OnSceneActivatedN(const Tizen::Ui::Scenes::SceneId& previousSceneId,
80 const Tizen::Ui::Scenes::SceneId& currentSceneId, Tizen::Base::Collection::IList* pArgs) = 0;
83 * Called when the current scene is deactivated.
87 * @param[in] currentSceneId The scene ID of the scene being deactivated
88 * @param[in] nextSceneId The scene ID of the next active scene
91 virtual void OnSceneDeactivated(const Tizen::Ui::Scenes::SceneId& currentSceneId,
92 const Tizen::Ui::Scenes::SceneId& nextSceneId) = 0;
97 // This method is for internal use only. Using this method can cause behavioral,
98 // security-related, and consistency-related issues in the application.
102 virtual void ISceneEventListener_Reserved1(void) {}
105 // This method is for internal use only. Using this method can cause behavioral,
106 // security-related, and consistency-related issues in the application.
110 virtual void ISceneEventListener_Reserved2(void) {}
113 // This method is for internal use only. Using this method can cause behavioral,
114 // security-related, and consistency-related issues in the application.
118 virtual void ISceneEventListener_Reserved3(void) {}
120 }; // ISceneEventListener
121 } } } // Tizen::Ui::Scenes
123 #endif //_FUI_SCENES_ISCENE_EVENT_LISTENER_H_