namespace Dali
{
+/**
+ * @addtogroup dali_adaptor_framework
+ * @{
+ */
+
typedef Dali::Rect<int> PositionSize;
namespace Internal DALI_INTERNAL
/**
* @brief The window class is used internally for drawing.
*
- * It has an orientation
- * and indicator properties.
+ * A Window has an orientation and indicator properties.
+ * You can get a valid Window handle by calling Dali::Application::GetWindow().
+ * @SINCE_1_0.0
*/
class DALI_IMPORT_API Window : public BaseHandle
{
// Enumerations
/**
- * @brief Orientation of the window.
+ * @brief Enumeration for orientation of the window is the way in which a rectangular page is oriented for normal viewing.
+ * @SINCE_1_0.0
*/
enum WindowOrientation
{
- PORTRAIT = 0,
- LANDSCAPE = 90,
- PORTRAIT_INVERSE = 180,
- LANDSCAPE_INVERSE = 270
+ PORTRAIT = 0, ///< Portrait orientation. The height of the display area is greater than the width. @SINCE_1_0.0
+ LANDSCAPE = 90, ///< Landscape orientation. A wide view area is needed. @SINCE_1_0.0
+ PORTRAIT_INVERSE = 180, ///< Portrait inverse orientation @SINCE_1_0.0
+ LANDSCAPE_INVERSE = 270 ///< Landscape inverse orientation @SINCE_1_0.0
};
/**
- * @brief Opacity of the indicator.
+ * @brief Enumeration for opacity of the indicator.
+ * @SINCE_1_0.0
*/
enum IndicatorBgOpacity
{
- OPAQUE = 100, // Fully opaque indicator Bg
- TRANSLUCENT = 50, // Semi translucent indicator Bg
- TRANSPARENT = 0 // Fully transparent indicator Bg
+ OPAQUE = 100, ///< Fully opaque indicator Bg @SINCE_1_0.0
+ TRANSLUCENT = 50, ///< Semi translucent indicator Bg @SINCE_1_0.0
+ TRANSPARENT = 0 ///< Fully transparent indicator Bg @SINCE_1_0.0
};
/**
- * @brief Visible mode of the indicator.
+ * @brief Enumeration for visible mode of the indicator.
+ * @SINCE_1_0.0
*/
enum IndicatorVisibleMode
{
- INVISIBLE = 0, // hide indicator
- VISIBLE = 1, // show indicator
- AUTO = 2 // hide in default, will show when necessary
+ INVISIBLE = 0, ///< Hide indicator @SINCE_1_0.0
+ VISIBLE = 1, ///< Show indicator @SINCE_1_0.0
+ AUTO = 2 ///< Hide in default, will show when necessary @SINCE_1_0.0
};
// Methods
/**
- * @brief Create an initialized handle to a new Window.
- * @param[in] windowPosition The position and size of the window
- * @param[in] name The window title
- * @param[in] isTransparent Whether window is transparent
- * @return a new window
+ * @brief Creates an initialized handle to a new Window.
+ * @SINCE_1_0.0
+ * @param[in] windowPosition The position and size of the Window
+ * @param[in] name The Window title
+ * @param[in] isTransparent Whether Window is transparent
+ * @return A new window
*/
- static Window New(PositionSize windowPosition, std::string name, bool isTransparent = false);
+ static Window New(PositionSize windowPosition, const std::string& name, bool isTransparent = false);
/**
- * @brief Create an uninitalized handle.
+ * @brief Creates an initialized handle to a new Window.
+ * @SINCE_1_0.0
+ * @param[in] windowPosition The position and size of the Window
+ * @param[in] name The Window title
+ * @param[in] className The Window class name
+ * @param[in] isTransparent Whether Window is transparent
+ * @return A new Window
+ */
+ static Window New(PositionSize windowPosition, const std::string& name, const std::string& className, bool isTransparent = false);
+
+ /**
+ * @brief Creates an uninitialized handle.
*
* This can be initialized using Dali::Application::GetWindow() or
- * Dali::Window::New()
+ * Dali::Window::New().
+ * @SINCE_1_0.0
*/
Window();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * @SINCE_1_0.0
*/
~Window();
/**
* @brief This copy constructor is required for (smart) pointer semantics.
*
- * @param [in] handle A reference to the copied handle
+ * @SINCE_1_0.0
+ * @param[in] handle A reference to the copied handle
*/
Window(const Window& handle);
/**
* @brief This assignment operator is required for (smart) pointer semantics.
*
- * @param [in] rhs A reference to the copied handle
+ * @SINCE_1_0.0
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Window& operator=(const Window& rhs);
/**
* @brief This sets whether the indicator bar should be shown or not.
- * @param[in] visibleMode visible mode for indicator bar, VISIBLE in default
+ * @SINCE_1_0.0
+ * @param[in] visibleMode Visible mode for indicator bar, VISIBLE in default
*/
void ShowIndicator( IndicatorVisibleMode visibleMode );
/**
* @brief This sets the opacity mode of indicator bar.
- * @param[in] opacity - The opacity mode
+ * @SINCE_1_0.0
+ * @param[in] opacity The opacity mode
*/
void SetIndicatorBgOpacity( IndicatorBgOpacity opacity );
/**
* @brief This sets the orientation of indicator bar.
*
- * It does not implicitly show the indicator if it is currently
- * hidden.
+ * It does not implicitly show the indicator if it is currently hidden.
+ * @SINCE_1_0.0
* @param[in] orientation The orientation
*/
void RotateIndicator(WindowOrientation orientation);
/**
- * @brief Set the window name and class string.
+ * @brief Sets the window name and class string.
+ * @SINCE_1_0.0
* @param[in] name The name of the window
* @param[in] klass The class of the window
*/
void SetClass(std::string name, std::string klass);
/**
- * @brief Raise window to top of window stack.
+ * @brief Raises window to the top of Window stack.
+ * @SINCE_1_0.0
*/
void Raise();
/**
- * @brief Lower window to bottom of window stack.
+ * @brief Lowers window to the bottom of Window stack.
+ * @SINCE_1_0.0
*/
void Lower();
/**
- * @brief Activate window to top of window stack even it is iconified.
+ * @brief Activates window to the top of Window stack even it is iconified.
+ * @SINCE_1_0.0
*/
void Activate();
/**
- * @brief Add an orientation to the list of available orientations.
+ * @brief Adds an orientation to the list of available orientations.
+ * @SINCE_1_0.0
+ * @param[in] orientation The available orientation to add
*/
void AddAvailableOrientation( WindowOrientation orientation );
/**
- * @brief Remove an orientation from the list of available orientations.
+ * @brief Removes an orientation from the list of available orientations.
+ * @SINCE_1_0.0
+ * @param[in] orientation The available orientation to remove
*/
void RemoveAvailableOrientation( WindowOrientation orientation );
/**
- * @brief Set a preferred orientation.
- * @pre orientation is in the list of available orientations
+ * @brief Sets a preferred orientation.
+ * @SINCE_1_0.0
* @param[in] orientation The preferred orientation
+ * @pre Orientation is in the list of available orientations.
*/
void SetPreferredOrientation( WindowOrientation orientation );
/**
- * @brief Get the preferred orientation.
- * @return The preferred orientation if previously set, or none.
+ * @brief Gets the preferred orientation.
+ * @SINCE_1_0.0
+ * @return The preferred orientation if previously set, or none
*/
WindowOrientation GetPreferredOrientation();
/**
* @brief Returns the Drag & drop detector which can be used to receive drag & drop events.
- * @return A handle to the DragAndDropDetector.
+ * @note Not intended for application developers.
+ * @SINCE_1_0.0
+ * @return A handle to the DragAndDropDetector
*/
DragAndDropDetector GetDragAndDropDetector() const;
/**
- * @brief Get the native handle of the window.
- * @return The native handle of the window or an empty handle.
+ * @brief Gets the native handle of the window.
+ *
+ * When users call this function, it wraps the actual type used by the underlying window system.
+ * @SINCE_1_0.0
+ * @return The native handle of the Window or an empty handle
*/
Any GetNativeHandle() const;
public: // Signals
/**
- * The user should connect to this signal to get a timing when indicator was shown / hidden.
+ * @brief The user should connect to this signal to get a timing when indicator was shown / hidden.
+ * @SINCE_1_0.0
+ * @return The signal to connect to
*/
IndicatorSignalType& IndicatorVisibilityChangedSignal();
public: // Not intended for application developers
/**
+ * @internal
* @brief This constructor is used by Dali::Application::GetWindow().
- * @param[in] window A pointer to the window.
+ * @SINCE_1_0.0
+ * @param[in] window A pointer to the Window
*/
explicit DALI_INTERNAL Window( Internal::Adaptor::Window* window );
};
+/**
+ * @}
+ */
} // namespace Dali
#endif // __DALI_WINDOW_H__
projects / platform / core / uifw / dali-adaptor.git / blobdiff