From dc8ca40a3216f56859732eeaf3b2bc4e50d8a1af Mon Sep 17 00:00:00 2001 From: "jaewon7.cho" Date: Thu, 18 Apr 2013 22:04:11 +0900 Subject: [PATCH] Update doxygen explanations for SetOwner() API Change-Id: I77c3ac782c7fe8c159e37a089388a3743913d40b Signed-off-by: jaewon7.cho --- inc/FUiCtrlContextMenu.h | 12 ++++++++++++ inc/FUiCtrlKeypad.h | 3 +++ inc/FUiCtrlMessageBox.h | 3 +++ inc/FUiCtrlPopup.h | 21 +++++++++++++++++++++ inc/FUiCtrlTimePicker.h | 3 +++ inc/FUiWindow.h | 3 ++- 6 files changed, 44 insertions(+), 1 deletion(-) mode change 100644 => 100755 inc/FUiCtrlContextMenu.h mode change 100644 => 100755 inc/FUiCtrlKeypad.h mode change 100644 => 100755 inc/FUiCtrlMessageBox.h mode change 100644 => 100755 inc/FUiCtrlPopup.h mode change 100644 => 100755 inc/FUiCtrlTimePicker.h mode change 100644 => 100755 inc/FUiWindow.h diff --git a/inc/FUiCtrlContextMenu.h b/inc/FUiCtrlContextMenu.h old mode 100644 new mode 100755 index 23786042..fc4ca5d --- a/inc/FUiCtrlContextMenu.h +++ b/inc/FUiCtrlContextMenu.h @@ -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); diff --git a/inc/FUiCtrlKeypad.h b/inc/FUiCtrlKeypad.h old mode 100644 new mode 100755 index d6f4c3a..64cf68f --- a/inc/FUiCtrlKeypad.h +++ b/inc/FUiCtrlKeypad.h @@ -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); diff --git a/inc/FUiCtrlMessageBox.h b/inc/FUiCtrlMessageBox.h old mode 100644 new mode 100755 index ed72e01..3c06ae2 --- a/inc/FUiCtrlMessageBox.h +++ b/inc/FUiCtrlMessageBox.h @@ -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); diff --git a/inc/FUiCtrlPopup.h b/inc/FUiCtrlPopup.h old mode 100644 new mode 100755 index 39009da..f981fff --- a/inc/FUiCtrlPopup.h +++ b/inc/FUiCtrlPopup.h @@ -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); diff --git a/inc/FUiCtrlTimePicker.h b/inc/FUiCtrlTimePicker.h old mode 100644 new mode 100755 index 39e3622..5d7b20f --- a/inc/FUiCtrlTimePicker.h +++ b/inc/FUiCtrlTimePicker.h @@ -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""); diff --git a/inc/FUiWindow.h b/inc/FUiWindow.h old mode 100644 new mode 100755 index 1f8bcfa..8a224ca --- a/inc/FUiWindow.h +++ b/inc/FUiWindow.h @@ -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 * -- 2.7.4