dali/integration-api/system-overlay.h

   1 #ifndef __DALI_INTEGRATION_SYSTEM_OVERLAY_H__
   2 #define __DALI_INTEGRATION_SYSTEM_OVERLAY_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.0 (the License);
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //     http://floralicense.org/license/
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an AS IS BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19
  20 // INTERNAL INCLUDES
  21 #include <dali/public-api/common/dali-common.h>
  22
  23 namespace Dali
  24 {
  25
  26 class Actor;
  27 class RenderTaskList;
  28
  29 namespace Internal
  30 {
  31 class SystemOverlay;
  32 }
  33
  34 namespace Integration
  35 {
  36
  37 /**
  38  * Use this interface to draw content for system-level indicators, dialogs etc.
  39  * The SystemOverlay is accessible using Dali::Integration::Core::GetSystemOverlay().
  40  */
  41 class DALI_IMPORT_API SystemOverlay
  42 {
  43 public:
  44
  45   /**
  46    * Non-virtual destructor. SystemOverlay is not intended as a base class.
  47    */
  48   ~SystemOverlay();
  49
  50   /**
  51    * Add an Actor to the SystemOverlay.
  52    * @pre The actor handle is not empty.
  53    * @param [in] actor A handle to the actor to add.
  54    * @post The actor will be referenced.
  55    */
  56   void Add( Actor actor );
  57
  58   /**
  59    * Remove an Actor that was added to the SystemOverlay.
  60    * @pre The actor handle is not empty.
  61    * @param [in] actor A handle to the actor to remove.
  62    * @post The actor will be unreferenced.
  63    */
  64   void Remove( Actor actor );
  65
  66   /**
  67    * Retrieve the list of render-tasks for system-level overlays.
  68    * This is a seperate list, processed after the render-tasks provided by Stage::GetRenderTaskList().
  69    * @return The list of overlay render-tasks.
  70    */
  71   RenderTaskList GetOverlayRenderTasks();
  72
  73   /**
  74    * Create the SystemOverlay entrance.
  75    * This is not intended for adaptor implementors; see also Dali::Integration::Core::GetSystemOverlay().
  76    * @param[in] impl The SystemOverlay implementation.
  77    */
  78   SystemOverlay( Internal::SystemOverlay* impl );
  79
  80   /**
  81    * Retreive the internal implementation; this is not intended for adaptor implementors.
  82    * @return The SystemOverlay implementation.
  83    */
  84   Internal::SystemOverlay* GetImpl();
  85
  86 private:
  87
  88   // Undefined copy-constructor.
  89   SystemOverlay( const SystemOverlay& core );
  90
  91   // Undefined assignment operator.
  92   SystemOverlay& operator=( const SystemOverlay& rhs );
  93
  94 private:
  95
  96   Dali::Internal::SystemOverlay* mImpl;
  97 };
  98
  99 } // namespace Integration
 100
 101 } // namespace Dali
 102
 103 #endif // __DALI_INTEGRATION_SYSTEM_OVERLAY_H__