2 * Copyright(c) 2017 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 extern alias TizenSystemSettings;
19 using TizenSystemSettings.Tizen.System;
21 using System.Globalization;
22 using System.ComponentModel;
23 namespace Tizen.NUI.BaseComponents
27 /// A control which renders a short text string.<br />
28 /// Text labels are lightweight, non-editable, and do not respond to the user input.<br />
30 /// <since_tizen> 3 </since_tizen>
31 public class TextLabel : View
33 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
34 private string textLabelSid = null;
35 private bool systemlangTextFlag = false;
36 internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.TextLabel_SWIGUpcast(cPtr), cMemoryOwn)
38 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
41 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TextLabel obj)
43 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
49 /// <since_tizen> 3 </since_tizen>
50 protected override void Dispose(DisposeTypes type)
57 if(type == DisposeTypes.Explicit)
60 //Release your own managed resources here.
61 //You should release all of your own disposable objects here.
64 //Release your own unmanaged resources here.
65 //You should not access any managed member here except static instance.
66 //because the execution order of Finalizes is non-deterministic.
68 if (swigCPtr.Handle != global::System.IntPtr.Zero)
73 NDalicPINVOKE.delete_TextLabel(swigCPtr);
75 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
81 internal new class Property
83 internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextLabel_Property_RENDERING_BACKEND_get();
84 internal static readonly int TEXT = NDalicPINVOKE.TextLabel_Property_TEXT_get();
85 internal static readonly int FONT_FAMILY = NDalicPINVOKE.TextLabel_Property_FONT_FAMILY_get();
86 internal static readonly int FONT_STYLE = NDalicPINVOKE.TextLabel_Property_FONT_STYLE_get();
87 internal static readonly int POINT_SIZE = NDalicPINVOKE.TextLabel_Property_POINT_SIZE_get();
88 internal static readonly int MULTI_LINE = NDalicPINVOKE.TextLabel_Property_MULTI_LINE_get();
89 internal static readonly int HORIZONTAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_HORIZONTAL_ALIGNMENT_get();
90 internal static readonly int VERTICAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_VERTICAL_ALIGNMENT_get();
91 internal static readonly int TEXT_COLOR = NDalicPINVOKE.TextLabel_Property_TEXT_COLOR_get();
92 internal static readonly int SHADOW_OFFSET = NDalicPINVOKE.TextLabel_Property_SHADOW_OFFSET_get();
93 internal static readonly int SHADOW_COLOR = NDalicPINVOKE.TextLabel_Property_SHADOW_COLOR_get();
94 internal static readonly int UNDERLINE_ENABLED = NDalicPINVOKE.TextLabel_Property_UNDERLINE_ENABLED_get();
95 internal static readonly int UNDERLINE_COLOR = NDalicPINVOKE.TextLabel_Property_UNDERLINE_COLOR_get();
96 internal static readonly int UNDERLINE_HEIGHT = NDalicPINVOKE.TextLabel_Property_UNDERLINE_HEIGHT_get();
97 internal static readonly int ENABLE_MARKUP = NDalicPINVOKE.TextLabel_Property_ENABLE_MARKUP_get();
98 internal static readonly int ENABLE_AUTO_SCROLL = NDalicPINVOKE.TextLabel_Property_ENABLE_AUTO_SCROLL_get();
99 internal static readonly int AUTO_SCROLL_SPEED = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_SPEED_get();
100 internal static readonly int AUTO_SCROLL_LOOP_COUNT = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_COUNT_get();
101 internal static readonly int AUTO_SCROLL_GAP = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_GAP_get();
102 internal static readonly int LINE_SPACING = NDalicPINVOKE.TextLabel_Property_LINE_SPACING_get();
103 internal static readonly int UNDERLINE = NDalicPINVOKE.TextLabel_Property_UNDERLINE_get();
104 internal static readonly int SHADOW = NDalicPINVOKE.TextLabel_Property_SHADOW_get();
105 internal static readonly int EMBOSS = NDalicPINVOKE.TextLabel_Property_EMBOSS_get();
106 internal static readonly int OUTLINE = NDalicPINVOKE.TextLabel_Property_OUTLINE_get();
107 internal static readonly int PIXEL_SIZE = NDalicManualPINVOKE.TextLabel_Property_PIXEL_SIZE_get();
108 internal static readonly int ELLIPSIS = NDalicManualPINVOKE.TextLabel_Property_ELLIPSIS_get();
109 internal static readonly int AUTO_SCROLL_STOP_MODE = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_STOP_MODE_get();
110 internal static readonly int AUTO_SCROLL_LOOP_DELAY = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_DELAY_get();
111 internal static readonly int LINE_COUNT = NDalicManualPINVOKE.TextLabel_Property_LINE_COUNT_get();
112 internal static readonly int LINE_WRAP_MODE = NDalicManualPINVOKE.TextLabel_Property_LINE_WRAP_MODE_get();
117 /// Creates the TextLabel control.
119 /// <since_tizen> 3 </since_tizen>
120 public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true)
122 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
127 /// Creates the TextLabel control.
129 /// <param name="text">The text to display</param>
130 /// <since_tizen> 3 </since_tizen>
131 public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true)
133 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
136 internal TextLabel(TextLabel handle) : this(NDalicPINVOKE.new_TextLabel__SWIG_1(TextLabel.getCPtr(handle)), true)
138 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
142 /// Downcasts a handle to textLabel handle
144 /// <param name="handle"></param>
145 /// <returns></returns>
146 /// <since_tizen> 3 </since_tizen>
147 /// Please do not use! this will be deprecated!
148 /// Instead please use as keyword.
149 [Obsolete("Please DO NOT use! This will be deprecated, instead please USE as keyword.")]
150 [EditorBrowsable(EditorBrowsableState.Never)]
151 public new static TextLabel DownCast(BaseHandle handle)
153 TextLabel ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextLabel;
155 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
159 /// The TranslatableText property.<br />
160 /// The text can set the SID value.<br />
162 /// <exception cref='ArgumentNullException'>
163 /// ResourceManager about multilingual is null.
165 /// <since_tizen> 4 </since_tizen>
166 public string TranslatableText
174 if (NUIApplication.MultilingualResourceManager == null)
176 throw new ArgumentNullException("ResourceManager about multilingual is null");
178 string translatableText = null;
179 textLabelSid = value;
180 translatableText = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(SystemSettings.LocaleLanguage.Replace("_", "-")));
181 if (translatableText != null)
183 Text = translatableText;
184 if (systemlangTextFlag == false)
186 SystemSettings.LocaleLanguageChanged += new WeakEventHandler<LocaleLanguageChangedEventArgs>(SystemSettings_LocaleLanguageChanged).Handler;
187 systemlangTextFlag = true;
196 private void SystemSettings_LocaleLanguageChanged(object sender, LocaleLanguageChangedEventArgs e)
198 Text = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(e.Value.Replace("_", "-")));
202 /// The Text property.<br />
203 /// The text to display in the UTF-8 format.<br />
205 /// <since_tizen> 3 </since_tizen>
211 GetProperty(TextLabel.Property.TEXT).Get(out temp);
216 SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value));
221 /// The FontFamily property.<br />
222 /// The requested font family to use.<br />
224 /// <since_tizen> 3 </since_tizen>
225 public string FontFamily
230 GetProperty(TextLabel.Property.FONT_FAMILY).Get(out temp);
235 SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value));
240 /// The FontStyle property.<br />
241 /// The requested font style to use.<br />
243 /// <since_tizen> 3 </since_tizen>
244 public PropertyMap FontStyle
248 PropertyMap temp = new PropertyMap();
249 GetProperty(TextLabel.Property.FONT_STYLE).Get(temp);
254 SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value));
259 /// The PointSize property.<br />
260 /// The size of font in points.<br />
262 /// <since_tizen> 3 </since_tizen>
263 public float PointSize
268 GetProperty(TextLabel.Property.POINT_SIZE).Get(out temp);
273 SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value));
278 /// The MultiLine property.<br />
279 /// The single-line or multi-line layout option.<br />
281 /// <since_tizen> 3 </since_tizen>
282 public bool MultiLine
287 GetProperty(TextLabel.Property.MULTI_LINE).Get(out temp);
292 SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value));
297 /// The HorizontalAlignment property.<br />
298 /// The line horizontal alignment.<br />
300 /// <since_tizen> 3 </since_tizen>
301 public HorizontalAlignment HorizontalAlignment
306 if (GetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT).Get(out temp) == false)
308 NUILog.Error("HorizontalAlignment get error!");
313 return HorizontalAlignment.Begin;
315 return HorizontalAlignment.Center;
317 return HorizontalAlignment.End;
319 return HorizontalAlignment.Begin;
324 string valueToString = "";
327 case HorizontalAlignment.Begin:
329 valueToString = "BEGIN";
332 case HorizontalAlignment.Center:
334 valueToString = "CENTER";
337 case HorizontalAlignment.End:
339 valueToString = "END";
344 valueToString = "BEGIN";
348 SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
353 /// The VerticalAlignment property.<br />
354 /// The line vertical alignment.<br />
356 /// <since_tizen> 3 </since_tizen>
357 public VerticalAlignment VerticalAlignment
362 if (GetProperty(TextLabel.Property.VERTICAL_ALIGNMENT).Get(out temp) == false)
364 NUILog.Error("VerticalAlignment get error!");
370 return VerticalAlignment.Top;
372 return VerticalAlignment.Center;
374 return VerticalAlignment.Bottom;
376 return VerticalAlignment.Bottom;
381 string valueToString = "";
384 case VerticalAlignment.Top:
386 valueToString = "TOP";
389 case VerticalAlignment.Center:
391 valueToString = "CENTER";
394 case VerticalAlignment.Bottom:
396 valueToString = "BOTTOM";
401 valueToString = "BOTTOM";
405 SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
410 /// The TextColor property.<br />
411 /// The color of the text.<br />
412 /// Animation framework can be used to change the color of the text when not using mark up.<br />
413 /// Cannot animate the color when text is auto scrolling.<br />
415 /// <since_tizen> 3 </since_tizen>
416 public Color TextColor
420 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
421 GetProperty(TextLabel.Property.TEXT_COLOR).Get(temp);
426 SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value));
431 /// The ShadowOffset property.<br />
432 /// The drop shadow offset 0 indicates no shadow.<br />
434 /// <since_tizen> 3 </since_tizen>
435 public Vector2 ShadowOffset
439 Vector2 temp = new Vector2(0.0f, 0.0f);
440 GetProperty(TextLabel.Property.SHADOW_OFFSET).Get(temp);
445 SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value));
450 /// The ShadowColor property.<br />
451 /// The color of a drop shadow.<br />
453 /// <since_tizen> 3 </since_tizen>
454 public Vector4 ShadowColor
458 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
459 GetProperty(TextLabel.Property.SHADOW_COLOR).Get(temp);
464 SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value));
469 /// The UnderlineEnabled property.<br />
470 /// The underline enabled flag.<br />
472 /// <since_tizen> 3 </since_tizen>
473 public bool UnderlineEnabled
478 GetProperty(TextLabel.Property.UNDERLINE_ENABLED).Get(out temp);
483 SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value));
488 /// The UnderlineColor property.<br />
489 /// Overrides the underline height from font metrics.<br />
491 /// <since_tizen> 3 </since_tizen>
492 public Vector4 UnderlineColor
496 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
497 GetProperty(TextLabel.Property.UNDERLINE_COLOR).Get(temp);
502 SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value));
507 /// The UnderlineHeight property.<br />
508 /// Overrides the underline height from font metrics.<br />
510 /// <since_tizen> 3 </since_tizen>
511 public float UnderlineHeight
516 GetProperty(TextLabel.Property.UNDERLINE_HEIGHT).Get(out temp);
521 SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value));
526 /// The EnableMarkup property.<br />
527 /// Whether the mark-up processing is enabled.<br />
529 /// <since_tizen> 3 </since_tizen>
530 public bool EnableMarkup
535 GetProperty(TextLabel.Property.ENABLE_MARKUP).Get(out temp);
540 SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value));
545 /// The EnableAutoScroll property.<br />
546 /// Starts or stops auto scrolling.<br />
548 /// <since_tizen> 3 </since_tizen>
549 public bool EnableAutoScroll
554 GetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL).Get(out temp);
559 SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value));
564 /// The AutoScrollSpeed property.<br />
565 /// Sets the speed of scrolling in pixels per second.<br />
567 /// <since_tizen> 3 </since_tizen>
568 public int AutoScrollSpeed
573 GetProperty(TextLabel.Property.AUTO_SCROLL_SPEED).Get(out temp);
578 SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value));
583 /// The AutoScrollLoopCount property.<br />
584 /// Number of complete loops when scrolling enabled.<br />
586 /// <since_tizen> 3 </since_tizen>
587 public int AutoScrollLoopCount
592 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT).Get(out temp);
597 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value));
602 /// The AutoScrollGap property.<br />
603 /// Gap before scrolling wraps.<br />
605 /// <since_tizen> 3 </since_tizen>
606 public float AutoScrollGap
611 GetProperty(TextLabel.Property.AUTO_SCROLL_GAP).Get(out temp);
616 SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value));
621 /// The LineSpacing property.<br />
622 /// The default extra space between lines in points.<br />
624 /// <since_tizen> 3 </since_tizen>
625 public float LineSpacing
630 GetProperty(TextLabel.Property.LINE_SPACING).Get(out temp);
635 SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value));
640 /// The Underline property.<br />
641 /// The default underline parameters.<br />
643 /// <since_tizen> 3 </since_tizen>
644 public PropertyMap Underline
648 PropertyMap temp = new PropertyMap();
649 GetProperty(TextLabel.Property.UNDERLINE).Get(temp);
654 SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value));
659 /// The Shadow property.<br />
660 /// The default shadow parameters.<br />
662 /// <since_tizen> 3 </since_tizen>
663 public PropertyMap Shadow
667 PropertyMap temp = new PropertyMap();
668 GetProperty(TextLabel.Property.SHADOW).Get(temp);
673 SetProperty(TextLabel.Property.SHADOW, new Tizen.NUI.PropertyValue(value));
678 /// The Emboss property.<br />
679 /// The default emboss parameters.<br />
681 /// <since_tizen> 3 </since_tizen>
687 GetProperty(TextLabel.Property.EMBOSS).Get( out temp);
692 SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value));
697 /// The Outline property.<br />
698 /// The default outline parameters.<br />
700 /// <since_tizen> 3 </since_tizen>
701 public PropertyMap Outline
705 PropertyMap temp = new PropertyMap();
706 GetProperty(TextLabel.Property.OUTLINE).Get(temp);
711 SetProperty(TextLabel.Property.OUTLINE, new Tizen.NUI.PropertyValue(value));
716 /// The PixelSize property.<br />
717 /// The size of font in pixels.<br />
719 /// <since_tizen> 3 </since_tizen>
720 public float PixelSize
725 GetProperty(TextLabel.Property.PIXEL_SIZE).Get(out temp);
730 SetProperty(TextLabel.Property.PIXEL_SIZE, new Tizen.NUI.PropertyValue(value));
735 /// The Ellipsis property.<br />
736 /// Enable or disable the ellipsis.<br />
738 /// <since_tizen> 3 </since_tizen>
744 GetProperty(TextLabel.Property.ELLIPSIS).Get(out temp);
749 SetProperty(TextLabel.Property.ELLIPSIS, new Tizen.NUI.PropertyValue(value));
754 /// The AutoScrollLoopDelay property.<br />
755 /// Do something.<br />
757 /// <since_tizen> 3 </since_tizen>
758 public float AutoScrollLoopDelay
763 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY).Get(out temp);
768 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY, new Tizen.NUI.PropertyValue(value));
773 /// The AutoScrollStopMode property.<br />
774 /// Do something.<br />
776 /// <since_tizen> 3 </since_tizen>
777 public AutoScrollStopMode AutoScrollStopMode
782 if(GetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE).Get(out temp) == false)
784 NUILog.Error("AutoScrollStopMode get error!");
789 return AutoScrollStopMode.FinishLoop;
791 return AutoScrollStopMode.Immediate;
793 return AutoScrollStopMode.FinishLoop;
798 SetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE, new Tizen.NUI.PropertyValue((int)value));
803 /// The line count of the text.
805 /// <since_tizen> 3 </since_tizen>
811 GetProperty(TextLabel.Property.LINE_COUNT).Get(out temp);
817 /// The LineWrapMode property.<br />
818 /// line wrap mode when the text lines over layout width.<br />
820 /// <since_tizen> 4 </since_tizen>
821 public LineWrapMode LineWrapMode
826 if(GetProperty(TextLabel.Property.LINE_WRAP_MODE).Get(out temp) == false)
828 NUILog.Error("LineWrapMode get error!");
830 return (LineWrapMode)temp;
834 SetProperty(TextLabel.Property.LINE_WRAP_MODE, new Tizen.NUI.PropertyValue((int)value));