1 /** Copyright (c) 2017 Samsung Electronics Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 // This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
17 //------------------------------------------------------------------------------
20 // This file was automatically generated by SWIG (http://www.swig.org).
23 // Do not make changes to this file unless you know what you are doing--modify
24 // the SWIG interface file instead.
25 //------------------------------------------------------------------------------
27 namespace Tizen.NUI.BaseComponents
31 /// A control which renders a short text string.<br>
32 /// Text labels are lightweight, non-editable and do not respond to user input.<br>
34 public class TextLabel : View
36 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
38 internal TextLabel(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.TextLabel_SWIGUpcast(cPtr), cMemoryOwn)
40 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
43 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TextLabel obj)
45 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
51 public override void Dispose()
53 if (!Window.IsInstalled())
55 DisposeQueue.Instance.Add(this);
61 if (swigCPtr.Handle != global::System.IntPtr.Zero)
66 NDalicPINVOKE.delete_TextLabel(swigCPtr);
68 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
70 global::System.GC.SuppressFinalize(this);
76 internal class Property : global::System.IDisposable
78 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
79 protected bool swigCMemOwn;
81 internal Property(global::System.IntPtr cPtr, bool cMemoryOwn)
83 swigCMemOwn = cMemoryOwn;
84 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
87 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(Property obj)
89 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
94 DisposeQueue.Instance.Add(this);
97 public virtual void Dispose()
99 if (!Window.IsInstalled()) {
100 DisposeQueue.Instance.Add(this);
106 if (swigCPtr.Handle != global::System.IntPtr.Zero)
111 NDalicPINVOKE.delete_TextLabel_Property(swigCPtr);
113 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
115 global::System.GC.SuppressFinalize(this);
119 internal Property() : this(NDalicPINVOKE.new_TextLabel_Property(), true)
121 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
124 internal static readonly int RENDERING_BACKEND = NDalicPINVOKE.TextLabel_Property_RENDERING_BACKEND_get();
125 internal static readonly int TEXT = NDalicPINVOKE.TextLabel_Property_TEXT_get();
126 internal static readonly int FONT_FAMILY = NDalicPINVOKE.TextLabel_Property_FONT_FAMILY_get();
127 internal static readonly int FONT_STYLE = NDalicPINVOKE.TextLabel_Property_FONT_STYLE_get();
128 internal static readonly int POINT_SIZE = NDalicPINVOKE.TextLabel_Property_POINT_SIZE_get();
129 internal static readonly int MULTI_LINE = NDalicPINVOKE.TextLabel_Property_MULTI_LINE_get();
130 internal static readonly int HORIZONTAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_HORIZONTAL_ALIGNMENT_get();
131 internal static readonly int VERTICAL_ALIGNMENT = NDalicPINVOKE.TextLabel_Property_VERTICAL_ALIGNMENT_get();
132 internal static readonly int TEXT_COLOR = NDalicPINVOKE.TextLabel_Property_TEXT_COLOR_get();
133 internal static readonly int SHADOW_OFFSET = NDalicPINVOKE.TextLabel_Property_SHADOW_OFFSET_get();
134 internal static readonly int SHADOW_COLOR = NDalicPINVOKE.TextLabel_Property_SHADOW_COLOR_get();
135 internal static readonly int UNDERLINE_ENABLED = NDalicPINVOKE.TextLabel_Property_UNDERLINE_ENABLED_get();
136 internal static readonly int UNDERLINE_COLOR = NDalicPINVOKE.TextLabel_Property_UNDERLINE_COLOR_get();
137 internal static readonly int UNDERLINE_HEIGHT = NDalicPINVOKE.TextLabel_Property_UNDERLINE_HEIGHT_get();
138 internal static readonly int ENABLE_MARKUP = NDalicPINVOKE.TextLabel_Property_ENABLE_MARKUP_get();
139 internal static readonly int ENABLE_AUTO_SCROLL = NDalicPINVOKE.TextLabel_Property_ENABLE_AUTO_SCROLL_get();
140 internal static readonly int AUTO_SCROLL_SPEED = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_SPEED_get();
141 internal static readonly int AUTO_SCROLL_LOOP_COUNT = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_LOOP_COUNT_get();
142 internal static readonly int AUTO_SCROLL_GAP = NDalicPINVOKE.TextLabel_Property_AUTO_SCROLL_GAP_get();
143 internal static readonly int LINE_SPACING = NDalicPINVOKE.TextLabel_Property_LINE_SPACING_get();
144 internal static readonly int UNDERLINE = NDalicPINVOKE.TextLabel_Property_UNDERLINE_get();
145 internal static readonly int SHADOW = NDalicPINVOKE.TextLabel_Property_SHADOW_get();
146 internal static readonly int EMBOSS = NDalicPINVOKE.TextLabel_Property_EMBOSS_get();
147 internal static readonly int OUTLINE = NDalicPINVOKE.TextLabel_Property_OUTLINE_get();
148 internal static readonly int PIXEL_SIZE = NDalicManualPINVOKE.TextLabel_Property_PIXEL_SIZE_get();
149 internal static readonly int ELLIPSIS = NDalicManualPINVOKE.TextLabel_Property_ELLIPSIS_get();
154 /// Creates the TextLabel control.
156 public TextLabel() : this(NDalicPINVOKE.TextLabel_New__SWIG_0(), true)
158 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
163 /// Creates the TextLabel control.
165 /// <param name="text">The text to display</param>
166 public TextLabel(string text) : this(NDalicPINVOKE.TextLabel_New__SWIG_1(text), true)
168 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
171 internal TextLabel(TextLabel handle) : this(NDalicPINVOKE.new_TextLabel__SWIG_1(TextLabel.getCPtr(handle)), true)
173 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
176 internal TextLabel Assign(TextLabel handle)
178 TextLabel ret = new TextLabel(NDalicPINVOKE.TextLabel_Assign(swigCPtr, TextLabel.getCPtr(handle)), false);
179 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
184 /// Downcasts a handle to TextLabel.
186 /// <param name="handle">Handle to an object</param>
187 public new static TextLabel DownCast(BaseHandle handle)
189 TextLabel ret = new TextLabel(NDalicPINVOKE.TextLabel_DownCast(BaseHandle.getCPtr(handle)), true);
190 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
194 internal enum PropertyRange
196 PROPERTY_START_INDEX = PropertyRanges.PROPERTY_REGISTRATION_START_INDEX,
197 PROPERTY_END_INDEX = View.PropertyRange.PROPERTY_START_INDEX + 1000
201 /// RenderingBackend property.<br>
202 /// The type of rendering e.g. bitmap-based.
204 public int RenderingBackend
209 GetProperty(TextLabel.Property.RENDERING_BACKEND).Get(ref temp);
214 SetProperty(TextLabel.Property.RENDERING_BACKEND, new Tizen.NUI.PropertyValue(value));
219 /// Text property.<br>
220 /// The text to display in UTF-8 format.<br>
227 GetProperty(TextLabel.Property.TEXT).Get(out temp);
232 SetProperty(TextLabel.Property.TEXT, new Tizen.NUI.PropertyValue(value));
237 /// FontFamily property.<br>
238 /// The requested font family to use.<br>
240 public string FontFamily
245 GetProperty(TextLabel.Property.FONT_FAMILY).Get(out temp);
250 SetProperty(TextLabel.Property.FONT_FAMILY, new Tizen.NUI.PropertyValue(value));
255 /// FontStyle property.<br>
256 /// The requested font style to use.<br>
258 public PropertyMap FontStyle
262 PropertyMap temp = new PropertyMap();
263 GetProperty(TextLabel.Property.FONT_STYLE).Get(temp);
268 SetProperty(TextLabel.Property.FONT_STYLE, new Tizen.NUI.PropertyValue(value));
273 /// PointSize property.<br>
274 /// The size of font in points.<br>
276 public float PointSize
281 GetProperty(TextLabel.Property.POINT_SIZE).Get(ref temp);
286 SetProperty(TextLabel.Property.POINT_SIZE, new Tizen.NUI.PropertyValue(value));
291 /// MultiLine property.<br>
292 /// The single-line or multi-line layout option.<br>
294 public bool MultiLine
299 GetProperty(TextLabel.Property.MULTI_LINE).Get(ref temp);
304 SetProperty(TextLabel.Property.MULTI_LINE, new Tizen.NUI.PropertyValue(value));
309 /// HorizontalAlignment property.<br>
310 /// The line horizontal alignment.<br>
312 public HorizontalAlignment HorizontalAlignment
317 if (GetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT).Get(out temp) == false)
320 Tizen.Log.Error("NUI", "HorizontalAlignment get error!");
326 return HorizontalAlignment.Begin;
328 return HorizontalAlignment.Center;
330 return HorizontalAlignment.End;
332 return HorizontalAlignment.Begin;
337 string valueToString = "";
340 case HorizontalAlignment.Begin:
342 valueToString = "BEGIN";
345 case HorizontalAlignment.Center:
347 valueToString = "CENTER";
350 case HorizontalAlignment.End:
352 valueToString = "END";
357 valueToString = "BEGIN";
361 SetProperty(TextLabel.Property.HORIZONTAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
366 /// VerticalAlignment property.<br>
367 /// The line vertical alignment.<br>
369 public VerticalAlignment VerticalAlignment
374 if (GetProperty(TextLabel.Property.VERTICAL_ALIGNMENT).Get(out temp) == false)
377 Tizen.Log.Error("NUI", "VerticalAlignment get error!");
384 return VerticalAlignment.Top;
386 return VerticalAlignment.Center;
388 return VerticalAlignment.Bottom;
390 return VerticalAlignment.Bottom;
395 string valueToString = "";
398 case VerticalAlignment.Top:
400 valueToString = "TOP";
403 case VerticalAlignment.Center:
405 valueToString = "CENTER";
408 case VerticalAlignment.Bottom:
410 valueToString = "BOTTOM";
415 valueToString = "BOTTOM";
419 SetProperty(TextLabel.Property.VERTICAL_ALIGNMENT, new Tizen.NUI.PropertyValue(valueToString));
424 /// TextColor property.<br>
425 /// The color of the text.<br>
427 public Color TextColor
431 Color temp = new Color(0.0f, 0.0f, 0.0f, 0.0f);
432 GetProperty(TextLabel.Property.TEXT_COLOR).Get(temp);
437 SetProperty(TextLabel.Property.TEXT_COLOR, new Tizen.NUI.PropertyValue(value));
442 /// ShadowOffset property.<br>
443 /// The drop shadow offset 0 indicates no shadow.<br>
445 public Vector2 ShadowOffset
449 Vector2 temp = new Vector2(0.0f, 0.0f);
450 GetProperty(TextLabel.Property.SHADOW_OFFSET).Get(temp);
455 SetProperty(TextLabel.Property.SHADOW_OFFSET, new Tizen.NUI.PropertyValue(value));
460 /// ShadowColor property.<br>
461 /// The color of a drop shadow.<br>
463 public Vector4 ShadowColor
467 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
468 GetProperty(TextLabel.Property.SHADOW_COLOR).Get(temp);
473 SetProperty(TextLabel.Property.SHADOW_COLOR, new Tizen.NUI.PropertyValue(value));
478 /// UnderlineEnabled property.<br>
479 /// The underline enabled flag.<br>
481 public bool UnderlineEnabled
486 GetProperty(TextLabel.Property.UNDERLINE_ENABLED).Get(ref temp);
491 SetProperty(TextLabel.Property.UNDERLINE_ENABLED, new Tizen.NUI.PropertyValue(value));
496 /// UnderlineColor property.<br>
497 /// Overrides the underline height from font metrics.<br>
499 public Vector4 UnderlineColor
503 Vector4 temp = new Vector4(0.0f, 0.0f, 0.0f, 0.0f);
504 GetProperty(TextLabel.Property.UNDERLINE_COLOR).Get(temp);
509 SetProperty(TextLabel.Property.UNDERLINE_COLOR, new Tizen.NUI.PropertyValue(value));
514 /// UnderlineHeight property.<br>
515 /// Overrides the underline height from font metrics.<br>
517 public float UnderlineHeight
522 GetProperty(TextLabel.Property.UNDERLINE_HEIGHT).Get(ref temp);
527 SetProperty(TextLabel.Property.UNDERLINE_HEIGHT, new Tizen.NUI.PropertyValue(value));
532 /// EnableMarkup property.<br>
533 /// Whether the mark-up processing is enabled.<br>
535 public bool EnableMarkup
540 GetProperty(TextLabel.Property.ENABLE_MARKUP).Get(ref temp);
545 SetProperty(TextLabel.Property.ENABLE_MARKUP, new Tizen.NUI.PropertyValue(value));
550 /// EnableAutoScroll property.<br>
551 /// Starts or stops auto scrolling.<br>
553 public bool EnableAutoScroll
558 GetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL).Get(ref temp);
563 SetProperty(TextLabel.Property.ENABLE_AUTO_SCROLL, new Tizen.NUI.PropertyValue(value));
568 /// AutoScrollSpeed property.<br>
569 /// Sets the speed of scrolling in pixels per second.<br>
571 public int AutoScrollSpeed
576 GetProperty(TextLabel.Property.AUTO_SCROLL_SPEED).Get(ref temp);
581 SetProperty(TextLabel.Property.AUTO_SCROLL_SPEED, new Tizen.NUI.PropertyValue(value));
586 /// AutoScrollLoopCount property.<br>
587 /// Number of complete loops when scrolling enabled.<br>
589 public int AutoScrollLoopCount
594 GetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT).Get(ref temp);
599 SetProperty(TextLabel.Property.AUTO_SCROLL_LOOP_COUNT, new Tizen.NUI.PropertyValue(value));
604 /// AutoScrollGap property.<br>
605 /// Gap before scrolling wraps.<br>
607 public float AutoScrollGap
612 GetProperty(TextLabel.Property.AUTO_SCROLL_GAP).Get(ref temp);
617 SetProperty(TextLabel.Property.AUTO_SCROLL_GAP, new Tizen.NUI.PropertyValue(value));
622 /// LineSpacing property.<br>
623 /// The default extra space between lines in points.<br>
625 public float LineSpacing
630 GetProperty(TextLabel.Property.LINE_SPACING).Get(ref temp);
635 SetProperty(TextLabel.Property.LINE_SPACING, new Tizen.NUI.PropertyValue(value));
640 /// Underline property.<br>
641 /// The default underline parameters.<br>
643 public PropertyMap Underline
647 PropertyMap temp = new PropertyMap();
648 GetProperty(TextLabel.Property.UNDERLINE).Get(temp);
653 SetProperty(TextLabel.Property.UNDERLINE, new Tizen.NUI.PropertyValue(value));
658 /// Shadow property.<br>
659 /// The default shadow parameters.<br>
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 /// Emboss property.<br>
677 /// The default emboss parameters.<br>
684 GetProperty(TextLabel.Property.EMBOSS).Get( out temp);
689 SetProperty(TextLabel.Property.EMBOSS, new Tizen.NUI.PropertyValue(value));
694 /// Outline property.<br>
695 /// The default outline parameters.<br>
697 public string Outline
702 GetProperty(TextLabel.Property.OUTLINE).Get(out temp);
707 SetProperty(TextLabel.Property.OUTLINE, new Tizen.NUI.PropertyValue(value));
712 /// PixelSize property.<br>
713 /// The size of font in pixels.<br>
715 public float PixelSize
720 GetProperty(TextLabel.Property.PIXEL_SIZE).Get(ref temp);
725 SetProperty(TextLabel.Property.PIXEL_SIZE, new Tizen.NUI.PropertyValue(value));
730 /// Ellipsis property.<br>
731 /// Enable or disable the ellipsis.<br>
738 GetProperty(TextLabel.Property.ELLIPSIS).Get(ref temp);
743 SetProperty(TextLabel.Property.ELLIPSIS, new Tizen.NUI.PropertyValue(value));