From: Bowon Ryu Date: Thu, 17 Jun 2021 10:22:50 +0000 (+0900) Subject: [NUI] Add description for Text component's PropertyMap. X-Git-Tag: accepted/tizen/unified/20231205.024657~1743 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=dfa157388dfb95d6ce106fd2279982c8ed0a4ab8;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [NUI] Add description for Text component's PropertyMap. Signed-off-by: Bowon Ryu --- diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs index 8fffdcb..fc8ba72 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextEditor.cs @@ -194,6 +194,12 @@ namespace Tizen.NUI.BaseComponents /// /// The FontStyle property. + /// The fontStyle map contains the following keys :
+ /// + /// width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded) + /// weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack) + /// slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique) + /// /// /// 3 public PropertyMap FontStyle @@ -423,6 +429,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleImageLeft property. + /// The selectionHandleImageLeft map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleImageLeft @@ -440,6 +450,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleImageRight property. + /// The selectionHandleImageRight map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleImageRight @@ -457,6 +471,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandlePressedImageLeft property. + /// The selectionHandlePressedImageLeft map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandlePressedImageLeft @@ -474,6 +492,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandlePressedImageRight property. + /// The selectionHandlePressedImageRight map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandlePressedImageRight @@ -491,6 +513,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleMarkerImageLeft property. + /// The selectionHandleMarkerImageLeft map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleMarkerImageLeft @@ -508,6 +534,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleMarkerImageRight property. + /// The selectionHandleMarkerImageRight map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleMarkerImageRight @@ -622,6 +652,12 @@ namespace Tizen.NUI.BaseComponents /// /// The InputFontStyle property. + /// The inputFontStyle map contains the following keys :
+ /// + /// width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded) + /// weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack) + /// slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique) + /// /// /// 3 public PropertyMap InputFontStyle @@ -690,6 +726,12 @@ namespace Tizen.NUI.BaseComponents /// /// The Underline property. + /// The underline map contains the following keys :
+ /// + /// enable (bool)Whether the underline is enabled (the default value is false) + /// color (Color)The color of the underline (If not provided then the color of the text is used) + /// height (float)The height in pixels of the underline (the default value is 1.f) + /// /// /// 3 public PropertyMap Underline @@ -724,6 +766,12 @@ namespace Tizen.NUI.BaseComponents /// /// The Shadow property. + /// The shadow map contains the following keys :
+ /// + /// color (Color)The color of the shadow (the default color is Color.Black) + /// offset (Vector2)The offset in pixels of the shadow (If not provided then the shadow is not enabled) + /// blurRadius (float)The radius of the Gaussian blur for the soft shadow (If not provided then the soft shadow is not enabled) + /// /// /// 3 public PropertyMap Shadow @@ -792,6 +840,11 @@ namespace Tizen.NUI.BaseComponents /// /// The Outline property. + /// The outline map contains the following keys :
+ /// + /// color (Color)The color of the outline (the default color is Color.White) + /// width (float)The width in pixels of the outline (If not provided then the outline is not enabled) + /// /// /// 3 public PropertyMap Outline @@ -1170,7 +1223,17 @@ namespace Tizen.NUI.BaseComponents /// /// The Placeholder property. - /// Gets or sets the placeholder: text, color, font family, font style, point size, and pixel size. + /// The placeholder map contains the following keys :
+ /// + /// text (string)The text to display when the TextEditor is empty and inactive + /// textFocused (string)The text to display when the placeholder has focus + /// color (Color)The color of the placeholder text + /// fontFamily (string)The fontFamily of the placeholder text + /// fontStyle (PropertyMap)The fontStyle of the placeholder text + /// pointSize (float)The pointSize of the placeholder text + /// pixelSize (float)The pixelSize of the placeholder text + /// ellipsis (bool)The ellipsis of the placeholder text + /// /// /// /// The following example demonstrates how to set the placeholder property. @@ -1349,6 +1412,20 @@ namespace Tizen.NUI.BaseComponents /// /// The InputMethodSettings property. /// + /// + /// is a class encapsulating the input method map. Please use the class for this property. + /// + /// + /// The following example demonstrates how to set the InputMethodSettings property. + /// + /// InputMethod method = new InputMethod(); + /// method.PanelLayout = InputMethod.PanelLayoutType.Normal; + /// method.ActionButton = InputMethod.ActionButtonTitleType.Default; + /// method.AutoCapital = InputMethod.AutoCapitalType.Word; + /// method.Variation = 1; + /// textEditor.InputMethodSettings = method.OutputMap; + /// + /// [EditorBrowsable(EditorBrowsableState.Never)] public PropertyMap InputMethodSettings { diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextField.cs b/src/Tizen.NUI/src/public/BaseComponents/TextField.cs index ec800c7..92ee630 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextField.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextField.cs @@ -284,6 +284,12 @@ namespace Tizen.NUI.BaseComponents /// /// The FontStyle property. + /// The fontStyle map contains the following keys :
+ /// + /// width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded) + /// weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack) + /// slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique) + /// /// /// 3 public PropertyMap FontStyle @@ -663,6 +669,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleImageLeft property. + /// The selectionHandleImageLeft map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleImageLeft @@ -680,6 +690,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleImageRight property. + /// The selectionHandleImageRight map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleImageRight @@ -697,6 +711,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandlePressedImageLeft property. + /// The selectionHandlePressedImageLeft map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandlePressedImageLeft @@ -714,6 +732,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandlePressedImageRight property. + /// The selectionHandlePressedImageRight map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandlePressedImageRight @@ -731,6 +753,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleMarkerImageLeft property. + /// The selectionHandleMarkerImageLeft map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleMarkerImageLeft @@ -748,6 +774,10 @@ namespace Tizen.NUI.BaseComponents /// /// The SelectionHandleMarkerImageRight property. + /// The selectionHandleMarkerImageRight map contains the following key :
+ /// + /// filename (string)The path of image file + /// /// /// 3 public PropertyMap SelectionHandleMarkerImageRight @@ -808,6 +838,20 @@ namespace Tizen.NUI.BaseComponents /// /// The InputMethodSettings property. /// + /// + /// is a class encapsulating the input method map. Please use the class for this property. + /// + /// + /// The following example demonstrates how to set the InputMethodSettings property. + /// + /// InputMethod method = new InputMethod(); + /// method.PanelLayout = InputMethod.PanelLayoutType.Normal; + /// method.ActionButton = InputMethod.ActionButtonTitleType.Default; + /// method.AutoCapital = InputMethod.AutoCapitalType.Word; + /// method.Variation = 1; + /// textField.InputMethodSettings = method.OutputMap; + /// + /// /// 3 public PropertyMap InputMethodSettings { @@ -879,6 +923,12 @@ namespace Tizen.NUI.BaseComponents /// /// The InputFontStyle property. + /// The inputFontStyle map contains the following keys :
+ /// + /// width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded) + /// weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack) + /// slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique) + /// /// /// 3 public PropertyMap InputFontStyle @@ -913,6 +963,12 @@ namespace Tizen.NUI.BaseComponents /// /// The Underline property. + /// The underline map contains the following keys :
+ /// + /// enable (bool)Whether the underline is enabled (the default value is false) + /// color (Color)The color of the underline (If not provided then the color of the text is used) + /// height (float)The height in pixels of the underline (the default value is 1.f) + /// /// /// 3 public PropertyMap Underline @@ -947,6 +1003,12 @@ namespace Tizen.NUI.BaseComponents /// /// The Shadow property. + /// The shadow map contains the following keys :
+ /// + /// color (Color)The color of the shadow (the default color is Color.Black) + /// offset (Vector2)The offset in pixels of the shadow (If not provided then the shadow is not enabled) + /// blurRadius (float)The radius of the Gaussian blur for the soft shadow (If not provided then the soft shadow is not enabled) + /// /// /// 3 public PropertyMap Shadow @@ -1015,6 +1077,11 @@ namespace Tizen.NUI.BaseComponents /// /// The Outline property. + /// The outline map contains the following keys :
+ /// + /// color (Color)The color of the outline (the default color is Color.White) + /// width (float)The width in pixels of the outline (If not provided then the outline is not enabled) + /// /// /// 3 public PropertyMap Outline @@ -1049,7 +1116,27 @@ namespace Tizen.NUI.BaseComponents /// /// The HiddenInputSettings property. + /// The hiddenInputSettings map contains the following keys :
+ /// + /// HiddenInputProperty.Mode (int)The mode for input text display (Use HiddenInputModeType) + /// HiddenInputProperty.SubstituteCharacter (int)All input characters are substituted by this character + /// HiddenInputProperty.SubstituteCount (int)Length of text to show or hide, available when HideCount/ShowCount mode is used + /// HiddenInputProperty.ShowLastCharacterDuration (int)Hide last character after this duration, available when ShowLastCharacter mode + /// /// + /// + /// See and for a detailed description. + /// + /// + /// The following example demonstrates how to set the HiddenInputSettings property. + /// + /// PropertyMap map = new PropertyMap(); + /// map.Add(HiddenInputProperty.Mode, new PropertyValue((int)HiddenInputModeType.ShowLastCharacter)); + /// map.Add(HiddenInputProperty.ShowLastCharacterDuration, new PropertyValue(500)); + /// map.Add(HiddenInputProperty.SubstituteCharacter, new PropertyValue(0x2A)); + /// textField.HiddenInputSettings = map; + /// + /// /// 3 public Tizen.NUI.PropertyMap HiddenInputSettings { @@ -1263,7 +1350,17 @@ namespace Tizen.NUI.BaseComponents /// /// The Placeholder property. - /// Gets or sets the placeholder: text, color, font family, font style, point size, and pixel size. + /// The placeholder map contains the following keys :
+ /// + /// text (string)The text to display when the TextField is empty and inactive + /// textFocused (string)The text to display when the placeholder has focus + /// color (Color)The color of the placeholder text + /// fontFamily (string)The fontFamily of the placeholder text + /// fontStyle (PropertyMap)The fontStyle of the placeholder text + /// pointSize (float)The pointSize of the placeholder text + /// pixelSize (float)The pixelSize of the placeholder text + /// ellipsis (bool)The ellipsis of the placeholder text + /// /// /// /// The following example demonstrates how to set the Placeholder property. diff --git a/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs b/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs index c989f02..d3a36b9 100755 --- a/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs +++ b/src/Tizen.NUI/src/public/BaseComponents/TextLabel.cs @@ -259,6 +259,12 @@ namespace Tizen.NUI.BaseComponents /// /// The FontStyle property.
/// The requested font style to use.
+ /// The fontStyle map contains the following keys :
+ /// + /// width (string)The width key defines occupied by each glyph. (values: ultraCondensed, extraCondensed, condensed, semiCondensed, normal, semiExpanded, expanded, extraExpanded, ultraExpanded) + /// weight (string)The weight key defines the thickness or darkness of the glyphs. (values: thin, ultraLight, extraLight, light, demiLight, semiLight, book, normal, regular, medium, demiBold, semiBold, bold, ultraBold, extraBold, black, heavy, extraBlack) + /// slant (string)The slant key defines whether to use italics. (values: normal, roman, italic, oblique) + /// /// /// 3 public PropertyMap FontStyle @@ -635,6 +641,12 @@ namespace Tizen.NUI.BaseComponents /// /// The Underline property.
/// The default underline parameters.
+ /// The underline map contains the following keys :
+ /// + /// enable (bool)Whether the underline is enabled (the default value is false) + /// color (Color)The color of the underline (If not provided then the color of the text is used) + /// height (float)The height in pixels of the underline (the default value is 1.f) + /// /// /// 3 public PropertyMap Underline @@ -653,6 +665,12 @@ namespace Tizen.NUI.BaseComponents /// /// The Shadow property.
/// The default shadow parameters.
+ /// The shadow map contains the following keys :
+ /// + /// color (Color)The color of the shadow (the default color is Color.Black) + /// offset (Vector2)The offset in pixels of the shadow (If not provided then the shadow is not enabled) + /// blurRadius (float)The radius of the Gaussian blur for the soft shadow (If not provided then the soft shadow is not enabled) + /// /// /// 3 public PropertyMap Shadow @@ -707,6 +725,11 @@ namespace Tizen.NUI.BaseComponents /// /// The Outline property.
/// The default outline parameters.
+ /// The outline map contains the following keys :
+ /// + /// color (Color)The color of the outline (the default color is Color.White) + /// width (float)The width in pixels of the outline (If not provided then the outline is not enabled) + /// /// /// 3 public PropertyMap Outline @@ -881,11 +904,13 @@ namespace Tizen.NUI.BaseComponents /// /// The text fit parameters.
/// The textFit map contains the following keys :
- /// - enable (bool type) : True to enable the text fit or false to disable(the default value is false)
- /// - minSize (float type) : Minimum Size for text fit(the default value is 10.f)
- /// - maxSize (float type) : Maximum Size for text fit(the default value is 100.f)
- /// - stepSize (float type) : Step Size for font increase(the default value is 1.f)
- /// - fontSize (string type) : The size type of font, You can choose between "pointSize" or "pixelSize". (the default value is "pointSize")
+ /// + /// enable (bool)True to enable the text fit or false to disable (the default value is false) + /// minSize (float)Minimum Size for text fit (the default value is 10.f) + /// maxSize (float)Maximum Size for text fit (the default value is 100.f) + /// stepSize (float)Step Size for font increase (the default value is 1.f) + /// fontSize (string)The size type of font, You can choose between "pointSize" or "pixelSize". (the default value is "pointSize") + /// /// /// This will be public opened in tizen_5.5 after ACR done. Before ACR, need to be hidden as inhouse API. [EditorBrowsable(EditorBrowsableState.Never)]