/**
* @brief Create a new Window. This should only be called once by the Application class
+ *
* @param[in] name The window title
* @param[in] className The window class name
* @param[in] windowData The window data
/**
* @brief Create a new Window. This should only be called once by the Application class
+ *
* @param[in] surface The surface used to render on.
* @param[in] name The window title
* @param[in] className The window class name
/**
* @brief Gets the window class name.
+ *
* @return The class of the window
*/
std::string GetClassName() const;
/**
* @brief Get window resource ID assigned by window manager
+ *
* @return The resource ID of the window
*/
std::string GetNativeResourceId() const;
/**
* @brief Emit the accessibility highlight signal.
+ *
* The highlight indicates that it is an object to interact with the user regardless of focus.
* After setting the highlight on the object, you can do things that the object can do, such as
* giving or losing focus.
private:
/**
* @brief Enumeration for orietation mode.
+ *
* The Orientation Mode is related to screen size.
* If screen width is longer than height, the Orientation Mode will have LANDSCAPE.
* Otherwise screen width is shorter than height or same, the Orientation Mode will have PORTRAIT.
~Window() override;
/**
- * Second stage initialization
+ * @brief Second stage initialization
+ *
+ * @param[in] surface The surface used to render on.
+ * @param[in] positionSize The window's position and size in initailized time.
+ * @param[in] name The window title
+ * @param[in] className The window class name
+ * @param[in] type window's type. Refer the WindowType in window-enumerations.h.
*/
void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, WindowType type);
/**
- * Called when the window becomes iconified or deiconified.
+ * @brief Called when the window becomes iconified or deiconified.
+ *
+ * @param[in] iconified true If the window is iconified, othewise false.
*/
void OnIconifyChanged(bool iconified);
/**
- * Called when the window becomes maximized or unmaximized.
+ * @brief Called when the window becomes maximized or unmaximized.
+ *
+ * @param[in] maximized true If the window is maximized, othewise false.
*/
void OnMaximizeChanged(bool maximized);
/**
- * Called when the window focus is changed.
+ * @brief Called when the window focus is changed.
+ *
+ * @param[in] focusIn true If the window is focused, othewise false.
*/
void OnFocusChanged(bool focusIn);
/**
- * Called when the output is transformed.
+ * @brief Called when the output is transformed.
*/
void OnOutputTransformed();
/**
- * Called when the window receives a delete request.
+ * @brief Called when the window receives a delete request.
*/
void OnDeleteRequest();
/**
- * Called when the window receives a Transition effect-start/end event.
+ * @brief Called when the window receives a Transition effect-start/end event.
+ *
+ * This event is emitted by display server.
+ *
+ * @param[in] state current window transition effect state, refer the WindowEffectState in window-enumerations.h.
+ * @param[in] type current window transition effect type, refer the WindowEffectType in window-enumerations.h.
*/
void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type);
void OnAccessibilityDisabled();
/**
- * Called when the window rotation is finished.
+ * @brief Called when the window rotation is finished.
*
* This signal is emmit when window rotation is finisehd and WindowRotationCompleted() is called.
*/
/**
* @brief Called when the mouse in or out event is received.
+ *
* @param[in] mouseInOutEvent the mouse event
*/
void OnMouseInOutEvent(const Dali::DevelWindow::MouseInOutEvent& mouseInOutEvent);
/**
* @brief Called when the mouse relative event is received.
+ *
* @param[in] mouseRelativeEvent the mouse event
*/
void OnMouseRelativeEvent(const Dali::DevelWindow::MouseRelativeEvent& mouseRelativeEvent);
/**
* @brief Sets user geometry flag when window's geometry is changed.
+ *
* Window is created with screen size or not.
* If window is created with screen size or the geometry is changed by user,
* client should inform to server setting user.geometry flag
}
/**
- * This signal is emitted when the window is requesting to be deleted
+ * @brief This signal is emitted when the window is requesting to be deleted
+ *
+ * It is internal signal in Dali-adaptor.
*/
SignalType& DeleteRequestSignal()
{
using DamagedRectsContainer = std::vector<Rect<int>>;
/**
- * Uses an window surface to render to.
+ * @brief Uses an window surface to render to.
+ *
* @param [in] positionSize the position and size of the surface
* @param [in] surface can be a window or pixmap.
* @param [in] isTransparent if it is true, surface has 32 bit color depth, otherwise, 24 bit
public: // API
/**
* @brief Get the native window handle
+ *
* @return The native window handle
*/
Any GetNativeWindow();
/**
* @brief Get the native window id
+ *
* @return The native window id
*/
int GetNativeWindowId();
/**
* @brief Sets the render notification trigger to call when render thread is completed a frame
+ *
* @param renderNotification to use
*/
void SetRenderNotification(TriggerEventInterface* renderNotification);
/**
* @brief Sets whether the surface is transparent or not.
+ *
* @param[in] transparent Whether the surface is transparent
*/
void SetTransparency(bool transparent);
/**
- * Request surface rotation
+ * @brief Request surface rotation
+ *
* @param[in] angle A new angle of the surface
* @param[in] positionSize A new position and size of the surface
*/
/**
* @brief Gets the window base object
+ *
* @return The window base object
*/
WindowBase* GetWindowBase();
/**
* @brief Intiailize Ime Surface for Ime window rendering.
- *
* It sets one flag and callback function for Ime window rendering
* This callback function calls one special native window function for ready to commit buffer.
* The special function notify to display server.
/**
* @brief Sets the necessary for window rotation acknowledge.
* After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation.
- *
* More detail description is written in DevelWindow::SetNeedsRotationCompletedAcknowledgement().
*
* @param[in] window The window instance.
PositionSize GetPositionSize() const override;
/**
+ * @copydoc Dali::RenderSurfaceInterface::GetDpi()
*/
void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override;
void Initialize(Any surface);
/**
- * Notify output is transformed.
+ * @brief Notify output is transformed.
*/
void OutputTransformed();
/**
* @brief Called when our event file descriptor has been written to.
+ *
* @param[in] eventBitMask bit mask of events that occured on the file descriptor
* @param[in] fileDescriptor The file descriptor
*/
/**
* @brief Set the buffer damage rects.
+ *
* @param[in] damagedRects List of damaged rects
* @param[in] clippingRect The rect to clip rendered scene
*/
/**
* @brief Swap buffers.
+ *
* @param[in] damagedRects List of damaged rects
*/
void SwapBuffers(const std::vector<Rect<int>>& damagedRects);