From: woo Date: Fri, 19 Apr 2013 04:30:52 +0000 (+0900) Subject: apply doxygen header review only Tizen::Ui namespace X-Git-Tag: accepted/tizen_2.1/20130425.033138~94^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6e551317bd448a9ceee15ae87be4d2cebee23a4d;p=platform%2Fframework%2Fnative%2Fuifw.git apply doxygen header review only Tizen::Ui namespace Change-Id: I27df7b05f68c6cb69a806dc8bc3fbcc60ef67571 Signed-off-by: woo --- diff --git a/inc/FUiContainer.h b/inc/FUiContainer.h index 169dac5..77d4272 100644 --- a/inc/FUiContainer.h +++ b/inc/FUiContainer.h @@ -105,22 +105,24 @@ public: result AddControl(const Control& control); /** - * Adds the control at the end of the list maintained by the container. + * Adds a control at the end of the list maintained by a container. * * @since 2.1 * * @return An error code - * @param[in] pControl The pointer of the control to add to the container + * @param[in] control The control to add to the container + * @param[in] pControl A pointer to the control to add to the container * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c pControl is null. - * The specified @c control is an instance of Window, or this control's parent container. + * @exception E_INVALID_ARG The specified @c pControl is @c null. + * The specified @c control is an instance of Window or the control's parent container. * @exception E_MAX_EXCEEDED The number of child controls has exceeded the maximum limit. * @exception E_INVALID_ARG * @exception E_SYSTEM A system error has occurred. - * @remarks When the control is added, it is placed at the top of the drawing stack maintained by the container.@n - * This means the last control added is drawn last - * @remarks A control becomes displayable only after it has been added to a displayable container. Some methods may not work normally if the methods - * of the control are called before adding the control to a container. After the control is added to a %Container, the OnInitializing() + * @remarks + * - When a control is added, it is placed at the top of the drawing stack maintained by the container.@n + * This means the control that is added last is drawn last. + * - A control becomes displayable only after it has been added to a displayable container. + * Some methods may not work normally if the methods of the control are called before adding the control to a container. After the control is added to a %Container, the OnInitializing() * method of the control are called before adding the control to a container. After the control is added to a %Container, the * OnInitializing() method of the control is invoked for the initialization of the control such as creating and adding child controls. * @see Tizen::Ui::Control::OnInitializing() @@ -259,24 +261,24 @@ public: * @exception E_OBJ_NOT_FOUND The specified instance is not found within the indicated range (that is, the @c control is not found). * @exception E_SYSTEM A system error has occurred. * @remarks The removed child control is deleted from the memory. Before deletion, OnTerminating() of the child control is called. - * If OnTerminating() method is overrided and returns an exception, that exception will be propagated. + * If OnTerminating() method is overridden and returns an exception, that exception is propagated. * @see Tizen::Ui::Control::OnTerminating() */ result RemoveControl(const Control& control); /** - * Removes the specified control from the container. + * Removes a specified control from the container. * * @since 2.1 * * @return An error code - * @param[in] pControl Pointer of the child control to be removed + * @param[in] pControl A pointer to the child control to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified instance is not found within the indicated range (that is, the @c control is not found). - * @exception E_INVALID_ARG The specified @c pControl is null. + * @exception E_INVALID_ARG The specified @c pControl is @c null. * @exception E_SYSTEM A system error has occurred. * @remarks The removed child control is deleted from the memory. Before deletion, OnTerminating() of the child control is called. - * If OnTerminating() method is overrided and returns an exception, that exception will be propagated. + * If OnTerminating() method is overridden and returns an exception, that exception is propagated. * @see Tizen::Ui::Control::OnTerminating() */ result RemoveControl(Control* pControl); @@ -292,7 +294,7 @@ public: * @exception E_OUT_OF_RANGE The specified @c index is out of range. * @exception E_SYSTEM A system error has occurred. * @remarks The removed child control is deleted from the memory. Before deletion, OnTerminating() of the child control is called. - * If OnTerminating() method is overrided and returns an exception, that exception will be propagated. + * If OnTerminating() method is overridden and returns an exception, that exception is propagated. * @see Tizen::Ui::Control::OnTerminating() */ result RemoveControl(int index); @@ -424,13 +426,13 @@ public: bool IsAncestorOf(const Control& control) const; /** - * Checks whether the specified control is a child or descendant of the container. + * Checks whether a specified control is a child or descendant of the container. * * @since 2.1 * - * @return @c true if the specified control is within the containment hierarchy of the container, @n + * @return @c true if a specified control is within the containment hierarchy of the container, @n * else @c false - * @param[in] pControl Pointer of the control + * @param[in] pControl A pointer to the control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c pControl is null. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -507,20 +509,18 @@ public: bool IsControlAlwaysAtBottom(const Tizen::Ui::Control& control) const; /** - * Checks whether the specified child control is always at the bottom of - * the drawing stack. + * Checks whether a specified child control is always at the bottom of the drawing stack. * * @since 2.1 * - * @return @c true if the specified child control is set as always at the bottom, @n + * @return @c true if a specified child control is set as always at the bottom, @n * else @c false - * @param[in] pControl Pointer of child control + * @param[in] pControl A pointer to child control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid.@n * The specified control is not a child of this - * container or @c pControl is null . - * @remarks The specific error code can be accessed using the GetLastResult() - * method. + * container or @c pControl is @c null . + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetControlAlwaysAtBottom() */ bool IsControlAlwaysAtBottom(const Tizen::Ui::Control* pControl) const; @@ -547,20 +547,18 @@ public: bool IsControlAlwaysOnTop(const Tizen::Ui::Control& control) const; /** - * Checks whether the specified child control is always on the top of - * the drawing stack. + * Checks whether a specified child control is always at the top of the drawing stack. * * @since 2.1 * - * @return @c true if the specified child control is set as always on the top, @n + * @return @c true if a specified child control is set as always at the top, @n * else @c false - * @param[in] pControl Pointer of child control + * @param[in] pControl A pointer to child control * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. @n * The specified control is not a child of this - * container. or @c pControl is null - * @remarks The specific error code can be accessed using the GetLastResult() - * method. + * container. or @c pControl is @c null + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetControlAlwaysOnTop() */ bool IsControlAlwaysOnTop(const Tizen::Ui::Control* pControl) const; @@ -590,7 +588,7 @@ protected: * @since 2.0 * * @return An error code - * @param[in] rect The rectangle bounds to be set + * @param[in] rect The rectangle bounds to set * @param[in] resizable Set to @c true to make the container resizable, @n * else @c false * @param[in] movable Set to @c true to make the container movable, @n @@ -609,7 +607,7 @@ protected: * @since 2.1 * * @return An error code - * @param[in] rect The rectangle bounds to be set + * @param[in] rect The rectangle bounds to set * @param[in] resizable Set to @c true to make the container resizable, @n * else @c false * @param[in] movable Set to @c true to make the container movable, @n @@ -733,14 +731,14 @@ protected: result GetControlAt(const Control& control, int& index) const; /** - * Gets the index of the specified control. + * Gets the index of a specified control. * * @since 2.1 * @return An error code - * @param[in] pControl Pointer of the control + * @param[in] pControl A pointer to the control * @param[out] index The index of the control * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c pControl is null. + * @exception E_INVALID_ARG The specified @c pControl is @c null. * @exception E_OBJ_NOT_FOUND The specified instance of Control is not found. * @see SetControlAt() * @@ -769,19 +767,19 @@ protected: result SetControlAt(const Control& control, int index); /** - * Sets the control at the specified index. + * Sets the control at a specified index. * * @since 2.1 * * @return An error code - * @param[in] pControl Pointer of the control + * @param[in] pControl A pointer to the control * @param[in] index The index * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified @c index is out of range. - * @exception E_INVALID_ARG The specified @c pControl is null. + * @exception E_INVALID_ARG The specified @c pControl is @c null. * @exception E_SYSTEM A system error has occurred. * @remarks The @c control must be first added to this container. @n - * Call the Invalidate() method after this, to apply the change to be shown. + * Then the Invalidate() method is called to show the applied changes. * @see Invalidate() * @see GetControlAt() * diff --git a/inc/FUiControl.h b/inc/FUiControl.h index a138eaa..6e3c251 100644 --- a/inc/FUiControl.h +++ b/inc/FUiControl.h @@ -287,8 +287,9 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_FAILURE The method has failed. - * @remarks This method is called right before the control is removed from the container, or Destroy() method is being called. - * @remarks To cancel the removal or Destroy() operation, return any exception other than E_SUCCESS. + * @remarks + * - This method is called right before the control is removed from the container, or Destroy() method is called. + * - To cancel the removal or Destroy() operation, return any exception other than @c E_SUCCESS. * @see OnInitializing() */ virtual result OnTerminating(void); @@ -319,13 +320,13 @@ public: virtual void OnUserEventReceivedN(RequestId requestId, Tizen::Base::Collection::IList* pArgs); /** - * Deallocates this instance after removing all child controls of this control + * Deallocates this instance after removing all child controls of this control. * * @since 2.1 * * @exception E_SUCCESS The method is successful. - * @remarks The control will be deleted from memory. Before it is deleted, OnTerminating() is called if it is attached to the main tree. - * @remarks If OnTerminating() method is overrided and returns an exception, that exception will be propagated. + * @remarks The control is deleted from memory. Before it is deleted, OnTerminating() is called if it is attached to the main tree. + * @remarks If OnTerminating() method is overridden and returns an exception, that exception is propagated. * @see Tizen::Ui::Control:OnTerminating() */ result Destroy(void); @@ -1677,15 +1678,15 @@ public: result AddGestureDetector(const TouchGestureDetector& gestureDetector); /** - * Adds the gesture detector to the %Control. @n + * Adds a gesture detector to the %Control. @n * The added gesture detector receives touch events prior to %Control. * * @since 2.1 * * @return An error code - * @param[in] pGestureDetector Pointer of gesture detector + * @param[in] pGestureDetector A pointer to gesture detector * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c pGestureDetector is null. + * @exception E_INVALID_ARG The specified @c pGestureDetector is @c null. * @see RemoveGestureDetector() */ result AddGestureDetector(TouchGestureDetector* pGestureDetector); @@ -1705,14 +1706,14 @@ public: result RemoveGestureDetector(const TouchGestureDetector& gestureDetector); /** - * Removes the gesture detector from the %Control. + * Removes a gesture detector from the %Control. * * @since 2.1 * * @return An error code - * @param[in] pGestureDetector Pointer of gesture detector + * @param[in] pGestureDetector A pointer to gesture detector * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c pGestureDetector is null. + * @exception E_INVALID_ARG The specified @c pGestureDetector is @c null. * @see AddGestureDetector() */ result RemoveGestureDetector(TouchGestureDetector* pGestureDetector); diff --git a/inc/FUiDataBindingContext.h b/inc/FUiDataBindingContext.h index c8fe5e9..3bc75f5 100644 --- a/inc/FUiDataBindingContext.h +++ b/inc/FUiDataBindingContext.h @@ -280,9 +280,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @exception E_INVALID_ARG The specified @c destType is not of a supported type. - * @remarks 1. If you have set a data binding listener, @n - this method is returned after that listener is called. @n - 2. The behavior of this method is dependent on the system default locale setting. + * @remarks + * - If you have set a data binding listener, @n + this method is returned after that listener is called. + * - The behavior of this method is dependent on the system default locale setting. * @see IDataBindingListener */ result UpdateAllBindings(DataBindingDestinationType destType); @@ -299,9 +300,10 @@ public: * @exception E_OBJ_NOT_FOUND The given binding ID is not registered. * @exception E_INVALID_OPERATION The given binding's trigger is not 'explicit' type. * @exception E_INVALID_ARG The specified @c destType is not supported in binding ID. - * @remarks 1. If you have set a data binding listener, @n - this method is returned after that listener is called.@n - 2. The behavior of this method is dependent on the system default locale setting. + * @remarks + * - If you have set a data binding listener, @n + this method is returned after that listener is called. + * - The behavior of this method is dependent on the system default locale setting. * @see IDataBindingListener */ result UpdateBinding(const Tizen::Base::String& bindingId, DataBindingDestinationType destType); diff --git a/inc/FUiIAccessibilityListener.h b/inc/FUiIAccessibilityListener.h index c2bebe5..8978859 100644 --- a/inc/FUiIAccessibilityListener.h +++ b/inc/FUiIAccessibilityListener.h @@ -56,7 +56,7 @@ public: virtual ~IAccessibilityListener(void) {} /** - * Called when the accessibility element has gotten a focus. + * Called when the accessibility element gets a focus. * * @since 2.0 * @param[in] control The control that has an accessibility element @@ -65,7 +65,7 @@ public: virtual void OnAccessibilityFocusIn(const Control& control, const AccessibilityElement& element) = 0; /** - * Called when the accessibility element has lost a focus. + * Called when the accessibility element losts a focus. * * @since 2.0 * @param[in] control The control that has an accessibility element @@ -74,7 +74,7 @@ public: virtual void OnAccessibilityFocusOut(const Control& control, const AccessibilityElement& element) = 0; /** - * Called when the accessibility element has been operated. + * Called when the accessibility element is operated. * * @since 2.0 * @param[in] control The control that has an accessibility element @@ -83,7 +83,7 @@ public: virtual void OnAccessibilityActionPerformed(const Control& control, const AccessibilityElement& element) = 0; /** - * Called when the accessibility screen status has been changed. + * Called when the accessibility screen status is changed. * * @since 2.0 * @param[in] control The control that has an accessibility element diff --git a/inc/FUiInputConnection.h b/inc/FUiInputConnection.h index 4c77036..5074729 100644 --- a/inc/FUiInputConnection.h +++ b/inc/FUiInputConnection.h @@ -200,7 +200,7 @@ public: virtual ~InputConnection(void); /** - * Initializes this instance of the %InputConnection with the specified parameter. + * Initializes this instance of %InputConnection with the specified parameter. * * @since 2.0 * @return An error code @@ -214,12 +214,13 @@ public: result Construct(const Control* pControl, IInputConnectionEventListener& listener, IInputConnectionProvider& provider); /** - * Initializes this instance of the %InputConnection with the specified parameter. + * Initializes this instance of %InputConnection with a specified parameter. * * @since 2.1 + * * @return An error code - * @param[in] pControl The source object for connecting the Input Method. - * @param[in] listener An instance of the %IInputConnectionEventListenerF for processing the event + * @param[in] pControl The source object for connecting the Input Method + * @param[in] listener An instance of %IInputConnectionEventListenerF for processing the event * @param[in] provider The %InputConnection provider * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. @@ -253,7 +254,7 @@ public: * @since 2.0 * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. * @see HideInputPanel() */ result ShowInputPanel(void); @@ -264,7 +265,7 @@ public: * @since 2.0 * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. * @see ShowInputPanel() */ result HideInputPanel(void); @@ -294,7 +295,7 @@ public: * @since 2.0 * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. */ result FinishTextComposition(void); @@ -332,11 +333,12 @@ public: * Sets the cursor at the specified position. * * @since 2.0 - * @param[in] position The cursor position that is to set + * * @return An error code + * @param[in] position The cursor position that is to set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. */ result SetCursorPosition(int position); @@ -344,11 +346,12 @@ public: * Sets the bounds of the cursor. * * @since 2.0 - * @param[in] rect The rectangle to set + * * @return An error code + * @param[in] rect The rectangle to set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. */ result SetCursorBounds(const Tizen::Graphics::Rectangle& rect); @@ -356,11 +359,12 @@ public: * Sets the bounds of the cursor. * * @since 2.1 - * @param[in] rect The rectangle to set + * * @return An error code + * @param[in] rect The rectangle to set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. */ result SetCursorBounds(const Tizen::Graphics::FloatRectangle& rect); @@ -371,7 +375,7 @@ public: * @return An instance of the rectangle that represents the position of the top-left corner, * the width, and the height of the Input Panel. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Graphics::Rectangle GetInputPanelBounds(void) const; @@ -380,10 +384,11 @@ public: * Gets the bounds of the current active Input Panel. * * @since 2.1 + * * @return An instance of the rectangle that represents the position of the top-left corner, - * the width, and the height of the Input Panel. + * the width, and the height of the Input Panel * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This exception is thrown when BindInputMethod is not called before calling this method. + * @exception E_INVALID_STATE This exception is thrown when BindInputMethod() is not called before calling this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Graphics::FloatRectangle GetInputPanelBoundsF(void) const; diff --git a/inc/FUiKeyTypes.h b/inc/FUiKeyTypes.h index bcf3109..4035225 100644 --- a/inc/FUiKeyTypes.h +++ b/inc/FUiKeyTypes.h @@ -40,7 +40,7 @@ enum KeyCode KEY_INVALID = 0x0000, /**< The invalid key */ KEY_SIDE_UP, /**< The up side key */ KEY_SIDE_DOWN, /**< The down side key */ - KEY_OK, /**< The ok key */ + KEY_OK, /**< The OK key */ KEY_CLEAR, /**< The clear key */ KEY_CAMERA, /**< The camera key */ KEY_SWITCH, /**< The task switcher key */ @@ -195,7 +195,7 @@ enum KeyCode KEY_OEM_18, /**< The OEM 18 key */ KEY_OEM_19, /**< The OEM 19 key */ KEY_OEM_20, /**< The OEM 20 key */ - KEY_HARDWARE_MAX /**< placeholder key */ + KEY_HARDWARE_MAX /**< The placeholder key */ }; /** diff --git a/inc/FUiRelativeLayout.h b/inc/FUiRelativeLayout.h index dd184a8..4244bba 100644 --- a/inc/FUiRelativeLayout.h +++ b/inc/FUiRelativeLayout.h @@ -234,7 +234,7 @@ public: * Sets the relation of the specified child control for the edge with other control. * * @brief [Deprecated] - * @deprecated This API is deprecated. + * @deprecated This method is deprecated. * @since 2.0 * * @return An error code @@ -250,7 +250,7 @@ public: result SetRelation(Control& childControl, const Control& targetControl, RectangleEdgeRelation edgeRelation); /** - * Sets the relation of the specified child control for the edge with other control. + * Sets the relation of a specified child control for the edge with other control. * * @since 2.0 * @@ -260,8 +260,8 @@ public: * It must be a parent or sibling. * @param[in] edgeRelation The edge of the specified control to align with the edge of the target control * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n - * Either the specified @c childControl or the specified @c targetControl is not a child of the container that owns the layout. + * @exception E_INVALID_ARG A specified input parameter is invalid. @n + * Either the specified @c childControl or the specified @c pTargetControl is not a child of the container that owns the layout. * @exception E_SYSTEM A system error has occurred. */ result SetRelation(Control& childControl, Control *pTargetControl, RectangleEdgeRelation edgeRelation); @@ -332,7 +332,7 @@ public: result SetMargin(Control& childControl, int left, int right, int top, int bottom); /** - * Sets the margins of the specified control. + * Sets the margins of a specified control. * * @since 2.1 * @@ -343,7 +343,7 @@ public: * @param[in] top The top margin * @param[in] bottom The bottom margin * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n + * @exception E_INVALID_ARG A specified input parameter is invalid. @n * The specified @c childControl parameter is not a child of the container that owns the layout. * @exception E_SYSTEM A system error has occurred. * @remarks By default, the margins are set to @c 0. @@ -366,7 +366,7 @@ public: result SetWidth(Control& childControl, int width); /** - * Sets the width of the specified control to the fixed size. + * Sets the width of a specified control to the fixed size. * * @since 2.1 * @@ -374,7 +374,7 @@ public: * @param[in] childControl The control for which the width is set * @param[in] width The value of the width * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n + * @exception E_INVALID_ARG A specified input parameter is invalid. @n * The specified @c childControl parameter is not a child of the container that owns the layout. * @exception E_SYSTEM A system error has occurred. */ @@ -411,7 +411,7 @@ public: result SetHeight(Control& childControl, int height); /** - * Sets the height of the specified control to the fixed size. + * Sets the height of a specified control to the fixed size. * * @since 2.1 * @@ -419,7 +419,7 @@ public: * @param[in] childControl The control for which the height is set * @param[in] height The value of the height * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n + * @exception E_INVALID_ARG A specified input parameter is invalid. @n * The specified @c childControl parameter is not a child of the container that owns the layout. * @exception E_SYSTEM A system error has occurred. */ diff --git a/inc/FUiTouchGestureDetector.h b/inc/FUiTouchGestureDetector.h index 4fe5f6a..b1ef3f6 100644 --- a/inc/FUiTouchGestureDetector.h +++ b/inc/FUiTouchGestureDetector.h @@ -161,17 +161,17 @@ public: * Sets priority between gesture detectors. * * @brief [Deprecated] - * @deprecated This API is deprecated. + * @deprecated This method is deprecated. * @since 2.0 * * @return An error code * @param[in] gestureDetector The gesture detector * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c gestureDetector is invalid. + * @exception E_INVALID_ARG The specified @c gestureDetector is invalid. * @remarks If you want to set relationship between gesture detectors, call this method. * If @c gestureDetector fails in recognizing a gesture, the gesture detector which waits for it starts the processing of recognizing. * If @c gestureDetector succeeds in recognizing a gesture, - * the state of the gesture detector which waits for it changes to GESTURE_DETECTOR_STATE_FAIL. + * the state of the gesture detector which waits for it changes to @c GESTURE_DETECTOR_STATE_FAIL. */ result StartOnFailureOf(const TouchGestureDetector& gestureDetector); @@ -181,13 +181,13 @@ public: * @since 2.1 * * @return An error code - * @param[in] pGestureDetector Pointer of gesture detector + * @param[in] pGestureDetector A pointer of gesture detector * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The @c pGestureDetector is null. * @remarks If you want to set relationship between gesture detectors, call this method. * If @c gestureDetector fails in recognizing a gesture, the gesture detector which waits for it starts the processing of recognizing. * If @c gestureDetector succeeds in recognizing a gesture, - * the state of the gesture detector which waits for it changes to GESTURE_DETECTOR_STATE_FAIL. + * the state of the gesture detector which waits for it changes to @c GESTURE_DETECTOR_STATE_FAIL. */ result StartOnFailureOf(TouchGestureDetector* pGestureDetector); diff --git a/inc/FUiTouchPinchGestureDetector.h b/inc/FUiTouchPinchGestureDetector.h index e604c78..cec4172 100644 --- a/inc/FUiTouchPinchGestureDetector.h +++ b/inc/FUiTouchPinchGestureDetector.h @@ -148,7 +148,7 @@ public: * @since 2.1 * * @return The scale factor among touched points - * @remarks Get scale factor for a pinch gesture in progress + * @remarks Gets the scale factor for a pinch gesture in progress. */ float GetScaleF(void) const; diff --git a/inc/FUiUiConfiguration.h b/inc/FUiUiConfiguration.h index 311e0bc..6e405d8 100644 --- a/inc/FUiUiConfiguration.h +++ b/inc/FUiUiConfiguration.h @@ -94,30 +94,30 @@ public: static Tizen::Base::String GetDefaultFontFile(void); /** - * Gets the actual font size + * Gets the actual font size. * * @since 2.1 * - * @return An actual font size of given font size string. - * @param[in] sizeString The predefined string value, such as "giant", "huge", "large", "medium", or "small". @n - * It is case-insensitive and can be retrieved using Tizen:System:SettingInfo::GetValue(). - - * @remarks If the specified @c sizeString is not defined, -1 is returned. + * @return An actual font size of given font size string + * @param[in] sizeString The predefined string value, such as "giant", "huge", "large", "medium", or "small" @n + * It is case-insensitive and can be retrieved using Tizen::System::SettingInfo::GetValue(). + * @remarks If the specified @c sizeString is not defined, @c -1 is returned. */ static float GetFontSize(const Tizen::Base::String& sizeString); /** - * Gets the color of controls + * Gets the color of controls. * * @since 2.1 * * @return The color of the given color key - * @param[in] colorKey The color key. + * @param[in] colorKey The color key * @exception E_SUCCESS The method is successful. * @exception E_KEY_NOT_FOUND The specified color cannot be found or accessed. - * @remarks 1. Color keys are defined in FUiUiConfigurationTypes.h. - * 2. The specific error code can be accessed using the GetLastResult() method. - * 3. Using the return value without checking the return value of GetLastResult is prohibited. + * @remarks + * - Color keys are defined in FUiUiConfigurationTypes.h. + * - The specific error code can be accessed using the GetLastResult() method. + * - Using the return value without checking the return value of GetLastResult() is prohibited. */ static Tizen::Graphics::Color GetColor(int colorKey); diff --git a/inc/FUiUiConfigurationTypes.h b/inc/FUiUiConfigurationTypes.h index ee05ffe..351013b 100644 --- a/inc/FUiUiConfigurationTypes.h +++ b/inc/FUiUiConfigurationTypes.h @@ -19,7 +19,7 @@ * @file FUiUiConfigurationTypes.h * @brief This is the header file for the common data types used by the UI configuration. * - * This is the header file for the common data types used by the UI configuration. + * This header file contains the descriptions of the common data types used by the UI configuration. */ #ifndef _FUI_UI_CONFIGURATION_TYPES_H_ @@ -34,248 +34,248 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Button { /** - * The property key to get the normal background color of button + * The property key to get the normal background color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the disabled background color of button + * The property key to get the disabled background color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_DISABLED; /** - * The property key to get the pressed background color of button + * The property key to get the pressed background color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_PRESSED; /** - * The property key to get the highlighted background color of button + * The property key to get the highlighted background color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_HIGHLIGHTED; /** - * The property key to get the normal text color of button + * The property key to get the normal text color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the disabled text color of button + * The property key to get the disabled text color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the pressed text color of button + * The property key to get the pressed text color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the highlighted text color of button + * The property key to get the highlighted text color of button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_HIGHLIGHTED; }; - + struct CheckButton { /** - * The property key to get the normal background color of check button + * The property key to get the normal background color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the disabled background color of check button + * The property key to get the disabled background color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_DISABLED; /** - * The property key to get the pressed background color of check button + * The property key to get the pressed background color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_PRESSED; /** - * The property key to get the highlighted background color of check button + * The property key to get the highlighted background color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_HIGHLIGHTED; /** - * The property key to get the selected background color of check button + * The property key to get the selected background color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_SELECTED; /** - * The property key to get the normal text color of check button + * The property key to get the normal text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the disabled text color of check button + * The property key to get the disabled text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the pressed text color of check button + * The property key to get the pressed text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the highlighted text color of check button + * The property key to get the highlighted text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of check button + * The property key to get the selected text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_SELECTED; /** - * The property key to get the normal title text color of check button + * The property key to get the normal title text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the disabled title text color of check button + * The property key to get the disabled title text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_DISABLED; /** - * The property key to get the pressed title text color of check button + * The property key to get the pressed title text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_PRESSED; /** - * The property key to get the highlighted title text color of check button + * The property key to get the highlighted title text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_HIGHLIGHTED; /** - * The property key to get the selected title text color of check button + * The property key to get the selected title text color of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_SELECTED; /** - * The property key to get the normal background color of the detailed icon of check button + * The property key to get the normal background color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_BG_NORMAL; /** - * The property key to get the disabled background color of the detailed icon of check button + * The property key to get the disabled background color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_BG_DISABLED; /** - * The property key to get the pressed background color of the detailed icon of check button + * The property key to get the pressed background color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_BG_PRESSED; /** - * The property key to get the highlighted background color of the detailed icon of check button + * The property key to get the highlighted background color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the detailed icon of check button + * The property key to get the selected background color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_BG_SELECTED; /** - * The property key to get the normal text color of the detailed icon of check button + * The property key to get the normal text color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_TEXT_NORMAL; /** - * The property key to get the disabled text color of the detailed icon of check button + * The property key to get the disabled text color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_TEXT_DISABLED; /** - * The property key to get the pressed text color of the detailed icon of check button + * The property key to get the pressed text color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the detailed icon of check button + * The property key to get the highlighted text color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_TEXT_HIGHLIGHTED; /** - * The property key to get the aselected text color of the detailed icon of check button + * The property key to get the selected text color of the detailed icon of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DETAILED_ICON_TEXT_SELECTED; /** - * The property key to get the color of the left divider line of check button + * The property key to get the color of the left divider line of check button. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_LEFT_NORMAL; /** - * The property key to get the color of the right divider line of check button + * The property key to get the color of the right divider line of check button. * * @since 2.1 */ @@ -284,56 +284,56 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ ColorPicker { /** - * The property key to get the color of top half part of divider of color picker + * The property key to get the color of top half part of divider of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_TOP_HALF; /** - * The property key to get the color of bottom half part of divider of color picker + * The property key to get the color of bottom half part of divider of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_BOTTOM_HALF; /** - * The property key to get the normal background color of the arrow of color picker + * The property key to get the normal background color of the arrow button of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int ARROW_BUTTON_BG_NORMAL; /** - * The property key to get the pressed background color of the arrow of color picker + * The property key to get the pressed background color of the arrow button of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int ARROW_BUTTON_BG_PRESSED; /** - * The property key to get the disabled background color of the arrow of color picker + * The property key to get the disabled background color of the arrow button of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int ARROW_BUTTON_BG_DISABLED; /** - * The property key to get the normal color of the arrow button of color picker + * The property key to get the normal color of the arrow button of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int ARROW_BUTTON_NORMAL; /** - * The property key to get the pressed color of the arrow button of color picker + * The property key to get the pressed color of the arrow button of color picker. * * @since 2.1 */ _OSP_EXPORT_ static const int ARROW_BUTTON_PRESSED; /** - * The property key to get the disabled color of the arrow button of color picker + * The property key to get the disabled color of the arrow button of color picker. * * @since 2.1 */ @@ -343,77 +343,77 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ ContextMenu { /** - * The property key to get the normal background color of context menu + * The property key to get the normal background color of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the color of list type divider 01 of context menu + * The property key to get the color of list type divider 01 of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int LIST_ITEM_DIVIDER_01_NORMAL; /** - * The property key to get the color of list type divider 02 of context menu + * The property key to get the color of list type divider 02 of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int LIST_ITEM_DIVIDER_02_NORMAL; /** - * The property key to get the normal background color of the item of context menu + * The property key to get the normal background color of the item of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_NORMAL; /** - * The property key to get the pressed background color of the item of context menu + * The property key to get the pressed background color of the item of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the item of context menu + * The property key to get the highlighted background color of the item of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_HIGHLIGHTED; /** - * The property key to get the color of grid type divider 01 of context menu + * The property key to get the color of grid type divider 01 of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int GRID_ITEM_DIVIDER_01_NORMAL; /** - * The property key to get the color of grid type divider 02 of context menu + * The property key to get the color of grid type divider 02 of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int GRID_ITEM_DIVIDER_02_NORMAL; /** - * The property key to get the normal text color of the item of context menu + * The property key to get the normal text color of the item of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_NORMAL; /** - * The property key to get the pressed text color of the item of context menu + * The property key to get the pressed text color of the item of context menu. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the item of context menu + * The property key to get the highlighted text color of the item of context menu. * * @since 2.1 */ @@ -423,21 +423,21 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ DateTimeBar { /** - * The property key to get the background color of date time bar + * The property key to get the background color of date time bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the normal text color of date time bar + * The property key to get the normal text color of date time bar. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed text color of date time bar + * The property key to get the pressed text color of date time bar. * * @since 2.1 */ @@ -446,105 +446,105 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ DateTimePicker { /** - * The property key to get the background color of date time picker + * The property key to get the background color of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the normal background color of button of date time picker + * The property key to get the normal background color of button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_BG_NORMAL; /** - * The property key to get the pressed background color of AM/PM button of date time picker + * The property key to get the pressed background color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_BG_PRESSED; /** - * The property key to get the highlighted background color of AM/PM button of date time picker + * The property key to get the highlighted background color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_BG_HIGHLIGHTED; /** - * The property key to get the disabled background color of AM/PM button of date time picker + * The property key to get the disabled background color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_BG_DISABLED; /** - * The property key to get the normal text color of date time picker + * The property key to get the normal text color of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed text color of date time picker + * The property key to get the pressed text color of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the highlighted text color of date time picker + * The property key to get the highlighted text color of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_HIGHLIGHTED; /** - * The property key to get the disabled text color of date time picker + * The property key to get the disabled text color of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the normal text color of AM/PM button of date time picker + * The property key to get the normal text color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_TEXT_NORMAL; /** - * The property key to get the pressed text color of AM/PM button of date time picker + * The property key to get the pressed text color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of AM/PM button of date time picker + * The property key to get the highlighted text color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_TEXT_HIGHLIGHTED; /** - * The property key to get the disabled text color of AM/PM button of date time picker + * The property key to get the disabled text color of AM/PM button of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int AM_PM_TEXT_DISABLED; /** - * The property key to get the color of the left half of the divider of date time picker + * The property key to get the color of the left half of the divider of date time picker. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LEFT_HALF; /** - * The property key to get the color of the right half of the divider of date time picker + * The property key to get the color of the right half of the divider of date time picker. * * @since 2.1 */ @@ -602,126 +602,126 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Edit { /** - * The property key to get the normal background color of edit + * The property key to get the normal background color of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the pressed background color of edit + * The property key to get the pressed background color of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_PRESSED; /** - * The property key to get the highlighted background color of edit + * The property key to get the highlighted background color of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_HIGHLIGHTED; /** - * The property key to get the disabled background color of edit + * The property key to get the disabled background color of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_DISABLED; /** - * The property key to get the normal text color of the title text of edit + * The property key to get the normal text color of the title text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the pressed color of the title text of edit + * The property key to get the pressed color of the title text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_PRESSED; /** - * The property key to get the highlighted color of the title text of edit + * The property key to get the highlighted color of the title text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_HIGHLIGHTED; /** - * The property key to get the disabled color of the title text of edit + * The property key to get the disabled color of the title text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_DISABLED; /** - * The property key to get the normal color of the text of edit + * The property key to get the normal color of the text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed color of the text of edit + * The property key to get the pressed color of the text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the highlighted color of the text of edit + * The property key to get the highlighted color of the text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_HIGHLIGHTED; /** - * The property key to get the disabled color of the text of edit + * The property key to get the disabled color of the text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the color of the guide text of edit + * The property key to get the color of the guide text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int GUIDE_TEXT_NORMAL; /** - * The property key to get the normal color of the clear icon of edit + * The property key to get the normal color of the clear icon of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int CLEAR_ICON_NORMAL; /** - * The property key to get the pressed color of the clear icon of edit + * The property key to get the pressed color of the clear icon of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int CLEAR_ICON_PRESSED; /** - * The property key to get the color of the cut link text of edit + * The property key to get the color of the cut link text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int CUT_LINK_TEXT_NORMAL; /** - * The property key to get the background color of the cut link text of edit + * The property key to get the background color of the cut link text of edit. * * @since 2.1 */ _OSP_EXPORT_ static const int CUT_LINK_BG_NORMAL; /** - * The property key to get the color of the cursor of edit + * The property key to get the color of the cursor of edit. * * @since 2.1 */ @@ -731,49 +731,49 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ EditDate { /** - * The property key to get the normal color of the text of edit date + * The property key to get the normal color of the text of edit date. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed color of the text of edit date + * The property key to get the pressed color of the text of edit date. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the disabled color of the text of edit date + * The property key to get the disabled color of the text of edit date. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the normal color of the title text of edit date + * The property key to get the normal color of the title text of edit date. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the disabled color of the title text of edit date + * The property key to get the disabled color of the title text of edit date. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_DISABLED; /** - * The property key to get the color of the left half divider of edit date + * The property key to get the color of the left half divider of edit date. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_HALF_LEFT; /** - * The property key to get the color of the right half divider of edit date + * The property key to get the color of the right half divider of edit date. * * @since 2.1 */ @@ -811,77 +811,77 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ EditTime { /** - * The property key to get the normal background color of the button of edit time + * The property key to get the normal background color of the button of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_NORMAL; /** - * The property key to get the pressed background color of the button of edit time + * The property key to get the pressed background color of the button of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_PRESSED; /** - * The property key to get the disabled background color of the button of edit time + * The property key to get the disabled background color of the button of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_DISABLED; /** - * The property key to get the normal text color of the button of edit time + * The property key to get the normal text color of the button of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_NORMAL; /** - * The property key to get the pressed text color of the button of edit time + * The property key to get the pressed text color of the button of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_PRESSED; /** - * The property key to get the disabled text color of the button of edit time + * The property key to get the disabled text color of the button of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_DISABLED; /** - * The property key to get the normal text color of edit time + * The property key to get the normal text color of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed text color of edit time + * The property key to get the pressed text color of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the disabled text color of edit time + * The property key to get the disabled text color of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the normal title text color of edit time + * The property key to get the normal title text color of edit time. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the disabled title text color of edit time + * The property key to get the disabled title text color of edit time. * * @since 2.1 */ @@ -926,56 +926,56 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ FastScroll { /** - * The property key to get the normal background color of fast scroll index + * The property key to get the normal background color of fast scroll index. * * @since 2.1 */ _OSP_EXPORT_ static const int INDEX_BG_NORMAL; /** - * The property key to get the pressed background color of fast scroll index + * The property key to get the pressed background color of fast scroll index. * * @since 2.1 */ _OSP_EXPORT_ static const int INDEX_BG_PRESSED; /** - * The property key to get the color of the line of fast scroll index + * The property key to get the color of the line of fast scroll index. * * @since 2.1 */ _OSP_EXPORT_ static const int INDEX_LINE_PRESSED; /** - * The property key to get the normal text color of fast scroll index + * The property key to get the normal text color of fast scroll index. * * @since 2.1 */ _OSP_EXPORT_ static const int INDEX_TEXT_NORMAL; /** - * The property key to get the pressed text color of fast scroll index + * The property key to get the pressed text color of fast scroll index. * * @since 2.1 */ _OSP_EXPORT_ static const int INDEX_TEXT_PRESSED; /** - * The property key to get the color of the divider of fast scroll index + * The property key to get the color of the divider of fast scroll index. * * @since 2.1 */ _OSP_EXPORT_ static const int INDEX_DIVIDER_NORMAL; /** - * The property key to get the background color of the popup of fast scroll + * The property key to get the background color of the popup of fast scroll. * * @since 2.1 */ _OSP_EXPORT_ static const int POPUP_BG_NORMAL; /** - * The property key to get the text color of the popup of fast scroll + * The property key to get the text color of the popup of fast scroll. * * @since 2.1 */ @@ -985,574 +985,574 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Footer { /** - * The property key to get the background color of footer + * The property key to get the background color of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the background color of the translucent style of footer + * The property key to get the background color of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TRANSLUCENT_BG_NORMAL; /** - * The property key to get the normal background color of the button style of footer + * The property key to get the normal background color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_NORMAL; /** - * The property key to get the disabled background color of the button style of footer + * The property key to get the disabled background color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_DISABLED; /** - * The property key to get the pressed background color of the button style of footer + * The property key to get the pressed background color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_PRESSED; /** - * The property key to get the highlighted background color of the button style of footer + * The property key to get the highlighted background color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_HIGHLIGHTED; /** - * The property key to get the normal background color of the translucent style button of footer + * The property key to get the normal background color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the translucent style button of footer + * The property key to get the disabled background color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the translucent style button of footer + * The property key to get the pressed background color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the translucent style button of footer + * The property key to get the highlighted background color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the normal text color of the button style of footer + * The property key to get the normal text color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_NORMAL; /** - * The property key to get the disabled text color of the button style of footer + * The property key to get the disabled text color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_DISABLED; /** - * The property key to get the pressed text color of the button style of footer + * The property key to get the pressed text color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the button style of footer + * The property key to get the highlighted text color of the button style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_HIGHLIGHTED; /** - * The property key to get the normal text color of the translucent style button of footer + * The property key to get the normal text color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the translucent style button of footer + * The property key to get the disabled text color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the translucent style button of footer + * The property key to get the pressed text color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the translucent style button of footer + * The property key to get the highlighted text color of the translucent style button of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the normal background color of the segmented item of footer + * The property key to get the normal background color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_NORMAL; /** - * The property key to get the disabled background color of the segmented item of footer + * The property key to get the disabled background color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_DISABLED; /** - * The property key to get the pressed background color of the segmented item of footer + * The property key to get the pressed background color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the segmented item of footer + * The property key to get the highlighted background color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the segmented item of footer + * The property key to get the selected background color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_SELECTED; /** - * The property key to get the normal background color of the segmented item of the translucent style of footer + * The property key to get the normal background color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the segmented item of the translucent style of footer + * The property key to get the disabled background color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the segmented item of the translucent style of footer + * The property key to get the pressed background color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the segmented item of the translucent style of footer + * The property key to get the highlighted background color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the segmented item of the translucent style of footer + * The property key to get the selected background color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_SELECTED; /** - * The property key to get the normal text color of the segmented item of footer + * The property key to get the normal text color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_NORMAL; /** - * The property key to get the disabled text color of the segmented item of footer + * The property key to get the disabled text color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_DISABLED; /** - * The property key to get the pressed text color of the segmented item of footer + * The property key to get the pressed text color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the segmented item of footer + * The property key to get the highlighted text color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the segmented item of footer + * The property key to get the selected text color of the segmented item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_SELECTED; /** - * The property key to get the normal text color of the segmented item of the translucent style of footer + * The property key to get the normal text color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the segmented item of the translucent style of footer + * The property key to get the disabled text color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the segmented item of the translucent style of footer + * The property key to get the pressed text color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the segmented item of the translucent style of footer + * The property key to get the highlighted text color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the segmented item of the translucent style of footer + * The property key to get the selected text color of the segmented item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_SELECTED; /** - * The property key to get the normal background color of the tab item of footer + * The property key to get the normal background color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_NORMAL; /** - * The property key to get the disabled background color of the tab item of footer + * The property key to get the disabled background color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_DISABLED; /** - * The property key to get the pressed background color of the tab item of footer + * The property key to get the pressed background color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the tab item of footer + * The property key to get the highlighted background color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the tab item of footer + * The property key to get the selected background color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_SELECTED; /** - * The property key to get the normal background color of the tab item of the translucent style of footer + * The property key to get the normal background color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the tab item of the translucent style of footer + * The property key to get the disabled background color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the tab item of the translucent style of footer + * The property key to get the pressed background color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the tab item of the translucent style of footer + * The property key to get the highlighted background color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the tab item of the translucent style of footer + * The property key to get the selected background color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_SELECTED; /** - * The property key to get the normal text color of the tab item of footer + * The property key to get the normal text color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_NORMAL; /** - * The property key to get the disabled text color of the tab item of footer + * The property key to get the disabled text color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_DISABLED; /** - * The property key to get the pressed text color of the tab item of footer + * The property key to get the pressed text color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the tab item of footer + * The property key to get the highlighted text color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the tab item of footer + * The property key to get the selected text color of the tab item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_SELECTED; /** - * The property key to get the normal text color of the tab item of the translucent style of footer + * The property key to get the normal text color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the tab item of the translucent style of footer + * The property key to get the disabled text color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the tab item of the translucent style of footer + * The property key to get the pressed text color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the tab item of the translucent style of footer + * The property key to get the highlighted text color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the tab item of the translucent style of footer + * The property key to get the selected text color of the tab item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_SELECTED; /** - * The property key to get the normal background color of the button item of footer + * The property key to get the normal background color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_NORMAL; /** - * The property key to get the disabled background color of the button item of footer + * The property key to get the disabled background color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_DISABLED; /** - * The property key to get the pressed background color of the button item of footer + * The property key to get the pressed background color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the button item of footer + * The property key to get the highlighted background color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_HIGHLIGHTED; /** - * The property key to get the normal background color of the button item of the translucent style of footer + * The property key to get the normal background color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the button item of the translucent style of footer + * The property key to get the disabled background color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the button item of the translucent style of footer + * The property key to get the pressed background color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the button item of the translucent style of footer + * The property key to get the highlighted background color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the normal text color of the button item of footer + * The property key to get the normal text color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TEXT_NORMAL; /** - * The property key to get the disabled text color of the button item of footer + * The property key to get the disabled text color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TEXT_DISABLED; /** - * The property key to get the pressed text color of the button item of footer + * The property key to get the pressed text color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the button item of footer + * The property key to get the highlighted text color of the button item of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the normal text color of the button item of the translucent style of footer + * The property key to get the normal text color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the button item of the translucent style of footer + * The property key to get the disabled text color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the button item of the translucent style of footer + * The property key to get the pressed text color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the button item of the translucent style of footer + * The property key to get the highlighted text color of the button item of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the normal color of the back icon of footer + * The property key to get the normal color of the back icon of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BACK_ICON_NORMAL; /** - * The property key to get the disabled color of the back icon of footer + * The property key to get the disabled color of the back icon of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BACK_ICON_DISABLED; /** - * The property key to get the pressed color of the back icon of footer + * The property key to get the pressed color of the back icon of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BACK_ICON_PRESSED; /** - * The property key to get the highlighted color of the back icon of footer + * The property key to get the highlighted color of the back icon of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int BACK_ICON_HIGHLIGHTED; /** - * The property key to get the color of the left divider line of footer + * The property key to get the color of the left divider line of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_LEFT_NORMAL; /** - * The property key to get the color of the right divider line of footer + * The property key to get the color of the right divider line of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_RIGHT_NORMAL; /** - * The property key to get the color of the left divider line of the translucent style of footer + * The property key to get the color of the left divider line of the translucent style of footer. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_LEFT_TRANSLUCENT_NORMAL; /** - * The property key to get the color of the right divider line of the translucent style of footer + * The property key to get the color of the right divider line of the translucent style of footer. * * @since 2.1 */ @@ -1562,7 +1562,7 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Form { /** - * The property key to get the background color of form + * The property key to get the background color of form. * * @since 2.1 */ @@ -1572,7 +1572,7 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Gallery { /** - * The property key to get the empty text color of gallery + * The property key to get the empty text color of gallery. * * @since 2.1 */ @@ -1582,546 +1582,546 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Header { /** - * The property key to get the background of header + * The property key to get the background of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the background of the translucent style of header + * The property key to get the background of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TRANSLUCENT_BG_NORMAL; /** - * The property key to get the color of the title text of header + * The property key to get the color of the title text of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the color of the title text of translucent style of header + * The property key to get the color of the title text of translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TRANSLUCENT_TITLE_TEXT_NORMAL; /** - * The property key to get the color of the description text of header + * The property key to get the color of the description text of header. * * @since 2.1 */ _OSP_EXPORT_ static const int DESCRIPTION_TEXT_NORMAL; /** - * The property key to get the color of the description text of the translucent style of header + * The property key to get the color of the description text of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TRANSLUCENT_DESCRIPTION_TEXT_NORMAL; /** - * The property key to get the normal background color of the button of header + * The property key to get the normal background color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_NORMAL; /** - * The property key to get the disabled background color of the button of header + * The property key to get the disabled background color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_DISABLED; /** - * The property key to get the pressed background color of the button of header + * The property key to get the pressed background color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_PRESSED; /** - * The property key to get the highlighted background color of the button of header + * The property key to get the highlighted background color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_HIGHLIGHTED; /** - * The property key to get the normal background color of the button of the translucent style of header + * The property key to get the normal background color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the button of the translucent style of header + * The property key to get the disabled background color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the button of the translucent style of header + * The property key to get the pressed background color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the button of the translucent style of header + * The property key to get the highlighted background color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the normal text color of the button of header + * The property key to get the normal text color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_NORMAL; /** - * The property key to get the disabled text color of the button of header + * The property key to get the disabled text color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_DISABLED; /** - * The property key to get the pressed text color of the button of header + * The property key to get the pressed text color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the button of header + * The property key to get the highlighted text color of the button of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_HIGHLIGHTED; /** - * The property key to get the normal text color of the button of the translucent style of header + * The property key to get the normal text color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the button of the translucent style of header + * The property key to get the disabled text color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the button of the translucent style of header + * The property key to get the pressed text color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the button of the translucent style of header + * The property key to get the highlighted text color of the button of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the normal background color of the segmented item of header + * The property key to get the normal background color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_NORMAL; /** - * The property key to get the disabled background color of the segmented item of header + * The property key to get the disabled background color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_DISABLED; /** - * The property key to get the pressed background color of the segmented item of header + * The property key to get the pressed background color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the segmented item of header + * The property key to get the highlighted background color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the segmented item of header + * The property key to get the selected background color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_BG_SELECTED; /** - * The property key to get the normal background color of the segmented item of the translucent style of header + * The property key to get the normal background color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the segmented item of the translucent style of header + * The property key to get the disabled background color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the segmented item of the translucent style of header + * The property key to get the pressed background color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the segmented item of the translucent style of header + * The property key to get the highlighted background color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the segmented item of the translucent style of header + * The property key to get the selected background color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_BG_SELECTED; /** - * The property key to get the normal text color of the segmented item of header + * The property key to get the normal text color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_NORMAL; /** - * The property key to get the disabled text color of the segmented item of header + * The property key to get the disabled text color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_DISABLED; /** - * The property key to get the pressed text color of the segmented item of header + * The property key to get the pressed text color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the segmented item of header + * The property key to get the highlighted text color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the segmented item of header + * The property key to get the selected text color of the segmented item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TEXT_SELECTED; /** - * The property key to get the normal text color of the segmented item of the translucent style of header + * The property key to get the normal text color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the segmented item of the translucent style of header + * The property key to get the disabled text color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the segmented item of the translucent style of header + * The property key to get the pressed text color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the segmented item of the translucent style of header + * The property key to get the highlighted text color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the segmented item of the translucent style of header + * The property key to get the selected text color of the segmented item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int SEGMENTED_ITEM_TRANSLUCENT_TEXT_SELECTED; /** - * The property key to get the normal background color of the tab item of header + * The property key to get the normal background color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_NORMAL; /** - * The property key to get the disabled background color of the tab item of header + * The property key to get the disabled background color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_DISABLED; /** - * The property key to get the pressed background color of the tab item of header + * The property key to get the pressed background color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the tab item of header + * The property key to get the highlighted background color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the tab item of header + * The property key to get the selected background color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_BG_SELECTED; /** - * The property key to get the normal background color of the tab item of the translucent style of header + * The property key to get the normal background color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_NORMAL; /** - * The property key to get the disabled background color of the tab item of the translucent style of header + * The property key to get the disabled background color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_DISABLED; /** - * The property key to get the pressed background color of the tab item of the translucent style of header + * The property key to get the pressed background color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_PRESSED; /** - * The property key to get the highlighted background color of the tab item of the translucent style of header + * The property key to get the highlighted background color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_HIGHLIGHTED; /** - * The property key to get the selected background color of the tab item of the translucent style of header + * The property key to get the selected background color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_BG_SELECTED; /** - * The property key to get the normal text color of the tab item of header + * The property key to get the normal text color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_NORMAL; /** - * The property key to get the disabled text color of the tab item of header + * The property key to get the disabled text color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_DISABLED; /** - * The property key to get the pressed text color of the tab item of header + * The property key to get the pressed text color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the tab item of header + * The property key to get the highlighted text color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the tab item of header + * The property key to get the selected text color of the tab item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TEXT_SELECTED; /** - * The property key to get the normal text color of the tab item of the translucent style of header + * The property key to get the normal text color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the tab item of the translucent style of header + * The property key to get the disabled text color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_DISABLED; /** - * The property key to get the pressed text color of the tab item of the translucent style of header + * The property key to get the pressed text color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the tab item of the translucent style of header + * The property key to get the highlighted text color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_HIGHLIGHTED; /** - * The property key to get the selected text color of the tab item of the translucent style of header + * The property key to get the selected text color of the tab item of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int TAB_ITEM_TRANSLUCENT_TEXT_SELECTED; /** - * The property key to get the normal background color of badge icon of header + * The property key to get the normal background color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_BG_NORMAL; /** - * The property key to get the disabled background color of badge icon of header + * The property key to get the disabled background color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_BG_DISABLED; /** - * The property key to get the pressed background color of badge icon of header + * The property key to get the pressed background color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_BG_PRESSED; /** - * The property key to get the highlighted background color of badge icon of header + * The property key to get the highlighted background color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_BG_HIGHLIGHTED; /** - * The property key to get the normal text color of badge icon of header + * The property key to get the normal text color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_TEXT_NORMAL; /** - * The property key to get the disabled text color of badge icon of header + * The property key to get the disabled text color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_TEXT_DISABLED; /** - * The property key to get the pressed text color of badge icon of header + * The property key to get the pressed text color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_TEXT_PRESSED; /** - * The property key to get the highlighted text color of badge icon of header + * The property key to get the highlighted text color of badge icon of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BADGE_ICON_TEXT_HIGHLIGHTED; /** - * The property key to get the color of the left divider line of header + * The property key to get the color of the left divider line of header. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_LEFT_NORMAL; /** - * The property key to get the color of the right divider line of header + * The property key to get the color of the right divider line of header. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_RIGHT_NORMAL; /** - * The property key to get the color of the left divider line of the translucent style of header + * The property key to get the color of the left divider line of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_LEFT_TRANSLUCENT_NORMAL; /** - * The property key to get the color of the right divider line of the translucent style of header + * The property key to get the color of the right divider line of the translucent style of header. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_LINE_RIGHT_TRANSLUCENT_NORMAL; /** - * The property key to get the normal background color of the button item of header + * The property key to get the normal background color of the button item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_NORMAL; /** - * The property key to get the disabled background color of the button item of header + * The property key to get the disabled background color of the button item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_DISABLED; /** - * The property key to get the pressed background color of the button item of header + * The property key to get the pressed background color of the button item of header. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the button item of header + * The property key to get the highlighted background color of the button item of header. * * @since 2.1 */ @@ -2215,84 +2215,84 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ IconList { /** - * The property key to get the empty text color of icon list + * The property key to get the empty text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int EMPTY_TEXT_NORMAL; /** - * The property key to get the normal text color of icon list + * The property key to get the normal text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed text color of icon list + * The property key to get the pressed text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the highlighted text color of icon list + * The property key to get the highlighted text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_HIGHLIGHTED; /** - * The property key to get the inner normal text color of icon list + * The property key to get the inner normal text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int INNER_TEXT_NORMAL; /** - * The property key to get the inner pressed text color of icon list + * The property key to get the inner pressed text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int INNER_TEXT_PRESSED; /** - * The property key to get the inner highlighted text color of icon list + * The property key to get the inner highlighted text color of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int INNER_TEXT_HIGHLIGHTED; /** - * The property key to get the background color of innex text area of icon list + * The property key to get the background color of inner text area of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int INNER_TEXT_BG_NORMAL; /** - * The property key to get the pressed background color of the item of icon list + * The property key to get the pressed background color of the item of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_PRESSED; /** - * The property key to get the normal border color of the item of icon list + * The property key to get the normal border color of the item of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BORDER_NORMAL; /** - * The property key to get the pressed border color of the item of icon list + * The property key to get the pressed border color of the item of icon list. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BORDER_PRESSED; /** - * The property key to get the highlighted border color of the item of icon list + * The property key to get the highlighted border color of the item of icon list. * * @since 2.1 */ @@ -2302,63 +2302,63 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ InputPad { /** - * The property key to get the normal text color of input pad + * The property key to get the normal text color of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the pressed text color of input pad + * The property key to get the pressed text color of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_PRESSED; /** - * The property key to get the highlighted text color of input pad + * The property key to get the highlighted text color of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_HIGHLIGHTED; /** - * The property key to get the disabled text color of input pad + * The property key to get the disabled text color of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_DISABLED; /** - * The property key to get the guide text color of input pad + * The property key to get the guide text color of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int GUIDE_TEXT_NORMAL; /** - * The property key to get the normal background color of the button of input pad + * The property key to get the normal background color of the button of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_NORMAL; /** - * The property key to get the pressed background color of the button of input pad + * The property key to get the pressed background color of the button of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_PRESSED; /** - * The property key to get the highlighted background color of the button of input pad + * The property key to get the highlighted background color of the button of input pad. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_HIGHLIGHTED; /** - * The property key to get the disabled background color of the button of input pad + * The property key to get the disabled background color of the button of input pad. * * @since 2.1 */ @@ -2368,7 +2368,7 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Label { /** - * The property key to get the text color of label + * The property key to get the text color of label. * * @since 2.1 */ @@ -2378,21 +2378,21 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ MessageBox { /** - * The property key to get the background color of messagebox + * The property key to get the background color of messagebox. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the color of the title text of messagebox + * The property key to get the color of the title text of messagebox. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the color of the text of messagebox + * The property key to get the color of the text of messagebox. * * @since 2.1 */ @@ -2402,7 +2402,7 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Panel { /** - * The property key to get the background color of grouped style of panel + * The property key to get the background color of grouped style of panel. * * @since 2.1 */ @@ -2412,14 +2412,14 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Popup { /** - * The property key to get the background color of popup + * The property key to get the background color of popup. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the color of the title text of popup + * The property key to get the color of the title text of popup. * * @since 2.1 */ @@ -2429,14 +2429,14 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Progress { /** - * The property key to get the background color of the bar of progress + * The property key to get the background color of the bar of progress. * * @since 2.1 */ _OSP_EXPORT_ static const int BAR_BG_NORMAL; /** - * The property key to get the background color of progress + * The property key to get the background color of progress. * * @since 2.1 */ @@ -2446,21 +2446,21 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Scroll { /** - * The property key to get the background color of thumb of scroll + * The property key to get the background color of thumb of scroll. * * @since 2.1 */ _OSP_EXPORT_ static const int THUMB_BG_NORMAL; /** - * The property key to get the normal color of the jump-to-top button of scroll + * The property key to get the normal color of the jump-to-top button of scroll. * * @since 2.1 */ _OSP_EXPORT_ static const int JUMP_TO_TOP_NORMAL; /** - * The property key to get the pressed color of the jump-to-top button of scroll + * The property key to get the pressed color of the jump-to-top button of scroll. * * @since 2.1 */ @@ -2474,7 +2474,7 @@ struct _OSP_EXPORT_ ColorKey _OSP_EXPORT_ static const int BUTTON_BG_NORMAL; /** - * The property key to get the pressed background color of the button of scroll + * The property key to get the pressed background color of the button of scroll. * * @since 2.1 */ @@ -2484,112 +2484,112 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ SearchBar { /** - * The property key to get the normal background color of the button of search bar + * The property key to get the normal background color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_NORMAL; /** - * The property key to get the pressed background color of the button of search bar + * The property key to get the pressed background color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_PRESSED; /** - * The property key to get the disabled background color of the button of search bar + * The property key to get the disabled background color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_DISABLED; /** - * The property key to get the highlighted background color of the button of search bar + * The property key to get the highlighted background color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_BG_HIGHLIGHTED; /** - * The property key to get the normal text color of the button of search bar + * The property key to get the normal text color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_NORMAL; /** - * The property key to get the pressed text color of the button of search bar + * The property key to get the pressed text color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_PRESSED; /** - * The property key to get the disabled text color of the button of search bar + * The property key to get the disabled text color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_DISABLED; /** - * The property key to get the highlighted text color of the button of search bar + * The property key to get the highlighted text color of the button of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BUTTON_TEXT_HIGHLIGHTED; /** - * The property key to get the normal background color of the edit of search bar + * The property key to get the normal background color of the edit of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int EDIT_BG_NORMAL; /** - * The property key to get the disabled background color of the edit of search bar + * The property key to get the disabled background color of the edit of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int EDIT_BG_DISABLED; /** - * The property key to get the normal text color of the edit of search bar + * The property key to get the normal text color of the edit of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int EDIT_TEXT_NORMAL; /** - * The property key to get the disabled text color of the edit of search bar + * The property key to get the disabled text color of the edit of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int EDIT_TEXT_DISABLED; /** - * The property key to get the highlighted text color of the edit of search bar + * The property key to get the highlighted text color of the edit of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int EDIT_TEXT_HIGHLIGHTED; /** - * The property key to get the normal background color of the icon of search bar + * The property key to get the normal background color of the icon of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ICON_BG_NORMAL; /** - * The property key to get the disabled background color of the icon of search bar + * The property key to get the disabled background color of the icon of search bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ICON_BG_DISABLED; /** - * The property key to get the background color of the content area of search bar + * The property key to get the background color of the content area of search bar. * * @since 2.1 */ @@ -2599,91 +2599,91 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ Slider { /** - * The property key to get the background color of the others style of slider + * The property key to get the background color of the others style of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_OTHERS_NORMAL; /** - * The property key to get the background color of the default style of slider + * The property key to get the background color of the default style of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_DEFAULT_NORMAL; /** - * The property key to get the background color of the bar of slider + * The property key to get the background color of the bar of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int BAR_BG_NORMAL; /** - * The property key to get the color of the bar of slider + * The property key to get the color of the bar of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int BAR_NORMAL; /** - * The property key to get the normal background color of the handle of slider + * The property key to get the normal background color of the handle of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int HANDLE_BG_NORMAL; /** - * The property key to get the pressed background color of the handle of slider + * The property key to get the pressed background color of the handle of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int HANDLE_BG_PRESSED; /** - * The property key to get the disabled background color of the handle of slider + * The property key to get the disabled background color of the handle of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int HANDLE_BG_DISABLED; /** - * The property key to get the highlighted background color of the handle of slider + * The property key to get the highlighted background color of the handle of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int HANDLE_BG_HIGHLIGHTED; /** - * The property key to get the normal text color of the handle of slider + * The property key to get the normal text color of the handle of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int HANDLE_NUMBER_TEXT_NORMAL; /** - * The property key to get the disabled text color of the handle of slider + * The property key to get the disabled text color of the handle of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int HANDLE_NUMBER_TEXT_DISABLED; /** - * The property key to get the color of the title text of slider + * The property key to get the color of the title text of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int TITLE_TEXT_NORMAL; /** - * The property key to get the background color of the overlay of slider + * The property key to get the background color of the overlay of slider. * * @since 2.1 */ _OSP_EXPORT_ static const int OVERLAY_BG_NORMAL; /** - * The property key to get the text color of the overlay of slider + * The property key to get the text color of the overlay of slider. * * @since 2.1 */ @@ -2693,14 +2693,14 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ SplitPanel { /** - * The property key to get the normal color of the divider of split panel + * The property key to get the normal color of the divider of split panel. * * @since 2.1 */ _OSP_EXPORT_ static const int DIVIDER_BG_NORMAL; /** - * The property key to get the pressed color of the divider of split panel + * The property key to get the pressed color of the divider of split panel. * * @since 2.1 */ @@ -2710,129 +2710,129 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ TabBar { /** - * The property key to get the background color of tab bar + * The property key to get the background color of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the normal background color of the item of tab bar + * The property key to get the normal background color of the item of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_NORMAL; /** - * The property key to get the pressed background color of the item of tab bar + * The property key to get the pressed background color of the item of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_PRESSED; /** - * The property key to get the selected background color of the item of tab bar + * The property key to get the selected background color of the item of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_SELECTED; /** - * The property key to get the normal text color of the item of tab bar + * The property key to get the normal text color of the item of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_NORMAL; /** - * The property key to get the pressed text color of the item of tab bar + * The property key to get the pressed text color of the item of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_PRESSED; /** - * The property key to get the selected text color of the item of tab bar + * The property key to get the selected text color of the item of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_SELECTED; /** - * The property key to get the background color of the arrow of tab bar + * The property key to get the background color of the arrow of tab bar. * * @since 2.1 */ _OSP_EXPORT_ static const int ARROW_BG_NORMAL; }; - + struct _OSP_EXPORT_ Tab { /** - * The property key to get the normal background color of the item of tab + * The property key to get the normal background color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_NORMAL; /** - * The property key to get the pressed background color of the item of tab + * The property key to get the pressed background color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_PRESSED; /** - * The property key to get the selected background color of the item of tab + * The property key to get the selected background color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_SELECTED; /** - * The property key to get the highlighted background color of the item of tab + * The property key to get the highlighted background color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_HIGHLIGHTED; /** - * The property key to get the disabled background color of the item of tab + * The property key to get the disabled background color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_DISABLED; /** - * The property key to get the normal text color of the item of tab + * The property key to get the normal text color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_NORMAL; /** - * The property key to get the pressed text color of the item of tab + * The property key to get the pressed text color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_PRESSED; /** - * The property key to get the selected text color of the item of tab + * The property key to get the selected text color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_SELECTED; /** - * The property key to get the highlighted text color of the item of tab + * The property key to get the highlighted text color of the item of tab. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the disabled text color of the item of tab + * The property key to get the disabled text color of the item of tab. * * @since 2.1 */ @@ -2842,217 +2842,217 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ TableView { /** - * The property key to get the background color of table view + * The property key to get the background color of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the color of top divider of table view + * The property key to get the color of top divider of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_DIVIDER_TOP_BG_NORMAL; /** - * The property key to get the color of bottom divider of table view + * The property key to get the color of bottom divider of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_DIVIDER_BOTTOM_BG_NORMAL; /** - * The property key to get the normal background color of the item of table view + * The property key to get the normal background color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_NORMAL; /** - * The property key to get the pressed background color of the item of table view + * The property key to get the pressed background color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_PRESSED; /** - * The property key to get the highlighted background color of the item of table view + * The property key to get the highlighted background color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_HIGHLIGHTED; /** - * The property key to get the disabled background color of the item of table view + * The property key to get the disabled background color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_BG_DISABLED; /** - * The property key to get the normal text color of the item of table view + * The property key to get the normal text color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_NORMAL; /** - * The property key to get the pressed text color of the item of table view + * The property key to get the pressed text color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the item of table view + * The property key to get the highlighted text color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the disabled text color of the item of table view + * The property key to get the disabled text color of the item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_TEXT_DISABLED; /** - * The property key to get the color of the description text of table view + * The property key to get the color of the description text of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_DESCRIPTION_TEXT_NORMAL; /** - * The property key to get the normal color of the annex of table view + * The property key to get the normal color of the annex of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_ANNEX_DETAIL_NORMAL; /** - * The property key to get the pressed color of the annex of table view + * The property key to get the pressed color of the annex of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_ANNEX_DETAIL_PRESSED; /** - * The property key to get the highlighted color of the annex of table view + * The property key to get the highlighted color of the annex of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_ANNEX_DETAIL_HIGHLIGHTED; /** - * The property key to get the normal background color of the annex of table view + * The property key to get the normal background color of the annex of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_ANNEX_DETAIL_BG_NORMAL; /** - * The property key to get the pressed background color of the annex of table view + * The property key to get the pressed background color of the annex of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_ANNEX_DETAIL_BG_PRESSED; /** - * The property key to get the highlighted background color of the annex of table view + * The property key to get the highlighted background color of the annex of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int ITEM_ANNEX_DETAIL_BG_HIGHLIGHTED; /** - * The property key to get the background color of the group item of table view + * The property key to get the background color of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_BG_NORMAL; /** - * The property key to get the normal text color of the group item of table view + * The property key to get the normal text color of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_TEXT_NORMAL; /** - * The property key to get the pressed text color of the group item of table view + * The property key to get the pressed text color of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_TEXT_PRESSED; /** - * The property key to get the highlighted text color of the group item of table view + * The property key to get the highlighted text color of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_TEXT_HIGHLIGHTED; /** - * The property key to get the normal color of the index bar of the group item of table view + * The property key to get the normal color of the index bar of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_INDEX_BAR_NORMAL; /** - * The property key to get the pressed color of the index bar of the group item of table view + * The property key to get the pressed color of the index bar of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_INDEX_BAR_PRESSED; /** - * The property key to get the highlighted color of the index bar of the group item of table view + * The property key to get the highlighted color of the index bar of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_INDEX_BAR_HIGHLIGHTED; /** - * The property key to get the normal color of the bar of the group item of table view + * The property key to get the normal color of the bar of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_BAR_NORMAL; /** - * The property key to get the pressed color of the bar of the group item of table view + * The property key to get the pressed color of the bar of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_BAR_PRESSED; /** - * The property key to get the highlighted color of the bar of the group item of table view + * The property key to get the highlighted color of the bar of the group item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int GROUP_ITEM_BAR_HIGHLIGHTED; /** - * The property key to get the background color of the section item of table view + * The property key to get the background color of the section item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int SECTION_ITEM_BG_NORMAL; /** - * The property key to get the background color of the context item of table view + * The property key to get the background color of the context item of table view. * * @since 2.1 */ _OSP_EXPORT_ static const int CONTEXT_ITEM_BG_NORMAL; /** - * The property key to get the empty text color of table view + * The property key to get the empty text color of table view. * * @since 2.1 */ @@ -3062,28 +3062,28 @@ struct _OSP_EXPORT_ ColorKey struct _OSP_EXPORT_ TokenEdit { /** - * The property key to get the normal background color of token edit + * The property key to get the normal background color of token edit. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_NORMAL; /** - * The property key to get the selected background color of token edit + * The property key to get the selected background color of token edit. * * @since 2.1 */ _OSP_EXPORT_ static const int BG_SELECTED; /** - * The property key to get the normal text color of token edit + * The property key to get the normal text color of token edit. * * @since 2.1 */ _OSP_EXPORT_ static const int TEXT_NORMAL; /** - * The property key to get the selected text color of token edit + * The property key to get the selected text color of token edit. * * @since 2.1 */ diff --git a/inc/FUiVariant.h b/inc/FUiVariant.h index 7497550..1bad2a9 100644 --- a/inc/FUiVariant.h +++ b/inc/FUiVariant.h @@ -62,14 +62,14 @@ enum VariantType { VARIANT_TYPE_NONE = 0, /**< The type for invalid variant */ VARIANT_TYPE_INT, /**< The @c int type */ - VARIANT_TYPE_UINT, /**< The unsigned @c int type */ + VARIANT_TYPE_UINT, /**< The @c unsigned @c int type */ VARIANT_TYPE_BOOL, /**< The @c bool type */ VARIANT_TYPE_FLOAT, /**< The @c float type */ VARIANT_TYPE_DOUBLE, /**< The @c double type */ VARIANT_TYPE_LONG, /**< The @c long type */ - VARIANT_TYPE_ULONG, /**< The unsigned @c long type */ + VARIANT_TYPE_ULONG, /**< The @c unsigned @c long type */ VARIANT_TYPE_LONGLONG, /**< The @c long @c long type */ - VARIANT_TYPE_ULONGLONG, /**< The unsigned @c long @c long type */ + VARIANT_TYPE_ULONGLONG, /**< The @c unsigned @c long @c long type */ VARIANT_TYPE_STRING, /**< The String type */ VARIANT_TYPE_DATETIME, /**< The DateTime type */ VARIANT_TYPE_COLOR, /**< The Color type */ @@ -123,11 +123,11 @@ public: Variant(int value); /** - * Initializes this instance of %Variant with the specified unsigned @c int value. + * Initializes this instance of %Variant with the specified @c unsigned @c int value. * * @since 2.0 * - * @param[in] value An unsigned @c int value + * @param[in] value An @c unsigned @c int value */ Variant(unsigned int value); @@ -168,11 +168,11 @@ public: Variant(long value); /** - * Initializes this instance of %Variant with the specified unsigned @c long value. + * Initializes this instance of %Variant with the specified @c unsigned @c long value. * * @since 2.0 * - * @param[in] value An unsigned @c long value + * @param[in] value An @c unsigned @c long value */ Variant(unsigned long value); @@ -186,11 +186,11 @@ public: Variant(long long value); /** - * Initializes this instance of %Variant with the specified unsigned @c long @c long value. + * Initializes this instance of %Variant with the specified @c unsigned @c long @c long value. * * @since 2.0 * - * @param[in] value An unsigned @c long @c long value + * @param[in] value An @c unsigned @c long @c long value */ Variant(unsigned long long value); @@ -303,7 +303,7 @@ public: Variant(const Tizen::Graphics::FloatMatrix4& value); /** - * Initializes this instance of %Variant with the specified Tizen::Graphics::FloatPoint3 value. + * Initializes this instance of %Variant with a specified Tizen::Graphics::FloatPoint3 value. * * @since 2.1 * @@ -312,7 +312,7 @@ public: Variant(const Tizen::Graphics::FloatPoint3& value); /** - * Initializes this instance of %Variant with the specified Tizen::Graphics::FloatVector4 value. + * Initializes this instance of %Variant with a specified Tizen::Graphics::FloatVector4 value. * * @since 2.1 * @@ -353,7 +353,7 @@ public: * @since 2.0 * * @return A reference to the %Variant instance - * @param[in] rhs An unsigned @c int value + * @param[in] rhs An @c unsigned @c int value * */ Variant& operator =(unsigned int rhs); @@ -407,7 +407,7 @@ public: * @since 2.0 * * @return A reference to the %Variant instance - * @param[in] rhs An unsigned @c long value + * @param[in] rhs An @c unsigned @c long value * */ Variant& operator =(unsigned long rhs); @@ -428,7 +428,7 @@ public: * * @since 2.0 * @return A reference to the %Variant instance - * @param[in] rhs An unsigned @c long @c long value + * @param[in] rhs An @c unsigned @c long @c long value * */ Variant& operator =(unsigned long long rhs); @@ -548,7 +548,7 @@ public: Variant& operator =(const Tizen::Graphics::FloatMatrix4& rhs); /** - * Assigns the value of the specified instance of Tizen::Graphics::FloatPoint3 to the current instance of %Variant. + * Assigns the value of a specified instance of Tizen::Graphics::FloatPoint3 to the current instance of %Variant. * * @since 2.1 * @return A reference to the %Variant instance @@ -557,7 +557,7 @@ public: Variant& operator =(const Tizen::Graphics::FloatPoint3& rhs); /** - * Assigns the value of the specified instance of Tizen::Graphics::FloatVecto4 to the current instance of %Variant. + * Assigns the value of a specified instance of Tizen::Graphics::FloatVecto4 to the current instance of %Variant. * * @since 2.1 * @return A reference to the %Variant instance @@ -589,11 +589,11 @@ public: _OSP_EXPORT_ friend bool operator !=(const Variant& lhs, const Variant& rhs); /** - * Gets the signed @c int equivalent of the current instance. + * Gets the @c signed @c int equivalent of the current instance. * * @since 2.0 * - * @return Signed @c int equivalent of the current instance + * @return The @c signed @c int equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_INT. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -603,11 +603,11 @@ public: int ToInt(void) const; /** - * Gets the unsigned @c int equivalent of the current instance. + * Gets the @c unsigned @c int equivalent of the current instance. * * @since 2.0 * - * @return Unsigned @c int equivalent of the current instance + * @return The @c unsigned @c int equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_UINT. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -621,7 +621,7 @@ public: * * @since 2.0 * - * @return @c bool equivalent of the current instance + * @return The @c bool equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_BOOL. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -635,7 +635,7 @@ public: * * @since 2.0 * - * @return @c float equivalent of the current instance + * @return The @c float equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_FLOAT. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -649,7 +649,7 @@ public: * * @since 2.0 * - * @return @c double equivalent of the current instance + * @return The @c double equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_DOUBLE. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -659,11 +659,11 @@ public: double ToDouble(void) const; /** - * Gets the signed @c long equivalent of the current instance. + * Gets the @c signed @c long equivalent of the current instance. * * @since 2.0 * - * @return Signed @c long equivalent of the current instance + * @return The @c signed @c long equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_LONG. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -673,11 +673,11 @@ public: long ToLong(void) const; /** - * Gets the unsigned @c int equivalent of the current instance. + * Gets the @c unsigned @c int equivalent of the current instance. * * @since 2.0 * - * @return Unsigned @c long equivalent of the current instance + * @return The @c unsigned @c long equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_ULONG. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -687,7 +687,7 @@ public: unsigned long ToULong(void) const; /** - * Gets the signed @c long @c long equivalent of the current instance. + * Gets the @c signed @c long @c long equivalent of the current instance. * * @since 2.0 * @@ -701,11 +701,11 @@ public: long long ToLongLong(void) const; /** - * Gets the unsigned @c long @c long equivalent of the current instance. + * Gets the @c unsigned @c long @c long equivalent of the current instance. * * @since 2.0 * - * @return Unsigned @c long @c long equivalent of the current instance + * @return The @c unsigned @c long @c long equivalent of the current instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current variant type is not @c VARIANT_TYPE_ULONGLONG. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -870,6 +870,7 @@ public: /** * Gets the Tizen::Graphics::FloatVector4 representation of the value of the current instance. + * * @since 2.1 * * @return A Tizen::Graphics::FloatVector4 representing the value of the current instance diff --git a/inc/FUiVerticalBoxLayout.h b/inc/FUiVerticalBoxLayout.h index 31162a7..09b2427 100644 --- a/inc/FUiVerticalBoxLayout.h +++ b/inc/FUiVerticalBoxLayout.h @@ -253,7 +253,7 @@ public: result SetSpacing(Control& childControl, int space); /** - * Sets the space between the specified control and its predecessor. + * Sets the space between a specified control and its predecessor. * * @since 2.1 * @@ -284,7 +284,7 @@ public: result SetHorizontalMargin(Control& childControl, int left, int right); /** - * Sets the horizontal margins of the specified control. + * Sets the horizontal margins of a specified control. * * @since 2.1 * @@ -314,7 +314,7 @@ public: result SetWidth(Control& childControl, int width); /** - * Sets the width of the specified control with the fixed length. + * Sets the width of a specified control with the fixed length. * * @since 2.1 * @@ -356,7 +356,7 @@ public: result SetHeight(Control& childControl, int height); /** - * Sets the height of the specified control with a fixed length. + * Sets the height of a specified control with a fixed length. * * @since 2.1 * diff --git a/inc/FUiWindow.h b/inc/FUiWindow.h index 8a224ca..e95ddc7 100755 --- a/inc/FUiWindow.h +++ b/inc/FUiWindow.h @@ -129,7 +129,7 @@ public: virtual result Show(void); /** - * Sets the owner of the window. @n + * Sets the owner of the window. * The visibility of a window has dependency on the visibility of the owner window. * * @since 2.0 @@ -204,7 +204,7 @@ protected: result Construct(const Tizen::Graphics::Rectangle& rect, bool resizable = true, bool movable = true); /** - * Initializes this instance of %Window. + * Initializes this instance of %Window with the specified parameters. * * @since 2.1 * @@ -245,21 +245,22 @@ protected: result Construct(const Tizen::Ui::Layout& layout, const Tizen::Graphics::Rectangle& rect, bool resizable = true, bool movable = true); /** - * Initializes this instance of %Window with the specified layout and rectangular region. + * Initializes this instance of %Window with a specified layout and rectangular region. * * @since 2.1 * * @return An error code * @param[in] layout The layout for both the portrait and landscape mode - * @param[in] rect The location and size of the %window + * @param[in] rect The location and size of the window * @param[in] resizable Set to @c true to make the window resizable, @n * else @c false * @param[in] movable Set to @c true to make the window movable, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks This method must be called from the derived classes's construct methods. - * @remarks If the @c resizable is @c false, IsResizable() returns @c false. + * @remarks + * - This method must be called from the derived classes's construct methods. + * - If the @c resizable is @c false, IsResizable() returns @c false. * @see IsResizable() * @see Tizen::Ui::Layout * @see Tizen::Ui::Container::GetLayoutN()