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

   1 #ifndef __DALI_WINDOW_H__
   2 #define __DALI_WINDOW_H__
   3
   4 /*
   5  * Copyright (c) 2018 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/uint-16-pair.h>
  25 #include <dali/public-api/math/vector2.h>
  26 #include <dali/public-api/math/vector4.h>
  27 #include <dali/public-api/object/base-handle.h>
  28 #include <dali/public-api/object/any.h>
  29 #include <dali/public-api/signals/dali-signal.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali/public-api/dali-adaptor-common.h>
  33
  34 namespace Dali
  35 {
  36 /**
  37  * @addtogroup dali_adaptor_framework
  38  * @{
  39  */
  40
  41 typedef Dali::Rect<int> PositionSize;
  42
  43 namespace Internal DALI_INTERNAL
  44 {
  45 namespace Adaptor
  46 {
  47 class Window;
  48 }
  49 }
  50
  51 class DragAndDropDetector;
  52 class Orientation;
  53 class Actor;
  54 class Layer;
  55
  56 /**
  57  * @brief The window class is used internally for drawing.
  58  *
  59  * A Window has an orientation and indicator properties.
  60  * You can get a valid Window handle by calling Dali::Application::GetWindow().
  61  * @SINCE_1_0.0
  62  */
  63 class DALI_ADAPTOR_API Window : public BaseHandle
  64 {
  65 public:
  66
  67   typedef Uint16Pair WindowSize;          ///< Window size type @SINCE_1_2.60
  68   typedef Uint16Pair WindowPosition;      ///< Window position type @SINCE_1_2.60
  69
  70   typedef Signal< void (bool) > IndicatorSignalType;  ///< @DEPRECATED_1_4.9 @brief Indicator state signal type @SINCE_1_0.0
  71   typedef Signal< void (bool) > FocusSignalType;         ///< Window focus signal type @SINCE_1_2.60
  72   typedef Signal< void (WindowSize) > ResizedSignalType; ///< Window resized signal type @SINCE_1_2.60
  73
  74 public:
  75
  76   // Enumerations
  77
  78   /**
  79    * @brief Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
  80    * @SINCE_1_0.0
  81    */
  82   enum WindowOrientation
  83   {
  84     PORTRAIT = 0,  ///< Portrait orientation. The height of the display area is greater than the width. @SINCE_1_0.0
  85     LANDSCAPE = 90,  ///< Landscape orientation. A wide view area is needed. @SINCE_1_0.0
  86     PORTRAIT_INVERSE = 180,  ///< Portrait inverse orientation @SINCE_1_0.0
  87     LANDSCAPE_INVERSE = 270  ///< Landscape inverse orientation @SINCE_1_0.0
  88   };
  89
  90   /**
  91    * @DEPRECATED_1_4.9
  92    * @brief Enumeration for opacity of the indicator.
  93    * @SINCE_1_0.0
  94    */
  95   enum IndicatorBgOpacity
  96   {
  97     OPAQUE = 100, ///< @DEPRECATED_1_4.9 @brief Fully opaque indicator Bg @SINCE_1_0.0
  98     TRANSLUCENT = 50, ///< @DEPRECATED_1_4.9 @brief Semi translucent indicator Bg @SINCE_1_0.0
  99     TRANSPARENT = 0 ///< @DEPRECATED_1_4.9 @brief Fully transparent indicator Bg @SINCE_1_0.0
 100   };
 101
 102   /**
 103    * @DEPRECATED_1_4.9
 104    * @brief Enumeration for visible mode of the indicator.
 105    * @SINCE_1_0.0
 106    */
 107   enum IndicatorVisibleMode
 108   {
 109     INVISIBLE = 0, ///< @DEPRECATED_1_4.9 @brief Hide indicator @SINCE_1_0.0
 110     VISIBLE = 1, ///< @DEPRECATED_1_4.9 @brief Show indicator @SINCE_1_0.0
 111     AUTO = 2 ///< @DEPRECATED_1_4.9 @brief Hide in default, will show when necessary @SINCE_1_0.0
 112   };
 113
 114   /**
 115    * @brief An enum of Window types.
 116    * @SINCE_1_2.60
 117    */
 118   enum Type
 119   {
 120     NORMAL,           ///< A default window type. Indicates a normal, top-level window. Almost every window will be created with this type. @SINCE_1_2.60
 121     NOTIFICATION,     ///< A notification window, like a warning about battery life or a new E-Mail received. @SINCE_1_2.60
 122     UTILITY,          ///< A persistent utility window, like a toolbox or palette. @SINCE_1_2.60
 123     DIALOG            ///< Used for simple dialog windows. @SINCE_1_2.60
 124   };
 125
 126   /**
 127    * @brief An enum of screen mode.
 128    * @SINCE_1_2.60
 129    */
 130   struct NotificationLevel
 131   {
 132     /**
 133      * @brief An enum of screen mode.
 134      * @SINCE_1_2.60
 135      */
 136     enum Type
 137     {
 138       NONE   = -1,    ///< No notification level. Default level. This value makes the notification window place in the layer of the normal window. @SINCE_1_2.60
 139       BASE   = 10,    ///< Base notification level. @SINCE_1_2.60
 140       MEDIUM = 20,    ///< Higher notification level than base. @SINCE_1_2.60
 141       HIGH   = 30,    ///< Higher notification level than medium. @SINCE_1_2.60
 142       TOP    = 40     ///< The highest notification level. @SINCE_1_2.60
 143     };
 144   };
 145
 146   /**
 147    * @brief An enum of screen mode.
 148    * @SINCE_1_2.60
 149    */
 150   struct ScreenOffMode
 151   {
 152     /**
 153      * @brief An enum of screen mode.
 154      * @SINCE_1_2.60
 155      */
 156     enum Type
 157     {
 158       TIMEOUT,              ///< The mode which turns the screen off after a timeout. @SINCE_1_2.60
 159       NEVER,                ///< The mode which keeps the screen turned on. @SINCE_1_2.60
 160     };
 161
 162     static constexpr Type DEFAULT { TIMEOUT }; ///< The default mode. @SINCE_1_2.60
 163   };
 164
 165   // Methods
 166
 167   /**
 168    * @brief Creates an initialized handle to a new Window.
 169    * @SINCE_1_0.0
 170    * @param[in] windowPosition The position and size of the Window
 171    * @param[in] name The Window title
 172    * @param[in] isTransparent Whether Window is transparent
 173    * @return A new window
 174    * @note This creates an extra window in addition to the default main window
 175    */
 176   static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false);
 177
 178   /**
 179    * @brief Creates an initialized handle to a new Window.
 180    * @SINCE_1_0.0
 181    * @param[in] windowPosition The position and size of the Window
 182    * @param[in] name The Window title
 183    * @param[in] className The Window class name
 184    * @param[in] isTransparent Whether Window is transparent
 185    * @note This creates an extra window in addition to the default main window
 186    * @return A new Window
 187    */
 188   static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
 189
 190   /**
 191    * @brief Creates an uninitialized handle.
 192    *
 193    * This can be initialized using Dali::Application::GetWindow() or
 194    * Dali::Window::New().
 195    * @SINCE_1_0.0
 196    */
 197   Window();
 198
 199   /**
 200    * @brief Destructor.
 201    *
 202    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 203    * @SINCE_1_0.0
 204    */
 205   ~Window();
 206
 207   /**
 208    * @brief This copy constructor is required for (smart) pointer semantics.
 209    *
 210    * @SINCE_1_0.0
 211    * @param[in] handle A reference to the copied handle
 212    */
 213   Window(const Window& handle);
 214
 215   /**
 216    * @brief This assignment operator is required for (smart) pointer semantics.
 217    *
 218    * @SINCE_1_0.0
 219    * @param[in] rhs A reference to the copied handle
 220    * @return A reference to this
 221    */
 222   Window& operator=(const Window& rhs);
 223
 224   /**
 225    * @DEPRECATED_1_4.9
 226    * @brief This sets whether the indicator bar should be shown or not.
 227    * @SINCE_1_0.0
 228    * @param[in] visibleMode Visible mode for indicator bar, VISIBLE in default
 229    */
 230   void ShowIndicator( IndicatorVisibleMode visibleMode ) DALI_DEPRECATED_API;
 231
 232   /**
 233    * @DEPRECATED_1_4.9
 234    * @brief This sets the opacity mode of indicator bar.
 235    * @SINCE_1_0.0
 236    * @param[in] opacity The opacity mode
 237    */
 238   void SetIndicatorBgOpacity( IndicatorBgOpacity opacity ) DALI_DEPRECATED_API;
 239
 240   /**
 241    * @DEPRECATED_1_4.9
 242    * @brief This sets the orientation of indicator bar.
 243    *
 244    * It does not implicitly show the indicator if it is currently hidden.
 245    * @SINCE_1_0.0
 246    * @param[in] orientation The orientation
 247    */
 248   void RotateIndicator(WindowOrientation orientation) DALI_DEPRECATED_API;
 249
 250   /**
 251    * @brief Sets the window name and class string.
 252    * @SINCE_1_0.0
 253    * @param[in] name The name of the window
 254    * @param[in] klass The class of the window
 255    */
 256   void SetClass(std::string name, std::string klass);
 257
 258   /**
 259    * @brief Raises window to the top of Window stack.
 260    * @SINCE_1_0.0
 261    */
 262   void Raise();
 263
 264   /**
 265    * @brief Lowers window to the bottom of Window stack.
 266    * @SINCE_1_0.0
 267    */
 268   void Lower();
 269
 270   /**
 271    * @brief Activates window to the top of Window stack even it is iconified.
 272    * @SINCE_1_0.0
 273    */
 274   void Activate();
 275
 276   /**
 277    * @brief Adds an orientation to the list of available orientations.
 278    * @SINCE_1_0.0
 279    * @param[in] orientation The available orientation to add
 280    */
 281   void AddAvailableOrientation( WindowOrientation orientation );
 282
 283   /**
 284    * @brief Removes an orientation from the list of available orientations.
 285    * @SINCE_1_0.0
 286    * @param[in] orientation The available orientation to remove
 287    */
 288   void RemoveAvailableOrientation( WindowOrientation orientation );
 289
 290   /**
 291    * @brief Sets a preferred orientation.
 292    * @SINCE_1_0.0
 293    * @param[in] orientation The preferred orientation
 294    * @pre Orientation is in the list of available orientations.
 295    */
 296   void SetPreferredOrientation( WindowOrientation orientation );
 297
 298   /**
 299    * @brief Gets the preferred orientation.
 300    * @SINCE_1_0.0
 301    * @return The preferred orientation if previously set, or none
 302    */
 303   WindowOrientation GetPreferredOrientation();
 304
 305   /**
 306    * @brief Returns the Drag & drop detector which can be used to receive drag & drop events.
 307    * @note  Not intended for application developers.
 308    * @SINCE_1_0.0
 309    * @return A handle to the DragAndDropDetector
 310    */
 311   DragAndDropDetector GetDragAndDropDetector() const;
 312
 313   /**
 314    * @brief Gets the native handle of the window.
 315    *
 316    * When users call this function, it wraps the actual type used by the underlying window system.
 317    * @SINCE_1_0.0
 318    * @return The native handle of the Window or an empty handle
 319    */
 320   Any GetNativeHandle() const;
 321
 322   /**
 323    * @brief Sets whether window accepts focus or not.
 324    *
 325    * @SINCE_1_2.60
 326    * @param[in] accept If focus is accepted or not. Default is true.
 327    */
 328   void SetAcceptFocus( bool accept );
 329
 330   /**
 331    * @brief Returns whether window accepts focus or not.
 332    *
 333    * @SINCE_1_2.60
 334    * @return True if the window accept focus, false otherwise
 335    */
 336   bool IsFocusAcceptable() const;
 337
 338   /**
 339    * @brief Shows the window if it is hidden.
 340    * @SINCE_1_2.60
 341    */
 342   void Show();
 343
 344   /**
 345    * @brief Hides the window if it is showing.
 346    * @SINCE_1_2.60
 347    */
 348   void Hide();
 349
 350   /**
 351    * @brief Returns whether the window is visible or not.
 352    * @SINCE_1_2.60
 353    * @return True if the window is visible, false otherwise.
 354    */
 355   bool IsVisible() const;
 356
 357   /**
 358    * @brief Gets the count of supported auxiliary hints of the window.
 359    * @SINCE_1_2.60
 360    * @return The number of supported auxiliary hints.
 361    *
 362    * @note The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager.
 363    * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
 364    */
 365   unsigned int GetSupportedAuxiliaryHintCount() const;
 366
 367   /**
 368    * @brief Gets the supported auxiliary hint string of the window.
 369    * @SINCE_1_2.60
 370    * @param[in] index The index of the supported auxiliary hint lists
 371    * @return The auxiliary hint string of the index.
 372    *
 373    * @note The window auxiliary hint is the value which is used to decide which actions should be made available to the user by the window manager.
 374    * If you want to set specific hint to your window, then you should check whether it exists in the supported auxiliary hints.
 375    */
 376   std::string GetSupportedAuxiliaryHint( unsigned int index ) const;
 377
 378   /**
 379    * @brief Creates an auxiliary hint of the window.
 380    * @SINCE_1_2.60
 381    * @param[in] hint The auxiliary hint string.
 382    * @param[in] value The value string.
 383    * @return The ID of created auxiliary hint, or @c 0 on failure.
 384    */
 385   unsigned int AddAuxiliaryHint( const std::string& hint, const std::string& value );
 386
 387   /**
 388    * @brief Removes an auxiliary hint of the window.
 389    * @SINCE_1_2.60
 390    * @param[in] id The ID of the auxiliary hint.
 391    * @return True if no error occurred, false otherwise.
 392    */
 393   bool RemoveAuxiliaryHint( unsigned int id );
 394
 395   /**
 396    * @brief Changes a value of the auxiliary hint.
 397    * @SINCE_1_2.60
 398    * @param[in] id The auxiliary hint ID.
 399    * @param[in] value The value string to be set.
 400    * @return True if no error occurred, false otherwise.
 401    */
 402   bool SetAuxiliaryHintValue( unsigned int id, const std::string& value );
 403
 404   /**
 405    * @brief Gets a value of the auxiliary hint.
 406    * @SINCE_1_2.60
 407    * @param[in] id The auxiliary hint ID.
 408    * @return The string value of the auxiliary hint ID, or an empty string if none exists.
 409    */
 410   std::string GetAuxiliaryHintValue( unsigned int id ) const;
 411
 412   /**
 413    * @brief Gets a ID of the auxiliary hint string.
 414    * @SINCE_1_2.60
 415    * @param[in] hint The auxiliary hint string.
 416    * @return The ID of the auxiliary hint string, or @c 0 if none exists.
 417    */
 418   unsigned int GetAuxiliaryHintId( const std::string& hint ) const;
 419
 420   /**
 421    * @brief Sets a region to accept input events.
 422    * @SINCE_1_2.60
 423    * @param[in] inputRegion The region to accept input events.
 424    */
 425   void SetInputRegion( const Rect< int >& inputRegion );
 426
 427   /**
 428    * @brief Sets a window type.
 429    * @SINCE_1_2.60
 430    * @param[in] type The window type.
 431    * @remarks The default window type is NORMAL.
 432    */
 433   void SetType( Type type );
 434
 435   /**
 436    * @brief Gets a window type.
 437    * @SINCE_1_2.60
 438    * @return A window type.
 439    */
 440   Type GetType() const;
 441
 442   /**
 443    * @brief Sets a priority level for the specified notification window.
 444    * @SINCE_1_2.60
 445    * @param[in] level The notification window level.
 446    * @return True if no error occurred, false otherwise.
 447    * @PRIVLEVEL_PUBLIC
 448    * @PRIVILEGE_WINDOW_PRIORITY
 449    * @remarks This can be used for a notification type window only. The default level is NotificationLevel::NONE.
 450    */
 451   bool SetNotificationLevel( NotificationLevel::Type level );
 452
 453   /**
 454    * @brief Gets a priority level for the specified notification window.
 455    * @SINCE_1_2.60
 456    * @return The notification window level.
 457    * @remarks This can be used for a notification type window only.
 458    */
 459   NotificationLevel::Type GetNotificationLevel() const;
 460
 461   /**
 462    * @brief Sets a transparent window's visual state to opaque.
 463    * @details If a visual state of a transparent window is opaque,
 464    * then the window manager could handle it as an opaque window when calculating visibility.
 465    * @SINCE_1_2.60
 466    * @param[in] opaque Whether the window's visual state is opaque.
 467    * @remarks This will have no effect on an opaque window.
 468    * It doesn't change transparent window to opaque window but lets the window manager know the visual state of the window.
 469    */
 470   void SetOpaqueState( bool opaque );
 471
 472   /**
 473    * @brief Returns whether a transparent window's visual state is opaque or not.
 474    * @SINCE_1_2.60
 475    * @return True if the window's visual state is opaque, false otherwise.
 476    * @remarks The return value has no meaning on an opaque window.
 477    */
 478   bool IsOpaqueState() const;
 479
 480   /**
 481    * @brief Sets a window's screen off mode.
 482    * @details This API is useful when the application needs to keep the display turned on.
 483    * If the application sets the screen mode to #::Dali::Window::ScreenOffMode::NEVER to its window and the window is shown,
 484    * the window manager requests the display system to keep the display on as long as the window is shown.
 485    * If the window is no longer shown, then the window manager requests the display system to go back to normal operation.
 486    * @SINCE_1_2.60
 487    * @param[in] screenOffMode The screen mode.
 488    * @return True if no error occurred, false otherwise.
 489    * @PRIVLEVEL_PUBLIC
 490    * @PRIVILEGE_DISPLAY
 491    */
 492   bool SetScreenOffMode(ScreenOffMode::Type screenOffMode);
 493
 494   /**
 495    * @brief Gets a screen off mode of the window.
 496    * @SINCE_1_2.60
 497    * @return The screen off mode.
 498    */
 499   ScreenOffMode::Type GetScreenOffMode() const;
 500
 501   /**
 502    * @brief Sets preferred brightness of the window.
 503    * @details This API is useful when the application needs to change the brightness of the screen when it is appeared on the screen.
 504    * If the brightness has been set and the window is shown, the window manager requests the display system to change the brightness to the provided value.
 505    * If the window is no longer shown, then the window manager requests the display system to go back to default brightness.
 506    * A value less than 0 results in default brightness and a value greater than 100 results in maximum brightness.
 507    * @SINCE_1_2.60
 508    * @param[in] brightness The preferred brightness (0 to 100).
 509    * @return True if no error occurred, false otherwise.
 510    * @PRIVLEVEL_PUBLIC
 511    * @PRIVILEGE_DISPLAY
 512    */
 513   bool SetBrightness( int brightness );
 514
 515   /**
 516    * @brief Gets preferred brightness of the window.
 517    * @SINCE_1_2.60
 518    * @return The preferred brightness.
 519    */
 520   int GetBrightness() const;
 521
 522   /**
 523    * @brief Sets a size of the window.
 524    *
 525    * @SINCE_1_2.60
 526    * @param[in] size The new window size
 527    */
 528   void SetSize( WindowSize size );
 529
 530   /**
 531    * @brief Gets a size of the window.
 532    *
 533    * @SINCE_1_2.60
 534    * @return The size of the window
 535    */
 536   WindowSize GetSize() const;
 537
 538   /**
 539    * @brief Sets a position of the window.
 540    *
 541    * @SINCE_1_2.60
 542    * @param[in] position The new window position
 543    */
 544   void SetPosition( WindowPosition position );
 545
 546   /**
 547    * @brief Gets a position of the window.
 548    *
 549    * @SINCE_1_2.60
 550    * @return The position of the window
 551    */
 552   WindowPosition GetPosition() const;
 553
 554   /**
 555    * @brief Sets whether the window is transparent or not.
 556    *
 557    * @SINCE_1_2.60
 558    * @param[in] transparent Whether the window is transparent
 559    */
 560   void SetTransparency( bool transparent );
 561
 562 public: // Signals
 563   /**
 564    * @DEPRECATED_1_4.9
 565    * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
 566    * @SINCE_1_0.0
 567    * @return The signal to connect to
 568    */
 569   IndicatorSignalType& IndicatorVisibilityChangedSignal() DALI_DEPRECATED_API;
 570
 571   /**
 572    * @brief The user should connect to this signal to get a timing when window gains focus or loses focus.
 573    *
 574    * A callback of the following type may be connected:
 575    * @code
 576    *   void YourCallbackName( bool focusIn );
 577    * @endcode
 578    * The parameter is true if window gains focus, otherwise false.
 579    *
 580    * @SINCE_1_2.60
 581    * @return The signal to connect to
 582    */
 583   FocusSignalType& FocusChangedSignal();
 584
 585   /**
 586    * @brief This signal is emitted when the window is resized.
 587    *
 588    * A callback of the following type may be connected:
 589    * @code
 590    *   void YourCallbackName( int width, int height );
 591    * @endcode
 592    * The parameters are the resized width and height.
 593    *
 594    * @SINCE_1_2.60
 595    * @return The signal to connect to
 596    */
 597   ResizedSignalType& ResizedSignal();
 598
 599 public: // Not intended for application developers
 600   /// @cond internal
 601   /**
 602    * @brief This constructor is used by Dali::Application::GetWindow().
 603    * @SINCE_1_0.0
 604    * @param[in] window A pointer to the Window
 605    */
 606   explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
 607   /// @endcond
 608 };
 609
 610 /**
 611  * @}
 612  */
 613 } // namespace Dali
 614
 615 #endif // __DALI_WINDOW_H__