/// <summary>
/// An enum of window types.
/// </summary>
+ /// <remarks>
+ /// Most of window type can be set, except for IME type.<br />
+ /// IME type can only be used in one of NUIApplication's constrcutors.<br />
+ /// </remarks>
/// <since_tizen> 3 </since_tizen>
public enum WindowType
{
Dialog,
/// <summary>
/// Used for IME window that is used for keyboard window.
- /// It should be set in Application's New input param when application is created.
- /// In addition, it is only for internal keyboard application.
- /// This should be hidden.
+ /// It should be set in NUIApplication constructor.
+ /// It does not work with Window.Type, because IME window type can not change in runtime.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <remarks>
+ /// See <see cref="NUIApplication" /> for this type. <br />
+ /// </remarks>
Ime
}
/// Hyphenation mode will move part of the word (at possible hyphen locations)
/// to the next line and draw a hyphen at the end of the line.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
Hyphenation,
/// <summary>
/// Mixed mode will try word wrap, if failed, it will try hyphenation wrap.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
Mixed
}
/// <summary>
/// An enum of ellipsis position.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
public enum EllipsisPosition
{
/// <summary>
/// ellipsis position at end.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
End,
/// <summary>
/// ellipsis position at start.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
Start,
/// <summary>
- /// ellipsis position in middle.
+ /// ellipsis position in the middle.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
+ /// <since_tizen> 9 </since_tizen>
Middle
}
/// If the device can not support GLES version 3.0 over, the version will be chosen with GLES version 2.0.<br />
/// It is for GLWindow and GLView.<br />
/// </summary>
+ /// <since_tizen> 9 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum GLESVersion
{
/// <summary>
/// GLES version 2.0
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
Version20 = 0,
/// <summary>
/// GLES version 3.0
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
Version30
}
/// <summary>
/// Enumeration for rendering mode
/// This Enumeration is used to choose the rendering mode.
- /// It has two options.
- /// One of them is continuous mode. It is rendered continuously.
- /// The other is on demand mode. It is rendered by application.
/// It is for GLWindow and GLView.
/// </summary>
+ /// <since_tizen> 9 </since_tizen>
[EditorBrowsable(EditorBrowsableState.Never)]
public enum GLRenderingMode
{
/// <summary>
- /// continuous mode
+ /// The render frame delegate is invoked continuously.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
Continuous = 0,
/// <summary>
- /// on demand by application
+ /// The render frame delegate is invoked by user.
/// </summary>
- [EditorBrowsable(EditorBrowsableState.Never)]
OnDemand = 1
}
+
+ /// <summary>
+ /// Enumeration for the type of InputFilter.
+ /// </summary>
+ /// <remarks>
+ /// The type of InputFilter that is stored in the <see cref="Tizen.NUI.BaseComponents.InputFilteredEventArgs"/> when the input is filtered.
+ /// </remarks>
+ /// <since_tizen> 9 </since_tizen>
+ public enum InputFilterType
+ {
+ /// <summary>
+ /// The type of InputFilter is Accept.
+ /// </summary>
+ Accept,
+
+ /// <summary>
+ /// The type of InputFilter is Reject.
+ /// </summary>
+ Reject
+ }
+
+ /// <summary>
+ /// Enumeration for the size type of font. <br />
+ /// </summary>
+ /// <remarks>
+ /// The size type of font used as a property of <see cref="Tizen.NUI.Text.TextFit"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public enum FontSizeType
+ {
+ /// <summary>
+ /// The PointSize.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ PointSize,
+
+ /// <summary>
+ /// The PixelSize.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ PixelSize
+ }
+
+ namespace Text
+ {
+ /// <summary>
+ /// A struct to pass data of InputFilter PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// InputFilter filters input based on regular expressions. <br />
+ /// Users can set the Accepted or Rejected regular expression set, or both. <br />
+ /// If both are used, Rejected has higher priority. <br />
+ /// The character set must follow the regular expression rules. <br />
+ /// Behaviour can not be guaranteed for incorrect grammars. <br />
+ /// Refer the link below for detailed rules. <br />
+ /// The functions in std::regex library use the ECMAScript grammar: <br />
+ /// http://cplusplus.com/reference/regex/ECMAScript/ <br />
+ /// The InputFilter struct is used as an argument to SetInputFilter and GetInputFilter methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextField.SetInputFilter"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetInputFilter"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetInputFilter"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetInputFilter"/>. <br />
+ /// </remarks>
+ /// <since_tizen> 9 </since_tizen>
+ public struct InputFilter
+ {
+ /// <summary>
+ /// A regular expression in the set of characters to be accepted by the inputFilter.
+ /// </summary>
+ public string Accepted { get; set; }
+
+ /// <summary>
+ /// A regular expression in the set of characters to be rejected by the inputFilter.
+ /// </summary>
+ public string Rejected { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of FontStyle PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The FontStyle struct is used as an argument to SetFontStyle and GetFontStyle methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextLabel.SetFontStyle"/>, <see cref="Tizen.NUI.BaseComponents.TextLabel.GetFontStyle"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetFontStyle"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetFontStyle"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetFontStyle"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetFontStyle"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct FontStyle
+ {
+ /// <summary>
+ /// The Width defines occupied by each glyph.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public FontWidthType Width { get; set; }
+
+ /// <summary>
+ /// The Weight defines the thickness or darkness of the glyphs.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public FontWeightType Weight { get; set; }
+
+ /// <summary>
+ /// The Slant defines whether to use italics.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public FontSlantType Slant { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of Underline PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The Underline struct is used as an argument to SetUnderline and GetUnderline methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextLabel.SetUnderline"/>, <see cref="Tizen.NUI.BaseComponents.TextLabel.GetUnderline"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetUnderline"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetUnderline"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetUnderline"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetUnderline"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct Underline
+ {
+ /// <summary>
+ /// Whether the underline is enabled (the default value is false).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool Enable { get; set; }
+
+ /// <summary>
+ /// The color of the underline (if not provided then the color of the text is used).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Color Color { get; set; }
+
+ /// <summary>
+ /// The height in pixels of the underline (if null, the default value is 1.0f).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? Height { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of Shadow PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The Shadow struct is used as an argument to SetShadow and GetShadow methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextLabel.SetShadow"/>, <see cref="Tizen.NUI.BaseComponents.TextLabel.GetShadow"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetShadow"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetShadow"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetShadow"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetShadow"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct Shadow
+ {
+ /// <summary>
+ /// The color of the shadow (the default color is Color.Black).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Color Color { get; set; }
+
+ /// <summary>
+ /// The offset in pixels of the shadow (if null, the default value is 0, 0). <br />
+ /// If not provided then the shadow is not enabled. <br />
+ ///
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Vector2 Offset { get; set; }
+
+ /// <summary>
+ /// The radius of the Gaussian blur for the soft shadow (if null, the default value is 0.0f). <br />
+ /// If not provided then the soft shadow is not enabled. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? BlurRadius { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of Outline PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The Outline struct is used as an argument to SetOutline and GetOutline methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextLabel.SetOutline"/>, <see cref="Tizen.NUI.BaseComponents.TextLabel.GetOutline"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetOutline"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetOutline"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetOutline"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetOutline"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct Outline
+ {
+ /// <summary>
+ /// The color of the outline (the default color is Color.White).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Color Color { get; set; }
+
+ /// <summary>
+ /// The width in pixels of the outline (if null, the default value is 0.0f). <br />
+ /// If not provided then the outline is not enabled. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? Width { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of TextFit PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The TextFit struct is used as an argument to SetTextFit and GetTextFit methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextLabel.SetTextFit"/> and <see cref="Tizen.NUI.BaseComponents.TextLabel.GetTextFit"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct TextFit
+ {
+ /// <summary>
+ /// True to enable the text fit or false to disable (the default value is false).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool Enable { get; set; }
+
+ /// <summary>
+ /// Minimum Size for text fit (if null, the default value is 10.0f).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? MinSize { get; set; }
+
+ /// <summary>
+ /// Maximum Size for text fit (if null, the default value is 100.0f).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? MaxSize { get; set; }
+
+ /// <summary>
+ /// Step Size for font increase (if null, the default value is 1.0f).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? StepSize { get; set; }
+
+ /// <summary>
+ /// The size type of font, PointSize or PixelSize (the default value is PointSize).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public FontSizeType FontSizeType { get; set; }
+
+ /// <summary>
+ /// Font Size for text fit
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? FontSize { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of Placeholder PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The Placeholder struct is used as an argument to SetPlaceholder and GetPlaceholder methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextField.SetPlaceholder"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetPlaceholder"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetPlaceholder"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.SetPlaceholder"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct Placeholder
+ {
+ /// <summary>
+ /// The text to display when the TextField is empty and inactive.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string Text { get; set; }
+
+ /// <summary>
+ /// The text to display when the placeholder has focus.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string TextFocused { get; set; }
+
+ /// <summary>
+ /// The color of the placeholder text.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public Color Color { get; set; }
+
+ /// <summary>
+ /// The FontFamily of the placeholder text.
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string FontFamily { get; set; }
+
+ /// <summary>
+ /// The FontStyle of the placeholder text (if null, the text control FontStyle is used).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public FontStyle? FontStyle { get; set; }
+
+ /// <summary>
+ /// The PointSize of the placeholder text. <br />
+ /// Not required if PixelSize provided. <br />
+ /// If both provided or neither provided then the text control point size is used. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? PointSize { get; set; }
+
+ /// <summary>
+ /// The PiexSize of the placeholder text.
+ /// Not required if PointSize provided. <br />
+ /// If both provided or neither provided then the text control point size is used. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public float? PixelSize { get; set; }
+
+ /// <summary>
+ /// The ellipsis of the placeholder text (the default value is false).
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public bool Ellipsis { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of HiddenInputSettings PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The HiddenInput struct is used as an argument to SetHiddenInput and GetHiddenInput methods. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextField.SetHiddenInput"/> and <see cref="Tizen.NUI.BaseComponents.TextField.GetHiddenInput"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct HiddenInput
+ {
+ /// <summary>
+ /// The mode for input text display. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public HiddenInputModeType Mode { get; set; }
+
+ /// <summary>
+ /// All input characters are substituted by this character (if null, the default value is '*'). <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public char? SubstituteCharacter { get; set; }
+
+ /// <summary>
+ /// Length of text to show or hide, available when HideCount/ShowCount mode is used (if null, the default value is 0). <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public int? SubstituteCount { get; set; }
+
+ /// <summary>
+ /// Hide last character after this duration, available when ShowLastCharacter mode (if null, the default value is 1000). <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public int? ShowLastCharacterDuration { get; set; }
+ }
+
+ /// <summary>
+ /// A struct to pass data of SelectionHandleImageLeft, SelectionHandleImageRight, SelectionHandlePressedImageLeft, SelectionHandlePressedImageRight, SelectionHandleMarkerImageLeft and SelectionHandleMarkerImageRight PropertyMap. <br />
+ /// </summary>
+ /// <remarks>
+ /// The SelectionHandleImage struct is used as an argument to SetSelectionHandleImage, GetSelectionHandleImage methods, SetSelectionHandlePressedImage, GetSelectionHandlePressedImage, SetSelectionHandleMarkerImage and GetSelectionHandleMarkerImage. <br />
+ /// See <see cref="Tizen.NUI.BaseComponents.TextField.SetSelectionHandleImage"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetSelectionHandleImage"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetSelectionHandlePressedImage"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetSelectionHandlePressedImage"/>, <see cref="Tizen.NUI.BaseComponents.TextField.SetSelectionHandleMarkerImage"/>, <see cref="Tizen.NUI.BaseComponents.TextField.GetSelectionHandleMarkerImage"/>, <br />
+ /// <see cref="Tizen.NUI.BaseComponents.TextEditor.SetSelectionHandleImage"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.GetSelectionHandleImage"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetSelectionHandlePressedImage"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.GetSelectionHandlePressedImage"/>, <see cref="Tizen.NUI.BaseComponents.TextEditor.SetSelectionHandleMarkerImage"/> and <see cref="Tizen.NUI.BaseComponents.TextEditor.GetSelectionHandleMarkerImage"/>. <br />
+ /// </remarks>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct SelectionHandleImage
+ {
+ /// <summary>
+ /// The image path to display for the left selection handle. <br />
+ /// It means the handle in the bottom-left. <br />
+ /// If the handle needs to be displayed in the top-left, this image will be vertically flipped. <br />
+ /// If null or empty string, it doesn't change the property. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string LeftImageUrl { get; set; }
+
+ /// <summary>
+ /// The image path to display for the right selection handle. <br />
+ /// It means the handle in the bottom-right. <br />
+ /// If the handle needs to be displayed in the top-right, this image will be vertically flipped. <br />
+ /// If null or empty string, it doesn't change the property. <br />
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public string RightImageUrl { get; set; }
+ }
+ }
+
+
+ /// <summary>
+ /// Pre-defined SlideTransition Direction
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public struct SlideTransitionDirection
+ {
+ /// <summary>
+ /// Top
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static Vector2 Top
+ {
+ get
+ {
+ global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionTopGet();
+ Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+ return ret;
+ }
+ }
+ /// <summary>
+ /// Bottom
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static Vector2 Bottom
+ {
+ get
+ {
+ global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionBottomGet();
+ Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+ return ret;
+ }
+ }
+
+ /// <summary>
+ /// Right
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static Vector2 Right
+ {
+ get
+ {
+ global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionRightGet();
+ Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+ return ret;
+ }
+ }
+
+ /// <summary>
+ /// Left
+ /// </summary>
+ [EditorBrowsable(EditorBrowsableState.Never)]
+ public static Vector2 Left
+ {
+ get
+ {
+ global::System.IntPtr cPtr = Interop.SlideTransitionDirection.SlideTransitionDirectionLeftGet();
+ Vector2 ret = (cPtr == global::System.IntPtr.Zero) ? null : new Vector2(cPtr, false);
+ if (NDalicPINVOKE.SWIGPendingException.Pending) throw new InvalidOperationException("FATAL: get Exception", NDalicPINVOKE.SWIGPendingException.Retrieve());
+ return ret;
+ }
+ }
+ }
}
projects / platform / core / csapi / tizenfx.git / blobdiff