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