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

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