* @since 2.0
*
* @return An error code
- * @param[in] rect An instance of the Rectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::Rectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the created window along with
- * the width and height of the window.
+ * the width and height of the window.@n\r
+ * The optimal size of the control is defined in\r
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] text The text for this label instance
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
- * To display text in multi-lines or to denote the end of line use '\\n'. @n
- * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @remarks
+ * - A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
+ * - To display text in multi-lines or to denote the end of line use '\\n'.
+ * - The size of the control must be within the range defined by the minimum size and the maximum size.
*/
result Construct(const Tizen::Graphics::Rectangle& rect, const Tizen::Base::String& text);
* @since 2.1
*
* @return An error code
- * @param[in] rect An instance of the Rectangle class @n
+ * @param[in] rect An instance of the Tizen::Graphics::FloatRectangle class @n
* This instance represents the x and y coordinates of the top-left corner of the created window along with
- * the width and height of the window.
+ * the width and height of the window.@n\r
+ * The optimal size of the control is defined in\r
+ * <a href="../org.tizen.native.appprogramming/html/guide/ui/control_optimalsize.htm">Optimal Size of UI Controls</a>.
* @param[in] text The text for this label instance
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_SYSTEM A system error has occurred.
- * @remarks A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
- * To display text in multi-lines or to denote the end of line use '\\n'. @n
- * The size of the control must be within the range defined by the minimum size and the maximum size.
+ * @remarks
+ * - A control is fully usable only after it has been added to a container, therefore some methods may fail if used earlier.
+ * - To display text in multi-lines or to denote the end of line use '\\n'.
+ * - The size of the control must be within the range defined by the minimum size and the maximum size.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect, const Tizen::Base::String& text);
* @param[in] style The style of the text
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * If @c size is less than the minimum size, this method fails. The minimum font size is 6 on devices of high screen density.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If @c size is less than the minimum size, this method fails. The minimum font size is 6 on devices of high screen density.
*/
void SetTextConfig(int size, LabelTextStyle style);
* @param[in] style The style of the text
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
- * @remarks The specific error code can be accessed using the GetLastResult() method. @n
- * If @c size is less than the minimum size, this method fails. The minimum font size is 6 on devices of high screen density.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - If @c size is less than the minimum size, this method fails. The minimum font size is 6 on devices of high screen density.
*/
void SetTextConfig(float size, LabelTextStyle style);
projects / platform / framework / native / uifw.git / blobdiff