pepper-dali/internal/shell-client.h

   1 #ifndef __DALI_PEPPER_SHELL_CLIENT_H__
   2 #define __DALI_PEPPER_SHELL_CLIENT_H__
   3
   4 /*
   5  * Copyright (c) 2016 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 <pepper-dali/public-api/compositor/compositor.h>
  23
  24 // EXTERNAL INCLUDES
  25 #include <dali/public-api/object/base-handle.h>
  26 #include <wayland-server.h>
  27 #include <pepper.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Pepper
  33 {
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 class ShellClient;
  38 }
  39
  40 /**
  41  * @addtogroup dali_pepper_compositor
  42  * @{
  43  */
  44
  45 class ShellClient : public BaseHandle
  46 {
  47 public:
  48
  49   /**
  50    * @brief Create ShellClient.
  51    *
  52    * @since_tizen 3.0
  53    * @return A handle to ShellClient.
  54    */
  55   static ShellClient New( Compositor compositor, struct wl_client* client, uint32_t version, uint32_t id );
  56
  57   /**
  58    * @brief Downcast a handle to ShellClient handle.
  59    *
  60    * If the BaseHandle points is a ShellClient the downcast returns a valid handle.
  61    * If not the returned handle is left empty.
  62    *
  63    * @since_tizen 3.0
  64    * @param[in] handle Handle to an object
  65    * @return handle to a ShellClient or an empty handle
  66    */
  67   static ShellClient DownCast( BaseHandle handle );
  68
  69   /**
  70    * @brief Creates an empty handle.
  71    * @since_tizen 3.0
  72    */
  73   ShellClient();
  74
  75   /**
  76    * @brief Copy constructor.
  77    *
  78    * @since_tizen 3.0
  79    * @param[in] handle The handle to copy from.
  80    */
  81   ShellClient( const ShellClient& handle );
  82
  83   /**
  84    * @brief Assignment operator.
  85    *
  86    * @since_tizen 3.0
  87    * @param[in] handle The handle to copy from.
  88    * @return A reference to this.
  89    */
  90   ShellClient& operator=( const ShellClient& handle );
  91
  92   /**
  93    * @brief Destructor
  94    *
  95    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  96    * @since_tizen 3.0
  97    */
  98   ~ShellClient();
  99
 100 public: // Not intended for application developers
 101
 102   /**
 103    * @brief Creates a handle using the Pepper::Internal implementation.
 104    *
 105    * @since_tizen 3.0
 106    * @param[in] implementation The ShellClient implementation.
 107    */
 108   explicit DALI_INTERNAL ShellClient( Internal::ShellClient* implementation );
 109 };
 110
 111 /**
 112  * @}
 113  */
 114 } // namespace Pepper
 115
 116 } // namespace Dali
 117
 118 #endif // __DALI_PEPPER_SHELL_CLIENT_H__