Update doxygen explanations for SetOwner() API
authorjaewon7.cho <jaewon7.cho@samsung.com>
Thu, 18 Apr 2013 13:04:11 +0000 (22:04 +0900)
committerjaewon7.cho <jaewon7.cho@samsung.com>
Thu, 18 Apr 2013 13:18:48 +0000 (22:18 +0900)
Change-Id: I77c3ac782c7fe8c159e37a089388a3743913d40b
Signed-off-by: jaewon7.cho <jaewon7.cho@samsung.com>
inc/FUiCtrlContextMenu.h [changed mode: 0644->0755]
inc/FUiCtrlKeypad.h [changed mode: 0644->0755]
inc/FUiCtrlMessageBox.h [changed mode: 0644->0755]
inc/FUiCtrlPopup.h [changed mode: 0644->0755]
inc/FUiCtrlTimePicker.h [changed mode: 0644->0755]
inc/FUiWindow.h [changed mode: 0644->0755]

old mode 100644 (file)
new mode 100755 (executable)
index 2378604..fc4ca5d
@@ -262,6 +262,9 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM            A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Graphics::Point& point, ContextMenuStyle style);
 
@@ -276,6 +279,9 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM            A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Graphics::FloatPoint& point, ContextMenuStyle style);
 
@@ -291,6 +297,9 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Graphics::Point& point, ContextMenuStyle style, ContextMenuAnchorDirection direction);
 
@@ -306,6 +315,9 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_STATE This instance has already been constructed.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Graphics::FloatPoint& point, ContextMenuStyle style, ContextMenuAnchorDirection direction);
 
old mode 100644 (file)
new mode 100755 (executable)
index d6f4c3a..64cf68f
@@ -227,6 +227,9 @@ public:
         * @exception   E_SYSTEM            A system error has occurred.
         * @remarks     If the keypad style is set to password, the input mode category is ignored.
         * @remarks     The orientation mode of the keypad is decided based on the G-sensor value.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(KeypadStyle keypadStyle, int limitLength);
 
old mode 100644 (file)
new mode 100755 (executable)
index ed72e01..3c06ae2
@@ -215,6 +215,9 @@ public:
         * @remarks             To create a %MessageBox control, call ShowAndWait() after the Construct() method is called. @n
         *                              The message box text cannot contain over @c 399 characters. @n
         *                              To display the text in multi-lines or to denote the end of line use '\\n'.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         * @see                 ShowAndWait()
         */
        result Construct(const Tizen::Base::String& title, const Tizen::Base::String& text, MessageBoxStyle style, unsigned long timeout = 0);
old mode 100644 (file)
new mode 100755 (executable)
index 39009da..f981fff
@@ -202,6 +202,9 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG           A specified input parameter is invalid.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(bool hasTitle, const Tizen::Graphics::Dimension& dim);
 
@@ -217,6 +220,9 @@ public:
         * @exception   E_SUCCESS               The method is successful.
         * @exception   E_INVALID_ARG           A specified input parameter is invalid.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
 
@@ -235,6 +241,9 @@ public:
         * @exception  E_FILE_NOT_FOUND        The specified file cannot be found.
         * @exception  E_INVALID_FORMAT        The specified XML format is invalid.
         * @exception  E_OPERATION_FAILED      The operation has failed.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Base::String& resourceId);
 
@@ -252,6 +261,9 @@ public:
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
         *                                                                      the specified layout is already bound to another container.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Ui::Layout& layout, bool hasTitle, const Tizen::Graphics::Dimension& dim);
 
@@ -269,6 +281,9 @@ public:
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
         *                                                                      the specified layout is already bound to another container.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Ui::Layout& layout, bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
 
@@ -287,6 +302,9 @@ public:
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
         *                                                                      the specified layout is already bound to another container.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, bool hasTitle, const Tizen::Graphics::Dimension& dim);
 
@@ -305,6 +323,9 @@ public:
         * @exception   E_INVALID_ARG           A specified input parameter is invalid, or
         *                                                                      the specified layout is already bound to another container.
         * @exception   E_SYSTEM                A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Ui::Layout& portraitLayout, const Tizen::Ui::Layout& landscapeLayout, bool hasTitle, const Tizen::Graphics::FloatDimension& dim);
 
old mode 100644 (file)
new mode 100755 (executable)
index 39e3622..5d7b20f
@@ -225,6 +225,9 @@ public:
         * @param[in]   title               The title
         * @exception   E_SUCCESS           The method is successful.
         * @exception   E_SYSTEM                    A system error has occurred.
+        * @remarks             The default owner will be the current Form (or Frame). It is possible that this control may not be visible 
+        * due to this ownership relationship. In that case, see the SetOwner API to change the ownership to the top-most window.
+        * @see                 SetOwner()
         */
        result Construct(const Tizen::Base::String& title = L"");
 
old mode 100644 (file)
new mode 100755 (executable)
index 1f8bcfa..8a224ca
@@ -129,7 +129,8 @@ public:
        virtual result Show(void);
 
        /**
-        * Sets the owner of the window.
+        * Sets the owner of the window. @n
+        * The visibility of a window has dependency on the visibility of the owner window.
         *
         * @since 2.0
         *