adaptors/public-api/adaptor-framework/window.h

   1 #ifndef __DALI_WINDOW_H__
   2 #define __DALI_WINDOW_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // EXTERNAL INCLUDES
  22 #include <string>
  23 #include <dali/public-api/math/rect.h>
  24 #include <dali/public-api/math/vector2.h>
  25 #include <dali/public-api/object/base-handle.h>
  26 #include <dali/public-api/object/any.h>
  27 #include <dali/public-api/signals/dali-signal.h>
  28
  29 namespace Dali
  30 {
  31 typedef Dali::Rect<int> PositionSize;
  32
  33 namespace Internal DALI_INTERNAL
  34 {
  35 namespace Adaptor
  36 {
  37 class Window;
  38 }
  39 }
  40
  41 class DragAndDropDetector;
  42 class Orientation;
  43
  44 /**
  45  * @brief The window class is used internally for drawing.
  46  *
  47  * It has an orientation
  48  * and indicator properties.
  49  */
  50 class DALI_IMPORT_API Window : public BaseHandle
  51 {
  52 public:
  53   typedef Signal< void (bool) > IndicatorSignalType;
  54
  55 public:
  56
  57   // Enumerations
  58
  59   /**
  60    * @brief Orientation of the window.
  61    */
  62   enum WindowOrientation
  63   {
  64     PORTRAIT = 0,
  65     LANDSCAPE = 90,
  66     PORTRAIT_INVERSE = 180,
  67     LANDSCAPE_INVERSE = 270
  68   };
  69
  70   /**
  71    * @brief Opacity of the indicator.
  72    */
  73   enum IndicatorBgOpacity
  74   {
  75     OPAQUE = 100, // Fully opaque indicator Bg
  76     TRANSLUCENT = 50, // Semi translucent indicator Bg
  77     TRANSPARENT = 0 // Fully transparent indicator Bg
  78   };
  79
  80   /**
  81    * @brief Visible mode of the indicator.
  82    */
  83   enum IndicatorVisibleMode
  84   {
  85     INVISIBLE = 0, // hide indicator
  86     VISIBLE = 1, // show indicator
  87     AUTO = 2 // hide in default, will show when necessary
  88   };
  89
  90   // Methods
  91
  92   /**
  93    * @brief Create an initialized handle to a new Window.
  94    * @param[in] windowPosition The position and size of the window
  95    * @param[in] name The window title
  96    * @param[in] isTransparent Whether window is transparent
  97    * @return a new window
  98    */
  99   static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false);
 100
 101   /**
 102    * @brief Create an initialized handle to a new Window.
 103    * @param[in] windowPosition The position and size of the window
 104    * @param[in] name The window title
 105    * @param[in] className The window class name
 106    * @param[in] isTransparent Whether window is transparent
 107    * @return a new window
 108    */
 109   static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
 110
 111   /**
 112    * @brief Create an uninitalized handle.
 113    *
 114    * This can be initialized using Dali::Application::GetWindow() or
 115    * Dali::Window::New()
 116    */
 117   Window();
 118
 119   /**
 120    * @brief Destructor
 121    *
 122    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 123    */
 124   ~Window();
 125
 126   /**
 127    * @brief This copy constructor is required for (smart) pointer semantics.
 128    *
 129    * @param [in] handle A reference to the copied handle
 130    */
 131   Window(const Window& handle);
 132
 133   /**
 134    * @brief This assignment operator is required for (smart) pointer semantics.
 135    *
 136    * @param [in] rhs  A reference to the copied handle
 137    * @return A reference to this
 138    */
 139   Window& operator=(const Window& rhs);
 140
 141   /**
 142    * @brief This sets whether the indicator bar should be shown or not.
 143    * @param[in] visibleMode visible mode for indicator bar, VISIBLE in default
 144    */
 145   void ShowIndicator( IndicatorVisibleMode visibleMode );
 146
 147   /**
 148    * @brief This sets the opacity mode of indicator bar.
 149    * @param[in] opacity - The opacity mode
 150    */
 151   void SetIndicatorBgOpacity( IndicatorBgOpacity opacity );
 152
 153   /**
 154    * @brief This sets the orientation of indicator bar.
 155    *
 156    * It does not implicitly show the indicator if it is currently
 157    * hidden.
 158    * @param[in] orientation The orientation
 159    */
 160   void RotateIndicator(WindowOrientation orientation);
 161
 162   /**
 163    * @brief Set the window name and class string.
 164    * @param[in] name The name of the window
 165    * @param[in] klass The class of the window
 166    */
 167   void SetClass(std::string name, std::string klass);
 168
 169   /**
 170    * @brief Raise window to top of window stack.
 171    */
 172   void Raise();
 173
 174   /**
 175    * @brief Lower window to bottom of window stack.
 176    */
 177   void Lower();
 178
 179   /**
 180    * @brief Activate window to top of window stack even it is iconified.
 181    */
 182   void Activate();
 183
 184   /**
 185    * @brief Add an orientation to the list of available orientations.
 186    */
 187   void AddAvailableOrientation( WindowOrientation orientation );
 188
 189   /**
 190    * @brief Remove an orientation from the list of available orientations.
 191    */
 192   void RemoveAvailableOrientation( WindowOrientation orientation );
 193
 194   /**
 195    * @brief Set a preferred orientation.
 196    * @pre orientation is in the list of available orientations
 197    * @param[in] orientation The preferred orientation
 198    */
 199   void SetPreferredOrientation( WindowOrientation orientation );
 200
 201   /**
 202    * @brief Get the preferred orientation.
 203    * @return The preferred orientation if previously set, or none.
 204    */
 205   WindowOrientation GetPreferredOrientation();
 206
 207   /**
 208    * @brief Returns the Drag & drop detector which can be used to receive drag & drop events.
 209    * @return A handle to the DragAndDropDetector.
 210    */
 211   DragAndDropDetector GetDragAndDropDetector() const;
 212
 213   /**
 214    * @brief Get the native handle of the window.
 215    * @return The native handle of the window or an empty handle.
 216    */
 217   Any GetNativeHandle() const;
 218
 219 public: // Signals
 220   /**
 221    * The user should connect to this signal to get a timing when indicator was shown / hidden.
 222    */
 223   IndicatorSignalType& IndicatorVisibilityChangedSignal();
 224
 225 public: // Not intended for application developers
 226   /**
 227    * @brief This constructor is used by Dali::Application::GetWindow().
 228    * @param[in] window A pointer to the window.
 229    */
 230   explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
 231 };
 232
 233 } // namespace Dali
 234
 235 #endif // __DALI_WINDOW_H__