inc/FUiScenesISceneManagerEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0/
  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        FUiScenesISceneManagerEventListener.h
  20  * @brief       This is the header file for the %ISceneManagerEventListener interface.
  21  *
  22  * This header file contains the declarations of the %ISceneManagerEventListener interface.
  23  */
  24
  25 #ifndef _FUI_SCENES_ISCENE_MANAGER_EVENT_LISTENER_H_
  26 #define _FUI_SCENES_ISCENE_MANAGER_EVENT_LISTENER_H_
  27
  28 #include <FBaseRtIEventListener.h>
  29 #include <FUiScenesTypes.h>
  30
  31
  32 namespace Tizen { namespace Ui { namespace Scenes
  33 {
  34
  35 /**
  36  * @interface   ISceneManagerEventListener
  37  * @brief               This interface provides listeners for managing scenes and scene states.
  38  *
  39  * @since       2.0
  40  *
  41  * The %ISceneManagerEventListener interface provides listeners for managing scenes and scene states.
  42  *
  43  * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/ui/scene_management.htm">Scene Management</a>.
  44  */
  45 class _OSP_EXPORT_ ISceneManagerEventListener
  46         : virtual public Tizen::Base::Runtime::IEventListener
  47 {
  48 public:
  49         /**
  50          * This polymorphic destructor should be overridden if required. This way,
  51          * the destructors of the derived classes are called when the destructor of this interface is called.
  52          *
  53          * @since       2.0
  54          */
  55         virtual ~ISceneManagerEventListener(void) {}
  56
  57         /**
  58          * Called when the scene transition is started.
  59          *
  60          * @since       2.0
  61          *
  62          * @param[in]   currentSceneId          The scene ID of the scene being deactivated
  63          * @param[in]   nextSceneId                     The scene ID of the next active scene
  64          *
  65          */
  66         virtual void OnSceneTransitionStarted(const Tizen::Ui::Scenes::SceneId& currentSceneId,
  67                                                                                   const Tizen::Ui::Scenes::SceneId& nextSceneId) = 0;
  68
  69         /**
  70          * Called after the scene transition is completed.
  71          *
  72          * @since       2.0
  73          *
  74          * @param[in]   previousSceneId         The scene ID of the deactivated scene
  75          * @param[in]   currentSceneId          The scene ID of the newly activated scene
  76          * @remarks             This method is called after the scene is activated using the ISceneEventListener::OnSceneActivatedN() callback method.
  77          */
  78         virtual void OnSceneTransitionCompleted(const Tizen::Ui::Scenes::SceneId& previousSceneId,
  79                                                                                         const Tizen::Ui::Scenes::SceneId& currentSceneId) = 0;
  80
  81 protected:
  82         //
  83         // This method is for internal use only. Using this method can cause behavioral,
  84         // security-related, and consistency-related issues in the application.
  85         //
  86         // @since       2.0
  87         //
  88         virtual void ISceneManagerEventListener_Reserved1(void) {}
  89
  90         //
  91         // This method is for internal use only. Using this method can cause behavioral,
  92         // security-related, and consistency-related issues in the application.
  93         //
  94         // @since       2.0
  95         //
  96         virtual void ISceneManagerEventListener_Reserved2(void) {}
  97
  98         //
  99         // This method is for internal use only. Using this method can cause behavioral,
 100         // security-related, and consistency-related issues in the application.
 101         //
 102         // @since       2.0
 103         //
 104         virtual void ISceneManagerEventListener_Reserved3(void) {}
 105
 106 }; // ISceneManagerEventListener
 107 } } } // Tizen::Ui::Scenes
 108
 109 #endif  //_FUI_SCENES_ISCENE_MANAGER_EVENT_LISTENER_H_