1 #ifndef __DALI_WINDOW_H__
2 #define __DALI_WINDOW_H__
5 * Copyright (c) 2017 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
32 * @addtogroup dali_adaptor_framework
36 typedef Dali::Rect<int> PositionSize;
38 namespace Internal DALI_INTERNAL
46 class DragAndDropDetector;
50 * @brief The window class is used internally for drawing.
52 * A Window has an orientation and indicator properties.
53 * You can get a valid Window handle by calling Dali::Application::GetWindow().
56 class DALI_IMPORT_API Window : public BaseHandle
59 typedef Signal< void (bool) > IndicatorSignalType; ///< Indicator state signal type @SINCE_1_0.0
66 * @brief Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
69 enum WindowOrientation
71 PORTRAIT = 0, ///< Portrait orientation. The height of the display area is greater than the width. @SINCE_1_0.0
72 LANDSCAPE = 90, ///< Landscape orientation. A wide view area is needed. @SINCE_1_0.0
73 PORTRAIT_INVERSE = 180, ///< Portrait inverse orientation @SINCE_1_0.0
74 LANDSCAPE_INVERSE = 270 ///< Landscape inverse orientation @SINCE_1_0.0
78 * @brief Enumeration for opacity of the indicator.
81 enum IndicatorBgOpacity
83 OPAQUE = 100, ///< Fully opaque indicator Bg @SINCE_1_0.0
84 TRANSLUCENT = 50, ///< Semi translucent indicator Bg @SINCE_1_0.0
85 TRANSPARENT = 0 ///< Fully transparent indicator Bg @SINCE_1_0.0
89 * @brief Enumeration for visible mode of the indicator.
92 enum IndicatorVisibleMode
94 INVISIBLE = 0, ///< Hide indicator @SINCE_1_0.0
95 VISIBLE = 1, ///< Show indicator @SINCE_1_0.0
96 AUTO = 2 ///< Hide in default, will show when necessary @SINCE_1_0.0
102 * @brief Creates an initialized handle to a new Window.
104 * @param[in] windowPosition The position and size of the Window
105 * @param[in] name The Window title
106 * @param[in] isTransparent Whether Window is transparent
107 * @return A new window
109 static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false);
112 * @brief Creates an initialized handle to a new Window.
114 * @param[in] windowPosition The position and size of the Window
115 * @param[in] name The Window title
116 * @param[in] className The Window class name
117 * @param[in] isTransparent Whether Window is transparent
118 * @return A new Window
120 static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
123 * @brief Creates an uninitialized handle.
125 * This can be initialized using Dali::Application::GetWindow() or
126 * Dali::Window::New().
134 * This is non-virtual since derived Handle types must not contain data or virtual methods.
140 * @brief This copy constructor is required for (smart) pointer semantics.
143 * @param[in] handle A reference to the copied handle
145 Window(const Window& handle);
148 * @brief This assignment operator is required for (smart) pointer semantics.
151 * @param[in] rhs A reference to the copied handle
152 * @return A reference to this
154 Window& operator=(const Window& rhs);
157 * @brief This sets whether the indicator bar should be shown or not.
159 * @param[in] visibleMode Visible mode for indicator bar, VISIBLE in default
161 void ShowIndicator( IndicatorVisibleMode visibleMode );
164 * @brief This sets the opacity mode of indicator bar.
166 * @param[in] opacity The opacity mode
168 void SetIndicatorBgOpacity( IndicatorBgOpacity opacity );
171 * @brief This sets the orientation of indicator bar.
173 * It does not implicitly show the indicator if it is currently hidden.
175 * @param[in] orientation The orientation
177 void RotateIndicator(WindowOrientation orientation);
180 * @brief Sets the window name and class string.
182 * @param[in] name The name of the window
183 * @param[in] klass The class of the window
185 void SetClass(std::string name, std::string klass);
188 * @brief Raises window to the top of Window stack.
194 * @brief Lowers window to the bottom of Window stack.
200 * @brief Activates window to the top of Window stack even it is iconified.
206 * @brief Adds an orientation to the list of available orientations.
208 * @param[in] orientation The available orientation to add
210 void AddAvailableOrientation( WindowOrientation orientation );
213 * @brief Removes an orientation from the list of available orientations.
215 * @param[in] orientation The available orientation to remove
217 void RemoveAvailableOrientation( WindowOrientation orientation );
220 * @brief Sets a preferred orientation.
222 * @param[in] orientation The preferred orientation
223 * @pre Orientation is in the list of available orientations.
225 void SetPreferredOrientation( WindowOrientation orientation );
228 * @brief Gets the preferred orientation.
230 * @return The preferred orientation if previously set, or none
232 WindowOrientation GetPreferredOrientation();
235 * @brief Returns the Drag & drop detector which can be used to receive drag & drop events.
236 * @note Not intended for application developers.
238 * @return A handle to the DragAndDropDetector
240 DragAndDropDetector GetDragAndDropDetector() const;
243 * @brief Gets the native handle of the window.
245 * When users call this function, it wraps the actual type used by the underlying window system.
247 * @return The native handle of the Window or an empty handle
249 Any GetNativeHandle() const;
253 * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
255 * @return The signal to connect to
257 IndicatorSignalType& IndicatorVisibilityChangedSignal();
259 public: // Not intended for application developers
262 * @brief This constructor is used by Dali::Application::GetWindow().
264 * @param[in] window A pointer to the Window
266 explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
275 #endif // __DALI_WINDOW_H__