

<!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>TLShapedAttributedString &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="TLShapedParagraph" href="class_tlshapedparagraph.html" />
    <link rel="prev" title="TLRichTextEditSelection" href="class_tlrichtexteditselection.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"><a class="reference internal" href="class_tllabel.html">TLLabel</a><ul>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#brief-description">Brief Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#properties">Properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#methods">Methods</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#enumerations">Enumerations</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#description">Description</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#property-descriptions">Property Descriptions</a></li>
<li class="toctree-l3"><a class="reference internal" href="class_tllabel.html#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 current"><a class="current reference internal" href="#">TLShapedAttributedString</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="#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_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>TLShapedAttributedString</li>
    
    


  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="tlshapedattributedstring">
<span id="class-tlshapedattributedstring"></span><h1>TLShapedAttributedString<a class="headerlink" href="#tlshapedattributedstring" title="Permalink to this headline">¶</a></h1>
<p><strong>Inherits:</strong> <a class="reference internal" href="class_tlshapedstring.html#class-tlshapedstring"><span class="std std-ref">TLShapedString</span></a></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>Golds shaped line of text with associated attributes.</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: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>Array</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-property-attributes-dict"><span class="std std-ref">attributes_dict</span></a></p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-property-attribute-type"><span class="std std-ref">attribute/type</span></a></p></td>
</tr>
<tr class="row-odd"><td><p>Variant</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-property-attribute-value"><span class="std std-ref">attribute/value</span></a></p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-property-attribute-start"><span class="std std-ref">attribute/start</span></a></p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-property-attribute-end"><span class="std std-ref">attribute/end</span></a></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>void</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-add-attribute"><span class="std std-ref">add_attribute</span></a> <strong>(</strong> int attribute, Variant value, int start, int end <strong>)</strong></p></td>
</tr>
<tr class="row-even"><td><p>void</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-clear-attributes"><span class="std std-ref">clear_attributes</span></a> <strong>(</strong> <strong>)</strong></p></td>
</tr>
<tr class="row-odd"><td><p>void</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-commit-attribute"><span class="std std-ref">commit_attribute</span></a> <strong>(</strong> <strong>)</strong></p></td>
</tr>
<tr class="row-even"><td><p>Variant</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-get-attribute"><span class="std std-ref">get_attribute</span></a> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></td>
</tr>
<tr class="row-odd"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-get-attribute-end"><span class="std std-ref">get_attribute_end</span></a> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></td>
</tr>
<tr class="row-even"><td><p>int</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-get-attribute-start"><span class="std std-ref">get_attribute_start</span></a> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></td>
</tr>
<tr class="row-odd"><td><p>Array</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-get-embedded-rects"><span class="std std-ref">get_embedded_rects</span></a> <strong>(</strong> <strong>)</strong></p></td>
</tr>
<tr class="row-even"><td><p>bool</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-has-attribute"><span class="std std-ref">has_attribute</span></a> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></td>
</tr>
<tr class="row-odd"><td><p>void</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-load-attributes-dict"><span class="std std-ref">load_attributes_dict</span></a> <strong>(</strong> Array array <strong>)</strong></p></td>
</tr>
<tr class="row-even"><td><p>void</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-remove-attribute"><span class="std std-ref">remove_attribute</span></a> <strong>(</strong> int attribute, int start, int end <strong>)</strong></p></td>
</tr>
<tr class="row-odd"><td><p>void</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-remove-attributes"><span class="std std-ref">remove_attributes</span></a> <strong>(</strong> int start, int end <strong>)</strong></p></td>
</tr>
<tr class="row-even"><td><p>Array</p></td>
<td><p><a class="reference internal" href="#class-tlshapedattributedstring-method-save-attributes-dict"><span class="std std-ref">save_attributes_dict</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-tlshapedattributedstring-constant-text-attribute-meta"><span id="class-tlshapedattributedstring-constant-text-attribute-highlight-color"></span><span id="class-tlshapedattributedstring-constant-text-attribute-overline-width"></span><span id="class-tlshapedattributedstring-constant-text-attribute-overline-color"></span><span id="class-tlshapedattributedstring-constant-text-attribute-strikethrough-width"></span><span id="class-tlshapedattributedstring-constant-text-attribute-strikethrough-color"></span><span id="class-tlshapedattributedstring-constant-text-attribute-underline-width"></span><span id="class-tlshapedattributedstring-constant-text-attribute-underline-color"></span><span id="class-tlshapedattributedstring-constant-text-attribute-outline-color"></span><span id="class-tlshapedattributedstring-constant-text-attribute-color"></span><span id="class-tlshapedattributedstring-constant-text-attribute-replacement-valign"></span><span id="class-tlshapedattributedstring-constant-text-attribute-replacement-id"></span><span id="class-tlshapedattributedstring-constant-text-attribute-replacement-rect"></span><span id="class-tlshapedattributedstring-constant-text-attribute-replacement-image"></span><span id="class-tlshapedattributedstring-constant-text-attribute-language"></span><span id="class-tlshapedattributedstring-constant-text-attribute-font-features"></span><span id="class-tlshapedattributedstring-constant-text-attribute-font-size"></span><span id="class-tlshapedattributedstring-constant-text-attribute-font-style"></span><span id="class-tlshapedattributedstring-constant-text-attribute-font"></span><span id="enum-tlshapedattributedstring-textattribute"></span>enum <strong>TextAttribute</strong>:</p>
<ul class="simple">
<li><p><strong>TEXT_ATTRIBUTE_FONT</strong> = <strong>1</strong> — Font family. Attribute type: <a class="reference internal" href="class_tlfontfamily.html#class-tlfontfamily"><span class="std std-ref">TLFontFamily</span></a></p></li>
<li><p><strong>TEXT_ATTRIBUTE_FONT_STYLE</strong> = <strong>2</strong> — Font style (Regular, Bold, Italic, Oblique etc.). Attribute type: String</p></li>
<li><p><strong>TEXT_ATTRIBUTE_FONT_SIZE</strong> = <strong>3</strong> — Font size. Attribute type: <code class="docutils literal notranslate"><span class="pre">int</span></code></p></li>
<li><p><strong>TEXT_ATTRIBUTE_FONT_FEATURES</strong> = <strong>4</strong> — Comma separated list of OpenType feature tags. More info: <a class="reference external" href="https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags">https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags</a>. Attribute type: String</p></li>
<li><p><strong>TEXT_ATTRIBUTE_LANGUAGE</strong> = <strong>5</strong> — Language code for line-breaking and text shaping algorithms. Attribute type: String</p></li>
<li><p><strong>TEXT_ATTRIBUTE_REPLACEMENT_IMAGE</strong> = <strong>6</strong> — Embedded image. Attribute type: Texture</p></li>
<li><p><strong>TEXT_ATTRIBUTE_REPLACEMENT_RECT</strong> = <strong>7</strong> — Reserved space for custom embedded object. Attribute type: Vector2</p></li>
<li><p><strong>TEXT_ATTRIBUTE_REPLACEMENT_ID</strong> = <strong>8</strong> — Embedded object id key. Attribute type: Variant</p></li>
<li><p><strong>TEXT_ATTRIBUTE_REPLACEMENT_VALIGN</strong> = <strong>9</strong> — Embedded image/object inline alignment. Attribute type: <code class="docutils literal notranslate"><span class="pre">TEXT_VALIGN_*</span></code></p></li>
<li><p><strong>TEXT_ATTRIBUTE_COLOR</strong> = <strong>31</strong> — Text color. Attribute type: Color</p></li>
<li><p><strong>TEXT_ATTRIBUTE_OUTLINE_COLOR</strong> = <strong>32</strong> — Text outline color. Attribute type: Color</p></li>
<li><p><strong>TEXT_ATTRIBUTE_UNDERLINE_COLOR</strong> = <strong>41</strong> — Underline color. Attribute type: Color</p></li>
<li><p><strong>TEXT_ATTRIBUTE_UNDERLINE_WIDTH</strong> = <strong>42</strong> — Underline width. Attribute type: <code class="docutils literal notranslate"><span class="pre">int</span></code></p></li>
<li><p><strong>TEXT_ATTRIBUTE_STRIKETHROUGH_COLOR</strong> = <strong>51</strong> — Strike through line color. Attribute type: Color</p></li>
<li><p><strong>TEXT_ATTRIBUTE_STRIKETHROUGH_WIDTH</strong> = <strong>52</strong> — Strike through line width. Attribute type: <code class="docutils literal notranslate"><span class="pre">int</span></code></p></li>
<li><p><strong>TEXT_ATTRIBUTE_OVERLINE_COLOR</strong> = <strong>61</strong> — Overline color/ Attribute type: Color</p></li>
<li><p><strong>TEXT_ATTRIBUTE_OVERLINE_WIDTH</strong> = <strong>62</strong> — Overline width. Attribute type: <code class="docutils literal notranslate"><span class="pre">int</span></code></p></li>
<li><p><strong>TEXT_ATTRIBUTE_HIGHLIGHT_COLOR</strong> = <strong>71</strong> — Highlight color. Attribute type: Color</p></li>
<li><p><strong>TEXT_ATTRIBUTE_META</strong> = <strong>100</strong> — User defined data, use <code class="docutils literal notranslate"><span class="pre">TEXT_ATTRIBUTE_META</span> <span class="pre">+</span> <span class="pre">x</span></code> to define multiple user attributes. Attribute type: Variant</p></li>
</ul>
<hr class="docutils" />
<p id="class-tlshapedattributedstring-constant-text-valign-bottom"><span id="class-tlshapedattributedstring-constant-text-valign-center"></span><span id="class-tlshapedattributedstring-constant-text-valign-top"></span><span id="enum-tlshapedattributedstring-textvalign"></span>enum <strong>TextVAlign</strong>:</p>
<ul class="simple">
<li><p><strong>TEXT_VALIGN_TOP</strong> = <strong>0</strong> — Inline vertical top alignment.</p></li>
<li><p><strong>TEXT_VALIGN_CENTER</strong> = <strong>1</strong> — Inline vertical center alignment.</p></li>
<li><p><strong>TEXT_VALIGN_BOTTOM</strong> = <strong>2</strong> — Inline vertical bottom alignment.</p></li>
</ul>
</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-tlshapedattributedstring-property-attributes-dict">
<li><p>Array <strong>attributes_dict</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>load_attributes_dict(value)</p></td>
</tr>
<tr class="row-even"><td><p><em>Getter</em></p></td>
<td><p>save_attributes_dict()</p></td>
</tr>
</tbody>
</table>
<p>Array of attribute Dictionary.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-property-attribute-type">
<li><p>int <strong>attribute/type</strong></p></li>
</ul>
<p>Temporary attribute type, temporary attributes can be committed to the string by calling <a class="reference internal" href="#class-tlshapedattributedstring-method-commit-attribute"><span class="std std-ref">commit_attribute</span></a>.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-property-attribute-value">
<li><p>Variant <strong>attribute/value</strong></p></li>
</ul>
<p>Temporary attribute value, temporary attributes can be committed to the string by calling <a class="reference internal" href="#class-tlshapedattributedstring-method-commit-attribute"><span class="std std-ref">commit_attribute</span></a>.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-property-attribute-start">
<li><p>int <strong>attribute/start</strong></p></li>
</ul>
<p>Temporary attribute start offset, temporary attributes can be committed to the string by calling <a class="reference internal" href="#class-tlshapedattributedstring-method-commit-attribute"><span class="std std-ref">commit_attribute</span></a>.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-property-attribute-end">
<li><p>int <strong>attribute/end</strong></p></li>
</ul>
<p>Temporary attribute end offset, temporary attributes can be committed to the string by calling <a class="reference internal" href="#class-tlshapedattributedstring-method-commit-attribute"><span class="std std-ref">commit_attribute</span></a>.</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-tlshapedattributedstring-method-add-attribute">
<li><p>void <strong>add_attribute</strong> <strong>(</strong> int attribute, Variant value, int start, int end <strong>)</strong></p></li>
</ul>
<p>Sets <code class="docutils literal notranslate"><span class="pre">attribute</span></code> attribute to <code class="docutils literal notranslate"><span class="pre">value</span></code> for specified text range.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-clear-attributes">
<li><p>void <strong>clear_attributes</strong> <strong>(</strong> <strong>)</strong></p></li>
</ul>
<p>Removes all attributes.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-commit-attribute">
<li><p>void <strong>commit_attribute</strong> <strong>(</strong> <strong>)</strong></p></li>
</ul>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-get-attribute">
<li><p>Variant <strong>get_attribute</strong> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></li>
</ul>
<p>Returns <code class="docutils literal notranslate"><span class="pre">attribute</span></code> attribute value for specified text position.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-get-attribute-end">
<li><p>int <strong>get_attribute_end</strong> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></li>
</ul>
<p>Returns last position of <code class="docutils literal notranslate"><span class="pre">attribute</span></code> attribute run enclosing specified position.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-get-attribute-start">
<li><p>int <strong>get_attribute_start</strong> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></li>
</ul>
<p>Returns first position of <code class="docutils literal notranslate"><span class="pre">attribute</span></code> attribute run enclosing specified position.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-get-embedded-rects">
<li><p>Array <strong>get_embedded_rects</strong> <strong>(</strong> <strong>)</strong></p></li>
</ul>
<p>Returns bounding rectangles of embedded objects (<code class="docutils literal notranslate"><span class="pre">TEXT_ATTRIBUTE_REPLACEMENT_RECT</span></code> attributes).</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-has-attribute">
<li><p>bool <strong>has_attribute</strong> <strong>(</strong> int attribute, int index <strong>)</strong> const</p></li>
</ul>
<p>Returns <code class="docutils literal notranslate"><span class="pre">true</span></code> if specified position has <code class="docutils literal notranslate"><span class="pre">attribute</span></code> attribute set.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-load-attributes-dict">
<li><p>void <strong>load_attributes_dict</strong> <strong>(</strong> Array array <strong>)</strong></p></li>
</ul>
<p>Loads attributes from Array of Dictionary.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-remove-attribute">
<li><p>void <strong>remove_attribute</strong> <strong>(</strong> int attribute, int start, int end <strong>)</strong></p></li>
</ul>
<p>Removes <code class="docutils literal notranslate"><span class="pre">attribute</span></code> attribute for specified text range.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-remove-attributes">
<li><p>void <strong>remove_attributes</strong> <strong>(</strong> int start, int end <strong>)</strong></p></li>
</ul>
<p>Removes all attributes for specified text range.</p>
<hr class="docutils" />
<ul class="simple" id="class-tlshapedattributedstring-method-save-attributes-dict">
<li><p>Array <strong>save_attributes_dict</strong> <strong>(</strong> <strong>)</strong> const</p></li>
</ul>
<p>Stores string attributes into Array of Dictionary.</p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="class_tlshapedparagraph.html" class="btn btn-neutral float-right" title="TLShapedParagraph" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="class_tlrichtexteditselection.html" class="btn btn-neutral float-left" title="TLRichTextEditSelection" 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>