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 Apache License, Version 2.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://www.apache.org/licenses/LICENSE-2.0
  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
  21 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23
  24 namespace Dali
  25 {
  26
  27 class Actor;
  28 class RenderTaskList;
  29
  30 namespace Internal
  31 {
  32 class SystemOverlay;
  33 }
  34
  35 namespace Integration
  36 {
  37
  38 /**
  39  * Use this interface to draw content for system-level indicators, dialogs etc.
  40  * The SystemOverlay is accessible using Dali::Integration::Core::GetSystemOverlay().
  41  */
  42 class DALI_IMPORT_API SystemOverlay
  43 {
  44 public:
  45
  46   /**
  47    * Non-virtual destructor. SystemOverlay is not intended as a base class.
  48    */
  49   ~SystemOverlay();
  50
  51   /**
  52    * Add an Actor to the SystemOverlay.
  53    * @pre The actor handle is not empty.
  54    * @param [in] actor A handle to the actor to add.
  55    * @post The actor will be referenced.
  56    */
  57   void Add( Actor actor );
  58
  59   /**
  60    * Remove an Actor that was added to the SystemOverlay.
  61    * @pre The actor handle is not empty.
  62    * @param [in] actor A handle to the actor to remove.
  63    * @post The actor will be unreferenced.
  64    */
  65   void Remove( Actor actor );
  66
  67   /**
  68    * Retrieve the list of render-tasks for system-level overlays.
  69    * This is a seperate list, processed after the render-tasks provided by Stage::GetRenderTaskList().
  70    * @return The list of overlay render-tasks.
  71    */
  72   RenderTaskList GetOverlayRenderTasks();
  73
  74   /**
  75    * Create the SystemOverlay entrance.
  76    * This is not intended for adaptor implementors; see also Dali::Integration::Core::GetSystemOverlay().
  77    * @param[in] impl The SystemOverlay implementation.
  78    */
  79   SystemOverlay( Internal::SystemOverlay* impl );
  80
  81   /**
  82    * Retreive the internal implementation; this is not intended for adaptor implementors.
  83    * @return The SystemOverlay implementation.
  84    */
  85   Internal::SystemOverlay* GetImpl();
  86
  87 private:
  88
  89   // Undefined copy-constructor.
  90   SystemOverlay( const SystemOverlay& core );
  91
  92   // Undefined assignment operator.
  93   SystemOverlay& operator=( const SystemOverlay& rhs );
  94
  95 private:
  96
  97   Dali::Internal::SystemOverlay* mImpl;
  98 };
  99
 100 } // namespace Integration
 101
 102 } // namespace Dali
 103
 104 #endif // __DALI_INTEGRATION_SYSTEM_OVERLAY_H__