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

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