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 public class TextLabel : View
32 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
33 private string textLabelSid = null;
34 private bool systemlangTextFlag = false;
35 internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.TextLabel_SWIGUpcast(cPtr), cMemoryOwn)
37 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
40 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TextLabel obj)
42 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
48 protected override void Dispose(DisposeTypes type)
55 if(type == DisposeTypes.Explicit)
58 //Release your own managed resources here.
59 //You should release all of your own disposable objects here.
62 //Release your own unmanaged resources here.
63 //You should not access any managed member here except static instance.
64 //because the execution order of Finalizes is non-deterministic.
66 if (swigCPtr.Handle != global::System.IntPtr.Zero)
71 NDalicPINVOKE.delete_TextLabel(swigCPtr);
73 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
79 internal new class Property
81 internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextLabel_Property_RENDERING_BACKEND_get();
82 internal static readonly int TEXT = NDalicPINVOKE.TextLabel_Property_TEXT_get();
83 internal static readonly int FONT_FAMILY = NDalicPINVOKE.TextLabel_Property_FONT_FAMILY_get();
84 internal static readonly int FONT_STYLE = NDalicPINVOKE.TextLabel_Property_FONT_STYLE_get();
85 internal static readonly int POINT_SIZE = NDalicPINVOKE.TextLabel_Property_POINT_SIZE_get();
86 internal static readonly int MULTI_LINE = NDalicPINVOKE.TextLabel_Property_MULTI_LINE_get();
87 internal static readonly int HORIZONTAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_HORIZONTAL_ALIGNMENT_get();
88 internal static readonly int VERTICAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_VERTICAL_ALIGNMENT_get();
89 internal static readonly int TEXT_COLOR = NDalicPINVOKE.TextLabel_Property_TEXT_COLOR_get();
90 internal static readonly int SHADOW_OFFSET = NDalicPINVOKE.TextLabel_Property_SHADOW_OFFSET_get();
91 internal static readonly int SHADOW_COLOR = NDalicPINVOKE.TextLabel_Property_SHADOW_COLOR_get();
92 internal static readonly int UNDERLINE_ENABLED = NDalicPINVOKE.TextLabel_Property_UNDERLINE_ENABLED_get();
93 internal static readonly int UNDERLINE_COLOR = NDalicPINVOKE.TextLabel_Property_UNDERLINE_COLOR_get();
94 internal static readonly int UNDERLINE_HEIGHT = NDalicPINVOKE.TextLabel_Property_UNDERLINE_HEIGHT_get();
95 internal static readonly int ENABLE_MARKUP = NDalicPINVOKE.TextLabel_Property_ENABLE_MARKUP_get();
96 internal static readonly int ENABLE_AUTO_SCROLL = NDalicPINVOKE.TextLabel_Property_ENABLE_AUTO_SCROLL_get();
97 internal static readonly int AUTO_SCROLL_SPEED = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_SPEED_get();
98 internal static readonly int AUTO_SCROLL_LOOP_COUNT = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_COUNT_get();
99 internal static readonly int AUTO_SCROLL_GAP = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_GAP_get();
100 internal static readonly int LINE_SPACING = NDalicPINVOKE.TextLabel_Property_LINE_SPACING_get();
101 internal static readonly int UNDERLINE = NDalicPINVOKE.TextLabel_Property_UNDERLINE_get();
102 internal static readonly int SHADOW = NDalicPINVOKE.TextLabel_Property_SHADOW_get();
103 internal static readonly int EMBOSS = NDalicPINVOKE.TextLabel_Property_EMBOSS_get();
104 internal static readonly int OUTLINE = NDalicPINVOKE.TextLabel_Property_OUTLINE_get();
105 internal static readonly int PIXEL_SIZE = NDalicManualPINVOKE.TextLabel_Property_PIXEL_SIZE_get();
106 internal static readonly int ELLIPSIS = NDalicManualPINVOKE.TextLabel_Property_ELLIPSIS_get();
107 internal static readonly int AUTO_SCROLL_STOP_MODE = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_STOP_MODE_get();
108 internal static readonly int AUTO_SCROLL_LOOP_DELAY = NDalicManualPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_DELAY_get();
109 internal static readonly int LINE_COUNT = NDalicManualPINVOKE.TextLabel_Property_LINE_COUNT_get();
110 internal static readonly int LINE_WRAP_MODE = NDalicManualPINVOKE.TextLabel_Property_LINE_WRAP_MODE_get();
115 /// Creates the TextLabel control.
117 /// <since_tizen> 3 </since_tizen>
118 public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true)
120 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
125 /// Creates the TextLabel control.
127 /// <param name="text">The text to display</param>
128 /// <since_tizen> 3 </since_tizen>
129 public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true)
131 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
134 internal TextLabel(TextLabel handle) : this(NDalicPINVOKE.new_TextLabel__SWIG_1(TextLabel.getCPtr(handle)), true)
136 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
140 /// Downcasts a handle to textLabel handle
142 /// <param name="handle"></param>
143 /// <returns></returns>
144 /// <since_tizen> 3 </since_tizen>
145 /// Please do not use! this will be deprecated!
146 /// Instead please use as keyword.
147 [Obsolete("Please DO NOT use! This will be deprecated, instead please USE as keyword.")]
148 [EditorBrowsable(EditorBrowsableState.Never)]
149 public new static TextLabel DownCast(BaseHandle handle)
151 TextLabel ret = Registry.GetManagedBaseHandleFromNativePtr(handle) as TextLabel;
153 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
157 /// The TranslatableText property.<br />
158 /// The text can set the SID value.<br />
160 /// <exception cref='ArgumentNullException'>
161 /// ResourceManager about multilingual is null.
163 /// <since_tizen> 4 </since_tizen>
164 public string TranslatableText
172 if (NUIApplication.MultilingualResourceManager == null)
174 throw new ArgumentNullException("ResourceManager about multilingual is null");
176 string translatableText = null;
177 textLabelSid = value;
178 translatableText = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(SystemSettings.LocaleLanguage.Replace("_", "-")));
179 if (translatableText != null)
181 Text = translatableText;
182 if (systemlangTextFlag == false)
184 SystemSettings.LocaleLanguageChanged += new WeakEventHandler<LocaleLanguageChangedEventArgs>(SystemSettings_LocaleLanguageChanged).Handler;
185 systemlangTextFlag = true;
194 private void SystemSettings_LocaleLanguageChanged(object sender, LocaleLanguageChangedEventArgs e)
196 Text = NUIApplication.MultilingualResourceManager?.GetString(textLabelSid, new CultureInfo(e.Value.Replace("_", "-")));
200 /// The Text property.<br />
201 /// The text to display in the UTF-8 format.<br />
203 /// <since_tizen> 3 </since_tizen>
209 GetProperty(TextLabel.Property.TEXT).Get(out temp);
214 SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value));
219 /// The FontFamily property.<br />
220 /// The requested font family to use.<br />
222 /// <since_tizen> 3 </since_tizen>
223 public string FontFamily
228 GetProperty(TextLabel.Property.FONT_FAMILY).Get(out temp);
233 SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value));
238 /// The FontStyle property.<br />
239 /// The requested font style to use.<br />
241 /// <since_tizen> 3 </since_tizen>
242 public PropertyMap FontStyle
246 PropertyMap temp = new PropertyMap();
247 GetProperty(TextLabel.Property.FONT_STYLE).Get(temp);
252 SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value));
257 /// The PointSize property.<br />
258 /// The size of font in points.<br />
260 /// <since_tizen> 3 </since_tizen>
261 public float PointSize
266 GetProperty(TextLabel.Property.POINT_SIZE).Get(out temp);
271 SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value));
276 /// The MultiLine property.<br />
277 /// The single-line or multi-line layout option.<br />
279 /// <since_tizen> 3 </since_tizen>
280 public bool MultiLine
285 GetProperty(TextLabel.Property.MULTI_LINE).Get(out temp);
290 SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value));
295 /// The HorizontalAlignment property.<br />
296 /// The line horizontal alignment.<br />
298 /// <since_tizen> 3 </since_tizen>
299 public HorizontalAlignment HorizontalAlignment
304 if (GetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT).Get(out temp) == false)
306 NUILog.Error("HorizontalAlignment get error!");
311 return HorizontalAlignment.Begin;
313 return HorizontalAlignment.Center;
315 return HorizontalAlignment.End;
317 return HorizontalAlignment.Begin;
322 string valueToString = "";
325 case HorizontalAlignment.Begin:
327 valueToString = "BEGIN";
330 case HorizontalAlignment.Center:
332 valueToString = "CENTER";
335 case HorizontalAlignment.End:
337 valueToString = "END";
342 valueToString = "BEGIN";
346 SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
351 /// The VerticalAlignment property.<br />
352 /// The line vertical alignment.<br />
354 /// <since_tizen> 3 </since_tizen>
355 public VerticalAlignment VerticalAlignment
360 if (GetProperty(TextLabel.Property.VERTICAL_ALIGNMENT).Get(out temp) == false)
362 NUILog.Error("VerticalAlignment get error!");
368 return VerticalAlignment.Top;
370 return VerticalAlignment.Center;
372 return VerticalAlignment.Bottom;
374 return VerticalAlignment.Bottom;
379 string valueToString = "";
382 case VerticalAlignment.Top:
384 valueToString = "TOP";
387 case VerticalAlignment.Center:
389 valueToString = "CENTER";
392 case VerticalAlignment.Bottom:
394 valueToString = "BOTTOM";
399 valueToString = "BOTTOM";
403 SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
408 /// The TextColor property.<br />
409 /// The color of the text.<br />
410 /// Animation framework can be used to change the color of the text when not using mark up.<br />
411 /// Cannot animate the color when text is auto scrolling.<br />
413 /// <since_tizen> 3 </since_tizen>
414 public Color TextColor
418 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
419 GetProperty(TextLabel.Property.TEXT_COLOR).Get(temp);
424 SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value));
429 /// The ShadowOffset property.<br />
430 /// The drop shadow offset 0 indicates no shadow.<br />
432 /// <since_tizen> 3 </since_tizen>
433 public Vector2 ShadowOffset
437 Vector2 temp = new Vector2(0.0f, 0.0f);
438 GetProperty(TextLabel.Property.SHADOW_OFFSET).Get(temp);
443 SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value));
448 /// The ShadowColor property.<br />
449 /// The color of a drop shadow.<br />
451 /// <since_tizen> 3 </since_tizen>
452 public Vector4 ShadowColor
456 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
457 GetProperty(TextLabel.Property.SHADOW_COLOR).Get(temp);
462 SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value));
467 /// The UnderlineEnabled property.<br />
468 /// The underline enabled flag.<br />
470 /// <since_tizen> 3 </since_tizen>
471 public bool UnderlineEnabled
476 GetProperty(TextLabel.Property.UNDERLINE_ENABLED).Get(out temp);
481 SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value));
486 /// The UnderlineColor property.<br />
487 /// Overrides the underline height from font metrics.<br />
489 /// <since_tizen> 3 </since_tizen>
490 public Vector4 UnderlineColor
494 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
495 GetProperty(TextLabel.Property.UNDERLINE_COLOR).Get(temp);
500 SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value));
505 /// The UnderlineHeight property.<br />
506 /// Overrides the underline height from font metrics.<br />
508 /// <since_tizen> 3 </since_tizen>
509 public float UnderlineHeight
514 GetProperty(TextLabel.Property.UNDERLINE_HEIGHT).Get(out temp);
519 SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value));
524 /// The EnableMarkup property.<br />
525 /// Whether the mark-up processing is enabled.<br />
527 /// <since_tizen> 3 </since_tizen>
528 public bool EnableMarkup
533 GetProperty(TextLabel.Property.ENABLE_MARKUP).Get(out temp);
538 SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value));
543 /// The EnableAutoScroll property.<br />
544 /// Starts or stops auto scrolling.<br />
546 /// <since_tizen> 3 </since_tizen>
547 public bool EnableAutoScroll
552 GetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL).Get(out temp);
557 SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value));
562 /// The AutoScrollSpeed property.<br />
563 /// Sets the speed of scrolling in pixels per second.<br />
565 /// <since_tizen> 3 </since_tizen>
566 public int AutoScrollSpeed
571 GetProperty(TextLabel.Property.AUTO_SCROLL_SPEED).Get(out temp);
576 SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value));
581 /// The AutoScrollLoopCount property.<br />
582 /// Number of complete loops when scrolling enabled.<br />
584 /// <since_tizen> 3 </since_tizen>
585 public int AutoScrollLoopCount
590 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT).Get(out temp);
595 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value));
600 /// The AutoScrollGap property.<br />
601 /// Gap before scrolling wraps.<br />
603 /// <since_tizen> 3 </since_tizen>
604 public float AutoScrollGap
609 GetProperty(TextLabel.Property.AUTO_SCROLL_GAP).Get(out temp);
614 SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value));
619 /// The LineSpacing property.<br />
620 /// The default extra space between lines in points.<br />
622 /// <since_tizen> 3 </since_tizen>
623 public float LineSpacing
628 GetProperty(TextLabel.Property.LINE_SPACING).Get(out temp);
633 SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value));
638 /// The Underline property.<br />
639 /// The default underline parameters.<br />
641 /// <since_tizen> 3 </since_tizen>
642 public PropertyMap Underline
646 PropertyMap temp = new PropertyMap();
647 GetProperty(TextLabel.Property.UNDERLINE).Get(temp);
652 SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value));
657 /// The Shadow property.<br />
658 /// The default shadow parameters.<br />
660 /// <since_tizen> 3 </since_tizen>
661 public PropertyMap Shadow
665 PropertyMap temp = new PropertyMap();
666 GetProperty(TextLabel.Property.SHADOW).Get(temp);
671 SetProperty(TextLabel.Property.SHADOW, new Tizen.NUI.PropertyValue(value));
676 /// The Emboss property.<br />
677 /// The default emboss parameters.<br />
679 /// <since_tizen> 3 </since_tizen>
685 GetProperty(TextLabel.Property.EMBOSS).Get( out temp);
690 SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value));
695 /// The Outline property.<br />
696 /// The default outline parameters.<br />
698 /// <since_tizen> 3 </since_tizen>
699 public PropertyMap Outline
703 PropertyMap temp = new PropertyMap();
704 GetProperty(TextLabel.Property.OUTLINE).Get(temp);
709 SetProperty(TextLabel.Property.OUTLINE, new Tizen.NUI.PropertyValue(value));
714 /// The PixelSize property.<br />
715 /// The size of font in pixels.<br />
717 /// <since_tizen> 3 </since_tizen>
718 public float PixelSize
723 GetProperty(TextLabel.Property.PIXEL_SIZE).Get(out temp);
728 SetProperty(TextLabel.Property.PIXEL_SIZE, new Tizen.NUI.PropertyValue(value));
733 /// The Ellipsis property.<br />
734 /// Enable or disable the ellipsis.<br />
736 /// <since_tizen> 3 </since_tizen>
742 GetProperty(TextLabel.Property.ELLIPSIS).Get(out temp);
747 SetProperty(TextLabel.Property.ELLIPSIS, new Tizen.NUI.PropertyValue(value));
752 /// The AutoScrollLoopDelay property.<br />
753 /// Do something.<br />
755 /// <since_tizen> 3 </since_tizen>
756 public float AutoScrollLoopDelay
761 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY).Get(out temp);
766 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_DELAY, new Tizen.NUI.PropertyValue(value));
771 /// The AutoScrollStopMode property.<br />
772 /// Do something.<br />
774 /// <since_tizen> 3 </since_tizen>
775 public AutoScrollStopMode AutoScrollStopMode
780 if(GetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE).Get(out temp) == false)
782 NUILog.Error("AutoScrollStopMode get error!");
787 return AutoScrollStopMode.FinishLoop;
789 return AutoScrollStopMode.Immediate;
791 return AutoScrollStopMode.FinishLoop;
796 SetProperty(TextLabel.Property.AUTO_SCROLL_STOP_MODE, new Tizen.NUI.PropertyValue((int)value));
801 /// The line count of the text.
803 /// <since_tizen> 4 </since_tizen>
809 GetProperty(TextLabel.Property.LINE_COUNT).Get(out temp);
815 /// The LineWrapMode property.<br />
816 /// line wrap mode when the text lines over layout width.<br />
818 /// <since_tizen> 4 </since_tizen>
819 public LineWrapMode LineWrapMode
824 if(GetProperty(TextLabel.Property.LINE_WRAP_MODE).Get(out temp) == false)
826 NUILog.Error("LineWrapMode get error!");
830 case "WRAP_MODE_WORD":
831 return LineWrapMode.Word;
832 case "WRAP_MODE_CHARACTER":
833 return LineWrapMode.Character;
835 return LineWrapMode.Word;
843 case LineWrapMode.Word:
845 temp = "WRAP_MODE_WORD";
848 case LineWrapMode.Character:
850 temp = "WRAP_MODE_CHARACTER";
854 SetProperty(TextLabel.Property.LINE_WRAP_MODE, new Tizen.NUI.PropertyValue(temp));