

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>TLLabel &mdash; libgdtl latest documentation</title>
  

  
  
  
  

  
  <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script type="text/javascript" src="../_static/jquery.js"></script>
        <script type="text/javascript" src="../_static/underscore.js"></script>
        <script type="text/javascript" src="../_static/doctools.js"></script>
        <script type="text/javascript" src="../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="TLLineEdit" href="class_tllineedit.html" />
    <link rel="prev" title="TLICUDataLoader" href="class_tlicudataloader.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html">
          

          
            
            <img src="../_static/docs_logo.png" class="logo" alt="Logo"/>
          
          </a>

          
            
            
              <div class="version">
                latest
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">libgdtl introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#dependencies">Dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#compiling-as-builtin-module">Compiling (as builtin module)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../about/index.html#build-options">Build options</a></li>
<li class="toctree-l3"><a class="reference internal" href="../about/index.html#building-libdgtl-module">Building <cite>libdgtl</cite> module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#compiling-as-gdnative-module">Compiling (as gdnative module)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../about/index.html#id1">Build options</a></li>
<li class="toctree-l3"><a class="reference internal" href="../about/index.html#building-godot-cpp-static-library">Building <cite>godot-cpp</cite> static library</a></li>
<li class="toctree-l3"><a class="reference internal" href="../about/index.html#id2">Building <cite>libdgtl</cite> module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#license">License</a></li>
<li class="toctree-l2"><a class="reference internal" href="../about/index.html#demo-data">Demo data</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/installation.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/installation.html#module">Module</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/installation.html#gdnative">GDNative</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/font_substitution.html">Font substitution</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/rich_text_typesetting.html">Rich text typesetting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/rich_text_typesetting.html#setting-formatting-for-the-range-of-text">Setting formatting for the range of text</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/rich_text_typesetting.html#removing-formatting">Removing formatting</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/rich_text_typesetting.html#embedding-child-control-into-the-text-flow">Embedding child control into the text flow</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../development/compiling_desktop.html">Compiling GDNative module for Windows, macOS and Linux</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_desktop.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_desktop.html#building-godot-cpp-static-library">Building <cite>godot-cpp</cite> static library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_desktop.html#building-libgdtl-static-library-and-built-in-dependencies">Building <cite>libgdtl</cite> static library and built-in dependencies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../development/compiling_android.html">Compiling GDNative module for Android</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_android.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_android.html#building-godot-cpp-static-library">Building <cite>godot-cpp</cite> static library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_android.html#building-libgdtl-static-library-and-built-in-dependencies">Building <cite>libgdtl</cite> static library and built-in dependencies</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../development/compiling_ios.html">Compiling GDNative module for iOS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_ios.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_ios.html#building-godot-cpp-static-library">Building <cite>godot-cpp</cite> static library</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_ios.html#building-libgdtl-static-library-and-built-in-dependencies">Building <cite>libgdtl</cite> static library and built-in dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="../development/compiling_ios.html#adding-libgdtl-static-library-to-the-exported-xcode-project">Adding <cite>libgdtl</cite> static library to the exported Xcode project</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Class reference</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">libgdtl API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="class_tlbitmapfontface.html">TLBitmapFontFace</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlbitmapfontface.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlbitmapfontface.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlbitmapfontface.html#description">Description</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tldynamicfontface.html">TLDynamicFontFace</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tldynamicfontface.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tldynamicfontface.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tldynamicfontface.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tldynamicfontface.html#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tldynamicfontface.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tldynamicfontface.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlfontface.html">TLFontFace</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontface.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontface.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontface.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontface.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontface.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlfontfamily.html">TLFontFamily</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontfamily.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontfamily.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontfamily.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontfamily.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontfamily.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlfontiterator.html">TLFontIterator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontiterator.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontiterator.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlfontiterator.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlgdfontwrapper.html">TLGDFontWrapper</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlgdfontwrapper.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlgdfontwrapper.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlgdfontwrapper.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlgdfontwrapper.html#property-descriptions">Property Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlicudataloader.html">TLICUDataLoader</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlicudataloader.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlicudataloader.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlicudataloader.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlicudataloader.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlicudataloader.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">TLLabel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tllineedit.html">TLLineEdit</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#signals">Signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllineedit.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlrichtextedit.html">TLRichTextEdit</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtextedit.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtextedit.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtextedit.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtextedit.html#signals">Signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtextedit.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtextedit.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlrichtexteditselection.html">TLRichTextEditSelection</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtexteditselection.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtexteditselection.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtexteditselection.html#signals">Signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlrichtexteditselection.html#property-descriptions">Property Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlshapedattributedstring.html">TLShapedAttributedString</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedattributedstring.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedattributedstring.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedattributedstring.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedattributedstring.html#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedattributedstring.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedattributedstring.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlshapedparagraph.html">TLShapedParagraph</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#signals">Signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedparagraph.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="class_tlshapedstring.html">TLShapedString</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#signals">Signals</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tlshapedstring.html#method-descriptions">Method Descriptions</a></li>
</ul>
</li>
</ul>
</li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">libgdtl</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html">Docs</a> &raquo;</li>
        
          <li><a href="index.html">libgdtl API</a> &raquo;</li>
        
      <li>TLLabel</li>
    
    


  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="tllabel">
<span id="class-tllabel"></span><h1>TLLabel<a class="headerlink" href="#tllabel" title="Permalink to this headline">¶</a></h1>
<p><strong>Inherits:</strong></p>
<p><strong>Category:</strong> Core</p>
<div class="section" id="brief-description">
<h2>Brief Description<a class="headerlink" href="#brief-description" title="Permalink to this headline">¶</a></h2>
<p>Displays plain text in a line or wrapped inside a rectangle. For formatted text, use <a class="reference internal" href="class_tlrichtextedit.html#class-tlrichtextedit"><span class="std std-ref">TLRichTextEdit</span></a>.</p>
<p>Copy of Godot Label with the shaping support. TLLabel uses the same theme items as the Label.</p>
</div>
<div class="section" id="properties">
<h2>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h2>
<table class="docutils align-default">
<colgroup>
<col style="width: 34%" />
<col style="width: 57%" />
<col style="width: 9%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-align"><span class="std std-ref">align</span></a></p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>bool</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-autowrap"><span class="std std-ref">autowrap</span></a></p></td>
<td><p>false</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="class_tlfontfamily.html#class-tlfontfamily"><span class="std std-ref">TLFontFamily</span></a></p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-base-font"><span class="std std-ref">base_font</span></a></p></td>
<td></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-base-font-size"><span class="std std-ref">base_font_size</span></a></p></td>
<td><p>12</p></td>
</tr>
<tr class="row-odd"><td><p>String</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-base-font-style"><span class="std std-ref">base_font_style</span></a></p></td>
<td><p>“Regular”</p></td>
</tr>
<tr class="row-even"><td><p>bool</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-clip-text"><span class="std std-ref">clip_text</span></a></p></td>
<td><p>false</p></td>
</tr>
<tr class="row-odd"><td><p>String</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-language"><span class="std std-ref">language</span></a></p></td>
<td><p>“”</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-lines-skipped"><span class="std std-ref">lines_skipped</span></a></p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-max-lines-visible"><span class="std std-ref">max_lines_visible</span></a></p></td>
<td><p>-1</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p>mouse_filter</p></td>
<td><p><strong>O:</strong> 2</p></td>
</tr>
<tr class="row-odd"><td><p>String</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-ot-features"><span class="std std-ref">ot_features</span></a></p></td>
<td><p>“”</p></td>
</tr>
<tr class="row-even"><td><p>float</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-percent-visible"><span class="std std-ref">percent_visible</span></a></p></td>
<td><p>1.0</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p>size_flags_vertical</p></td>
<td><p><strong>O:</strong> 4</p></td>
</tr>
<tr class="row-even"><td><p>String</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-text"><span class="std std-ref">text</span></a></p></td>
<td><p>“”</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-text-direction"><span class="std std-ref">text_direction</span></a></p></td>
<td><p>3</p></td>
</tr>
<tr class="row-even"><td><p>bool</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-uppercase"><span class="std std-ref">uppercase</span></a></p></td>
<td><p>false</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-valign"><span class="std std-ref">valign</span></a></p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-property-visible-characters"><span class="std std-ref">visible_characters</span></a></p></td>
<td><p>-1</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="methods">
<h2>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h2>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-method-get-line-count"><span class="std std-ref">get_line_count</span></a> <strong>(</strong> <strong>)</strong> const</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-method-get-line-height"><span class="std std-ref">get_line_height</span></a> <strong>(</strong> <strong>)</strong> const</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-method-get-total-character-count"><span class="std std-ref">get_total_character_count</span></a> <strong>(</strong> <strong>)</strong> const</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tllabel-method-get-visible-line-count"><span class="std std-ref">get_visible_line_count</span></a> <strong>(</strong> <strong>)</strong> const</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="enumerations">
<h2>Enumerations<a class="headerlink" href="#enumerations" title="Permalink to this headline">¶</a></h2>
<p id="class-tllabel-constant-align-fill"><span id="class-tllabel-constant-align-right"></span><span id="class-tllabel-constant-align-center"></span><span id="class-tllabel-constant-align-left"></span><span id="enum-tllabel-align"></span>enum <strong>Align</strong>:</p>
<ul class="simple">
<li><p><strong>ALIGN_LEFT</strong> = <strong>0</strong> — Align rows to the left (default).</p></li>
<li><p><strong>ALIGN_CENTER</strong> = <strong>1</strong> — Align rows centered.</p></li>
<li><p><strong>ALIGN_RIGHT</strong> = <strong>2</strong> — Align rows to the right.</p></li>
<li><p><strong>ALIGN_FILL</strong> = <strong>3</strong> — Expand row white spaces to fit the width.</p></li>
</ul>
<hr class="docutils" />
<p id="class-tllabel-constant-valign-fill"><span id="class-tllabel-constant-valign-bottom"></span><span id="class-tllabel-constant-valign-center"></span><span id="class-tllabel-constant-valign-top"></span><span id="enum-tllabel-valign"></span>enum <strong>VAlign</strong>:</p>
<ul class="simple">
<li><p><strong>VALIGN_TOP</strong> = <strong>0</strong> — Align the whole text to the top.</p></li>
<li><p><strong>VALIGN_CENTER</strong> = <strong>1</strong> — Align the whole text to the center.</p></li>
<li><p><strong>VALIGN_BOTTOM</strong> = <strong>2</strong> — Align the whole text to the bottom.</p></li>
<li><p><strong>VALIGN_FILL</strong> = <strong>3</strong> — Align the whole text by spreading the rows.</p></li>
</ul>
</div>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment, and can wrap the text inside the node’s bounding rectangle. It doesn’t support bold, italics or other formatting. For that, use RichTextLabel instead.</p>
</div>
<div class="section" id="property-descriptions">
<h2>Property Descriptions<a class="headerlink" href="#property-descriptions" title="Permalink to this headline">¶</a></h2>
<ul class="simple" id="class-tllabel-property-align">
<li><p>int <strong>align</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_align(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_align()</p></td>
</tr>
</tbody>
</table>
<p>Controls the text’s horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the <code class="docutils literal notranslate"><span class="pre">ALIGN_*</span></code> constants.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-autowrap">
<li><p>bool <strong>autowrap</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>false</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_autowrap(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>has_autowrap()</p></td>
</tr>
</tbody>
</table>
<p>If <code class="docutils literal notranslate"><span class="pre">true</span></code>, wraps the text inside the node’s bounding rectangle. If you resize the node, it will change its height automatically to show all the text.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-base-font">
<li><p><a class="reference internal" href="class_tlfontfamily.html#class-tlfontfamily"><span class="std std-ref">TLFontFamily</span></a> <strong>base_font</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Setter</em></p></td>
<td><p>set_base_font(value)</p></td>
</tr>
<tr class="row-even"><td><p><em>Getter</em></p></td>
<td><p>get_base_font()</p></td>
</tr>
</tbody>
</table>
<p>Base font.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-base-font-size">
<li><p>int <strong>base_font_size</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>12</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_base_font_size(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_base_font_size()</p></td>
</tr>
</tbody>
</table>
<p>Base font size.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-base-font-style">
<li><p>String <strong>base_font_style</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>“Regular”</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_base_font_style(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_base_font_style()</p></td>
</tr>
</tbody>
</table>
<p>Base font style.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-clip-text">
<li><p>bool <strong>clip_text</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>false</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_clip_text(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>is_clipping_text()</p></td>
</tr>
</tbody>
</table>
<p>If <code class="docutils literal notranslate"><span class="pre">true</span></code>, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-language">
<li><p>String <strong>language</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>“”</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_language(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_language()</p></td>
</tr>
</tbody>
</table>
<p>Language code for line-breaking and text shaping algorithms.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-lines-skipped">
<li><p>int <strong>lines_skipped</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_lines_skipped(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_lines_skipped()</p></td>
</tr>
</tbody>
</table>
<p>The node ignores the first <code class="docutils literal notranslate"><span class="pre">lines_skipped</span></code> lines before it starts to display text.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-max-lines-visible">
<li><p>int <strong>max_lines_visible</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>-1</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_max_lines_visible(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_max_lines_visible()</p></td>
</tr>
</tbody>
</table>
<p>Limits the lines of text the node shows on screen.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-ot-features">
<li><p>String <strong>ot_features</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>“”</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_ot_features(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_ot_features()</p></td>
</tr>
</tbody>
</table>
<p>Comma separated list of OpenType feature tags.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-percent-visible">
<li><p>float <strong>percent_visible</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>1.0</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_percent_visible(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_percent_visible()</p></td>
</tr>
</tbody>
</table>
<p>Limits the count of visible characters. If you set <code class="docutils literal notranslate"><span class="pre">percent_visible</span></code> to 50, only up to half of the text’s characters will display on screen. Useful to animate the text in a dialog box.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-text">
<li><p>String <strong>text</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>“”</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_text(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_text()</p></td>
</tr>
</tbody>
</table>
<p>The text to display on screen.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-text-direction">
<li><p>int <strong>text_direction</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>3</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_text_direction(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_text_direction()</p></td>
</tr>
</tbody>
</table>
<p>Base direction of the text.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-uppercase">
<li><p>bool <strong>uppercase</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>false</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_uppercase(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>is_uppercase()</p></td>
</tr>
</tbody>
</table>
<p>If <code class="docutils literal notranslate"><span class="pre">true</span></code>, all the text displays as UPPERCASE.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-valign">
<li><p>int <strong>valign</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_valign(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_valign()</p></td>
</tr>
</tbody>
</table>
<p>Controls the text’s vertical align. Supports top, center, bottom, and fill. Set it to one of the <code class="docutils literal notranslate"><span class="pre">VALIGN_*</span></code> constants.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-property-visible-characters">
<li><p>int <strong>visible_characters</strong></p></li>
</ul>
<table class="longtable colwidths-given docutils align-default">
<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><em>Default</em></p></td>
<td><p>-1</p></td>
</tr>
<tr class="row-even"><td><p><em>Setter</em></p></td>
<td><p>set_visible_characters(value)</p></td>
</tr>
<tr class="row-odd"><td><p><em>Getter</em></p></td>
<td><p>get_visible_characters()</p></td>
</tr>
</tbody>
</table>
<p>Restricts the number of characters to display. Set to -1 to disable.</p>
</div>
<div class="section" id="method-descriptions">
<h2>Method Descriptions<a class="headerlink" href="#method-descriptions" title="Permalink to this headline">¶</a></h2>
<ul class="simple" id="class-tllabel-method-get-line-count">
<li><p>int <strong>get_line_count</strong> <strong>(</strong> <strong>)</strong> const</p></li>
</ul>
<p>Returns the amount of lines of text the Label has.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-method-get-line-height">
<li><p>int <strong>get_line_height</strong> <strong>(</strong> <strong>)</strong> const</p></li>
</ul>
<p>Returns the of the line in pixels.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-method-get-total-character-count">
<li><p>int <strong>get_total_character_count</strong> <strong>(</strong> <strong>)</strong> const</p></li>
</ul>
<p>Returns the total number of printable characters in the text.</p>
<hr class="docutils" />
<ul class="simple" id="class-tllabel-method-get-visible-line-count">
<li><p>int <strong>get_visible_line_count</strong> <strong>(</strong> <strong>)</strong> const</p></li>
</ul>
<p>Returns the number of lines shown. Useful if the Label’s height cannot currently display all lines.</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="class_tllineedit.html" class="btn btn-neutral float-right" title="TLLineEdit" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="class_tlicudataloader.html" class="btn btn-neutral float-left" title="TLICUDataLoader" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>