1 #ifndef __DALI_WINDOW_H__
2 #define __DALI_WINDOW_H__
5 * Copyright (c) 2014 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/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-v2.h>
32 typedef Dali::Rect<int> PositionSize;
34 namespace Internal DALI_INTERNAL
42 class DragAndDropDetector;
46 * @brief The window class is used internally for drawing.
48 * It has an orientation
49 * and indicator properties.
51 class DALI_IMPORT_API Window : public BaseHandle
54 typedef SignalV2< void (bool) > IndicatorSignalV2;
61 * @brief Orientation of the window.
63 enum WindowOrientation
67 PORTRAIT_INVERSE = 180,
68 LANDSCAPE_INVERSE = 270
72 * @brief Opacity of the indicator.
74 enum IndicatorBgOpacity
76 OPAQUE = 100, // Fully opaque indicator Bg
77 TRANSLUCENT = 50, // Semi translucent indicator Bg
78 TRANSPARENT = 0 // Fully transparent indicator Bg
82 * @brief Visible mode of the indicator.
84 enum IndicatorVisibleMode
86 INVISIBLE = 0, // hide indicator
87 VISIBLE = 1, // show indicator
88 AUTO = 2 // hide in default, will show when necessary
92 * @brief Style of the indicator.
96 FIXED_COLOR = 0, // fixed color style
97 CHANGEABLE_COLOR // changeable color style
103 * @brief Create 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, std::string name, bool isTransparent = false);
112 * @brief Create an uninitalized handle.
114 * This can be initialized using Dali::Application::GetWindow() or
115 * Dali::Window::New()
122 * This is non-virtual since derived Handle types must not contain data or virtual methods.
127 * @brief This copy constructor is required for (smart) pointer semantics.
129 * @param [in] handle A reference to the copied handle
131 Window(const Window& handle);
134 * @brief This assignment operator is required for (smart) pointer semantics.
136 * @param [in] rhs A reference to the copied handle
137 * @return A reference to this
139 Window& operator=(const Window& rhs);
142 * @brief This sets the style of indicator
143 * @param[in] style style type of the indicator
145 * @note This should be called before ShowIndicator()
147 void SetIndicatorStyle( IndicatorStyle style );
150 * @brief This sets whether the indicator bar should be shown or not.
151 * @param[in] visibleMode visible mode for indicator bar, VISIBLE in default
153 void ShowIndicator( IndicatorVisibleMode visibleMode );
156 * @brief This sets the opacity mode of indicator bar.
157 * @param[in] opacity - The opacity mode
159 void SetIndicatorBgOpacity( IndicatorBgOpacity opacity );
162 * @brief This sets the orientation of indicator bar.
164 * It does not implicitly show the indicator if it is currently
166 * @param[in] orientation The orientation
168 void RotateIndicator(WindowOrientation orientation);
171 * @brief Set the window name and class string.
172 * @param[in] name The name of the window
173 * @param[in] klass The class of the window
175 void SetClass(std::string name, std::string klass);
178 * @brief Raise window to top of window stack.
183 * @brief Lower window to bottom of window stack.
188 * @brief Activate window to top of window stack even it is iconified.
193 * @brief Get the orientation class ( to allow signal connection ).
195 Orientation GetOrientation();
198 * @brief Add an orientation to the list of available orientations.
200 void AddAvailableOrientation( WindowOrientation orientation );
203 * @brief Remove an orientation from the list of available orientations.
205 void RemoveAvailableOrientation( WindowOrientation orientation );
208 * @brief Set the orientations that this window can rotate to.
210 * By default, the window does not change orientation.
211 * @param[in] orientations The list of orientations
213 void SetAvailableOrientations( const std::vector<WindowOrientation>& orientations );
216 * @brief Get the list of orientations this window can rotate to.
217 * @return the list of orientations
219 const std::vector<WindowOrientation>& GetAvailableOrientations();
222 * @brief Set a preferred orientation.
223 * @pre orientation is in the list of available orientations
224 * @param[in] orientation The preferred orientation
226 void SetPreferredOrientation( WindowOrientation orientation );
229 * @brief Get 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 * @return A handle to the DragAndDropDetector.
238 DragAndDropDetector GetDragAndDropDetector() const;
241 * @brief Get the native handle of the window.
242 * @return The native handle of the window or an empty handle.
245 Any GetNativeHandle() const;
249 * The user should connect to this signal to get a timing when indicator was shown / hidden.
251 IndicatorSignalV2& IndicatorVisibilityChangedSignal();
253 public: // Not intended for application developers
255 * @brief This constructor is used by Dali::Application::GetWindow().
256 * @param[in] window A pointer to the window.
258 explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
263 #endif // __DALI_WINDOW_H__