text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>TLLineEdit — libgdtl latest documentation</title>

  <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="TLRichTextEdit" href="class_tlrichtextedit.html" />
    <link rel="prev" title="TLLabel" href="class_tllabel.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl API »

TLLineEdit

TLLineEdit¶

Inherits:

Category: Core

Brief Description¶

Control that provides single-line string editing. For formatted or/and multiline text, use TLRichTextEdit.

Copy of Godot LineEdit with the shaping support. TLLineEdit uses the same theme items as the LineEdit.

Properties¶

<colgroup>
<col style="width: 31%" />
<col style="width: 60%" />
<col style="width: 8%" />
</colgroup>

int

align

0

TLFontFamily

base_font

int

base_font_size

12

String

base_font_style

“Regular”

bool

caret_blink

false

float

caret_blink_speed

0.65

int

caret_position

0

bool

clear_button_enabled

false

bool

context_menu_enabled

true

bool

editable

true

bool

expand_to_text_length

false

int

focus_mode

O: 2

String

language

“”

int

max_length

0

Control.CursorShape

mouse_default_cursor_shape

O: 1

String

ot_features

“”

float

placeholder_alpha

0.6

String

placeholder_text

“”

bool

secret

false

String

secret_character

“*”

String

text

“”

int

text_direction

3

Methods¶

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

void

append_at_cursor ( String text )

void

clear ( )

void

deselect ( )

PopupMenu

get_menu ( ) const

void

menu_option ( int option )

void

select ( int from=0, int to=-1 )

void

select_all ( )

Signals¶

text_changed ( String new_text )

Emitted when the text changes.

text_entered ( String new_text )

Emitted when the user presses KEY_ENTER on the TLLineEdit.

Enumerations¶

enum Align:

ALIGN_LEFT = 0 — Aligns the text on the left-hand side of the TLLineEdit.

ALIGN_CENTER = 1 — Centers the text in the middle of the TLLineEdit.

ALIGN_RIGHT = 2 — Aligns the text on the right-hand side of the TLLineEdit.

ALIGN_FILL = 3 — Stretches white spaces to fit the TLLineEdit’s width.

enum MenuItems:

MENU_CUT = 0 — Cuts (copies and clears) the selected text.

MENU_COPY = 1 — Copies the selected text.

MENU_PASTE = 2 — Pastes the clipboard text over the selected text (or at the cursor’s position).

Non-printable escape characters are automatically stripped from the OS clipboard via String.strip_escapes.

MENU_CLEAR = 3 — Erases the whole TLLineEdit text.

MENU_SELECT_ALL = 4 — Selects the whole TLLineEdit text.

MENU_UNDO = 5 — Undoes the previous action.

MENU_REDO = 6 — Reverse the last undo action.

MENU_MAX = 7 — Represents the size of the MenuItems enum.

Description¶

TLLineEdit provides a single-line string editor, used for text fields. It features many built-in shortcuts which will always be available:

Ctrl + C: Copy

Ctrl + X: Cut

Ctrl + V or Ctrl + Y: Paste/”yank”

Ctrl + Z: Undo

Ctrl + Shift + Z: Redo

Ctrl + U: Delete text from the cursor position to the beginning of the line

Ctrl + K: Delete text from the cursor position to the end of the line

Ctrl + A: Select all text

Ctrl + D: Swap current input direction (primary cursor)

Up/Down arrow: Move the cursor to the beginning/end of the line

Property Descriptions¶

int align

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_align(value)

Getter

get_align()

Text alignment as defined in the ALIGN_* enum.

TLFontFamily base_font

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Setter

set_base_font(value)

Getter

get_base_font()

Base font.

int base_font_size

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

12

Setter

set_base_font_size(value)

Getter

get_base_font_size()

Base font size.

String base_font_style

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“Regular”

Setter

set_base_font_style(value)

Getter

get_base_font_style()

Base font style.

bool caret_blink

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

cursor_set_blink_enabled(value)

Getter

cursor_get_blink_enabled()

If true, the caret (visual cursor) blinks.

float caret_blink_speed

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0.65

Setter

cursor_set_blink_speed(value)

Getter

cursor_get_blink_speed()

Duration (in seconds) of a caret’s blinking cycle.

int caret_position

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_cursor_position(value)

Getter

get_cursor_position()

The cursor’s position inside the TLLineEdit. When set, the text may scroll to accommodate it.

bool clear_button_enabled

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

set_clear_button_enabled(value)

Getter

is_clear_button_enabled()

If true, the TLLineEdit will show a clear button if text is not empty.

bool context_menu_enabled

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

true

Setter

set_context_menu_enabled(value)

Getter

is_context_menu_enabled()

If true, the context menu will appear when right-clicked.

bool editable

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

true

Setter

set_editable(value)

Getter

is_editable()

If false, existing text cannot be modified and new text cannot be added.

bool expand_to_text_length

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

set_expand_to_text_length(value)

Getter

get_expand_to_text_length()

If true, the TLLineEdit width will increase to stay longer than the text. It will not compress if the text is shortened.

String language

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_language(value)

Getter

get_language()

Language code for line-breaking and text shaping algorithms.

int max_length

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_max_length(value)

Getter

get_max_length()

Maximum amount of characters that can be entered inside the LineEdit. If 0, there is no limit.

String ot_features

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_ot_features(value)

Getter

get_ot_features()

Comma separated list of OpenType feature tags.

float placeholder_alpha

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0.6

Setter

set_placeholder_alpha(value)

Getter

get_placeholder_alpha()

Opacity of the placeholder_text. From 0 to 1.

String placeholder_text

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_placeholder(value)

Getter

get_placeholder()

Text shown when the TLLineEdit is empty. It is not the TLLineEdit’s default value (see text).

bool secret

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

set_secret(value)

Getter

is_secret()

If true, every character is replaced with the secret character (see secret_character).

String secret_character

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“*”

Setter

set_secret_character(value)

Getter

get_secret_character()

The character to use to mask secret input (defaults to “*”). Only a single character can be used as the secret character.

String text

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_text(value)

Getter

get_text()

String value of the TLLineEdit.

int text_direction

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

3

Setter

set_text_direction(value)

Getter

get_text_direction()

Base direction of the text.

Method Descriptions¶

void append_at_cursor ( String text )

Adds text after the cursor. If the resulting value is longer than max_length, nothing happens.

void clear ( )

Erases the TLLineEdit text.

void deselect ( )

Clears the current selection.

PopupMenu get_menu ( ) const

Returns the PopupMenu of this TLLineEdit. By default, this menu is displayed when right-clicking on the TLLineEdit.

void menu_option ( int option )

Executes a given action as defined in the``MENU_*`` enum.

void select ( int from=0, int to=-1 )

Selects characters inside TLLineEdit between from and to. By default, from is at the beginning and to at the end.

text = "Welcome"
select()     # Will select "Welcome"
select(4)    # Will select "ome"
select(2, 5) # Will select "lco"

void select_all ( )

Selects the whole String.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>TLLabel — libgdtl latest documentation</title>

  <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" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl API »

TLLabel

TLLabel¶

Inherits:

Category: Core

Brief Description¶

Displays plain text in a line or wrapped inside a rectangle. For formatted text, use TLRichTextEdit.

Copy of Godot Label with the shaping support. TLLabel uses the same theme items as the Label.

Properties¶

<colgroup>
<col style="width: 34%" />
<col style="width: 57%" />
<col style="width: 9%" />
</colgroup>

int

align

0

bool

autowrap

false

TLFontFamily

base_font

int

base_font_size

12

String

base_font_style

“Regular”

bool

clip_text

false

String

language

“”

int

lines_skipped

0

int

max_lines_visible

-1

int

mouse_filter

O: 2

String

ot_features

“”

float

percent_visible

1.0

int

size_flags_vertical

O: 4

String

text

“”

int

text_direction

3

bool

uppercase

false

int

valign

0

int

visible_characters

-1

Methods¶

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

int

get_line_count ( ) const

int

get_line_height ( ) const

int

get_total_character_count ( ) const

int

get_visible_line_count ( ) const

Enumerations¶

enum Align:

ALIGN_LEFT = 0 — Align rows to the left (default).

ALIGN_CENTER = 1 — Align rows centered.

ALIGN_RIGHT = 2 — Align rows to the right.

ALIGN_FILL = 3 — Expand row white spaces to fit the width.

enum VAlign:

VALIGN_TOP = 0 — Align the whole text to the top.

VALIGN_CENTER = 1 — Align the whole text to the center.

VALIGN_BOTTOM = 2 — Align the whole text to the bottom.

VALIGN_FILL = 3 — Align the whole text by spreading the rows.

Description¶

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.

Property Descriptions¶

int align

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_align(value)

Getter

get_align()

Controls the text’s horizontal align. Supports left, center, right, and fill, or justify. Set it to one of the ALIGN_* constants.

bool autowrap

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

set_autowrap(value)

Getter

has_autowrap()

If true, 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.

TLFontFamily base_font

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Setter

set_base_font(value)

Getter

get_base_font()

Base font.

int base_font_size

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

12

Setter

set_base_font_size(value)

Getter

get_base_font_size()

Base font size.

String base_font_style

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“Regular”

Setter

set_base_font_style(value)

Getter

get_base_font_style()

Base font style.

bool clip_text

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

set_clip_text(value)

Getter

is_clipping_text()

If true, the Label only shows the text that fits inside its bounding rectangle. It also lets you scale the node down freely.

String language

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_language(value)

Getter

get_language()

Language code for line-breaking and text shaping algorithms.

int lines_skipped

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_lines_skipped(value)

Getter

get_lines_skipped()

The node ignores the first lines_skipped lines before it starts to display text.

int max_lines_visible

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

-1

Setter

set_max_lines_visible(value)

Getter

get_max_lines_visible()

Limits the lines of text the node shows on screen.

String ot_features

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_ot_features(value)

Getter

get_ot_features()

Comma separated list of OpenType feature tags.

float percent_visible

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

1.0

Setter

set_percent_visible(value)

Getter

get_percent_visible()

Limits the count of visible characters. If you set percent_visible to 50, only up to half of the text’s characters will display on screen. Useful to animate the text in a dialog box.

String text

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_text(value)

Getter

get_text()

The text to display on screen.

int text_direction

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

3

Setter

set_text_direction(value)

Getter

get_text_direction()

Base direction of the text.

bool uppercase

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

false

Setter

set_uppercase(value)

Getter

is_uppercase()

If true, all the text displays as UPPERCASE.

int valign

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_valign(value)

Getter

get_valign()

Controls the text’s vertical align. Supports top, center, bottom, and fill. Set it to one of the VALIGN_* constants.

int visible_characters

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

-1

Setter

set_visible_characters(value)

Getter

get_visible_characters()

Restricts the number of characters to display. Set to -1 to disable.

Method Descriptions¶

int get_line_count ( ) const

Returns the amount of lines of text the Label has.

int get_line_height ( ) const

Returns the of the line in pixels.

int get_total_character_count ( ) const

Returns the total number of printable characters in the text.

int get_visible_line_count ( ) const

Returns the number of lines shown. Useful if the Label’s height cannot currently display all lines.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.

repo_language: C

mime_type: text/x-c


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>TLICUDataLoader — libgdtl latest documentation</title>

  <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="TLLabel" href="class_tllabel.html" />
    <link rel="prev" title="TLGDFontWrapper" href="class_tlgdfontwrapper.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl API »

TLICUDataLoader

TLICUDataLoader¶

Inherits:

Category: Core

Brief Description¶

Helper class that handles ICU data loading.

Properties¶

<colgroup>
<col style="width: 11%" />
<col style="width: 83%" />
<col style="width: 6%" />
</colgroup>

String

data_path

“”

Methods¶

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

bool

load ( String resource_path )

Property Descriptions¶

String data_path

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_data_path(value)

Getter

get_data_path()

ICU data file path.

Method Descriptions¶

bool load ( String resource_path )

Loads ICU data file, should be done at most once in a process, before the first ICU operation. Returns true if function succeeds.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>TLGDFontWrapper — libgdtl latest documentation</title>

  <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="TLICUDataLoader" href="class_tlicudataloader.html" />
    <link rel="prev" title="TLFontIterator" href="class_tlfontiterator.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl API »

TLGDFontWrapper

TLGDFontWrapper¶

Inherits:

Category: Core

Brief Description¶

Properties¶

<colgroup>
<col style="width: 33%" />
<col style="width: 58%" />
<col style="width: 9%" />
</colgroup>

TLFontFamily

base_font

int

base_font_size

12

String

base_font_style

“Regular”

int

cache_depth

100

Description¶

Subclass Font to use with default Godot controls, provides limited shaping support.

Note: This class is only available if module is built with use_font_wrapper=true flag.

Property Descriptions¶

TLFontFamily base_font

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Setter

set_base_font(value)

Getter

get_base_font()

Base font to wrap.

int base_font_size

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

12

Setter

set_base_font_size(value)

Getter

get_base_font_size()

Base font size.

String base_font_style

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“Regular”

Setter

set_base_font_style(value)

Getter

get_base_font_style()

Base font style.

int cache_depth

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

100

Setter

set_cache_depth(value)

Getter

get_cache_depth()

Number of shaped strings to keep in cache.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>TLBitmapFontFace — libgdtl latest documentation</title>

  <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="TLDynamicFontFace" href="class_tldynamicfontface.html" />
    <link rel="prev" title="libgdtl API" href="index.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl API »

TLBitmapFontFace

TLBitmapFontFace¶

Inherits: TLFontFace

Category: Core

Brief Description¶

An AngelCode Bitmap Font Generator bitmap font for drawing text.

Properties¶

<colgroup>
<col style="width: 15%" />
<col style="width: 45%" />
<col style="width: 39%" />
</colgroup>

int

texture_flags

O: 2048

Description¶

TLBitmapFontFace have limited shaping support.

TLBitmapFontFace doesn’t support OpenType features.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>TLFontFace — libgdtl latest documentation</title>

  <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="TLFontFamily" href="class_tlfontfamily.html" />
    <link rel="prev" title="TLDynamicFontFace" href="class_tldynamicfontface.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl API »

TLFontFace

TLFontFace¶

Inherits:

Inherited By: TLBitmapFontFace, TLDynamicFontFace

Category: Core

Brief Description¶

*Virtual class*

A base font face class.

Properties¶

<colgroup>
<col style="width: 11%" />
<col style="width: 84%" />
<col style="width: 5%" />
</colgroup>

String

font_path

“”

int

texture_flags

0

Methods¶

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

void

draw_glyph ( RID canvas_item, Vector2 pos, int codepoint, Color modulate, int size ) const

void

draw_glyph_outline ( RID canvas_item, Vector2 pos, int codepoint, Color modulate, int size ) const

float

get_ascent ( int size ) const

int

get_base_size ( ) const

float

get_descent ( int size ) const

Array

get_glyph_outline ( Vector2 pos, int codepoint, int size ) const

float

get_height ( int size ) const

bool

load ( String resource_path )

Array

unicode_scripts_supported ( ) const

Property Descriptions¶

String font_path

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

“”

Setter

set_font_path(value)

Getter

get_font_path()

Path of the font file.

int texture_flags

<colgroup>
<col style="width: 26%" />
<col style="width: 74%" />
</colgroup>

Default

0

Setter

set_texture_flags(value)

Getter

get_texture_flags()

Underlaying textures flags, see Texture class documentation https://docs.godotengine.org/en/latest/classes/class_texture.html#enumerations for more info.

Method Descriptions¶

void draw_glyph ( RID canvas_item, Vector2 pos, int codepoint, Color modulate, int size ) const

Draws a single glyph.

void draw_glyph_outline ( RID canvas_item, Vector2 pos, int codepoint, Color modulate, int size ) const

Draws single glyph outline.

float get_ascent ( int size ) const

Returns ascent (distance from the baseline to the highest position characters extend to) of the font.

int get_base_size ( ) const

Returns default font size for bitmap fonts or 0 for dynamic fonts.

float get_descent ( int size ) const

Returns descent (distance from the base line to the lowest point characters extend to) of the font.

Array get_glyph_outline ( Vector2 pos, int codepoint, int size ) const

Returns array of glyph counture points, if it’s supported by font implementation or empty array otherwise.

float get_height ( int size ) const

Returns height (vertical distance between two consecutive baselines) of the font.

bool load ( String resource_path )

Loads font from speified file.

Array unicode_scripts_supported ( ) const

Returns array of supported ISO 15924 script codes.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>libgdtl introduction — libgdtl latest documentation</title>

  <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="Installation" href="../getting_started/installation.html" />
    <link rel="prev" title="libgdtl documentation" href="../index.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

libgdtl introduction

libgdtl introduction¶

BiDi, shaping and basic text layout for Godot Engine.

Dependencies¶

Godot 3.1+

C++14 compiler

Meson build system (for gdnative module build only)

SCons build system

Compiling (as builtin module)¶

Build options¶

<colgroup>
<col style="width: 22%" />
<col style="width: 59%" />
<col style="width: 19%" />
</colgroup>

Name

Description

Default value

builtin_runtime

Use the built-in libraries

true

use_graphite2

Enable SIL Graphite 2 complementary shaper

true

use_font_wrapper

Enable Godot font wrapper for default controls

false

If use_font_wrapper is enabled, apply patch_font.diff from the root of this repository to the Godot engine source first.

Building libdgtl module¶

Clone this repository (without –recursive flag) into Godot’s modules subfolder as godot_tl.
Rebuild Godot engine as usual.

Compiling (as gdnative module)¶

Build options¶

<colgroup>
<col style="width: 20%" />
<col style="width: 65%" />
<col style="width: 15%" />
</colgroup>

Name

Description

Default value

godot-cpp-lib-name

godot-cpp static library name (without .a or .lib extension)

libgodot-cpp

static-lib

Build static library

false

static-runtime

Link libraries statically for better portability

false

builtin-runtime

Use the built-in libraries

false

use-graphite2

Enable SIL Graphite 2 complementary shaper

true

Building godot-cpp static library¶

See https://github.com/GodotNativeTools/godot-cpp/blob/master/README.md#compiling-the-cpp-bindings-library

Building libdgtl module¶

See Compiling GDNative module for Windows, macOS and Linux, Compiling GDNative module for Android and Compiling GDNative module for iOS for build instructions.

License¶

The source code of the libgdtl module is released under unlicense.

For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.

Godot and GodotNativeTools are licensed under MIT license.

For more information, see https://github.com/godotengine/godot/blob/master/LICENSE.txt.

HarfBuzz is licensed under MIT-like License.

For more information, see https://github.com/harfbuzz/harfbuzz/blob/master/COPYING

ICU4C is licensed under Unicode, Inc. License.

For more information, see http://www.unicode.org/copyright.html#License

FreeType is licensed under FreeType License (BSD-like) or GNU General Public License (GPL), version 2.

For more information, see https://www.freetype.org/license.html

SIL Graphite engine is licensed under GNU Lesser General Public License (LGPL), version 2.1+ or GNU General Public License (GPL), version 2 or Mozilla Public License.

For more information, see https://github.com/silnrsi/graphite/blob/master/COPYING

Demo data¶

Montserrat, Awami Nastaliq, Comic Neue and Noto fonts are published under the SIL Open Font License, Version 1.1

Material Design icons by Google are published under the Apache License Version 2.0

Noto Color Emoji font is cut down to single glyph (U+1F604) using glyphhanger.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>Compiling GDNative module for Android — libgdtl latest documentation</title>

  <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="Compiling GDNative module for iOS" href="compiling_ios.html" />
    <link rel="prev" title="Compiling GDNative module for Windows, macOS and Linux" href="compiling_desktop.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

Compiling GDNative module for Android

Compiling GDNative module for Android¶

Requirements¶

Meson build system

SCons build system

Android NDK 21+.

Building godot-cpp static library¶

Open a Terminal and navigate to the godot-cpp subdirectory.

Apply provided patch for Android build:

$ git apply ../patch_gdcpp_android.diff

Compile godot-cpp static libraries for required platforms, by typing:

$ scons platform=android target=release android_arch=arm64v8 generate_bindings=yes
$ scons platform=android target=release android_arch=armv7 generate_bindings=yes
$ scons platform=android target=release android_arch=x86_64 generate_bindings=yes

Building libgdtl static library and built-in dependencies¶

Navigate to the root directory of the source.

Edit Android NDK path in the Meson cross compile files (toolchains/android.{arch}.toolchain).

Configure libgdtl static libraries, by typing:

$ meson ./_android_arm8 -Dgodot-cpp-lib-name=libgodot-cpp.android.release.arm64v8 --buildtype=release --cross-file ./toolchains/android.arm64.toolchain
$ meson ./_android_arm7 -Dgodot-cpp-lib-name=libgodot-cpp.android.release.armv7 --buildtype=release --cross-file ./toolchains/android.armv7.toolchain
$ meson ./_android_x86_64 -Dgodot-cpp-lib-name=libgodot-cpp.android.release.x86_64 --buildtype=release --cross-file ./toolchains/android.x86_64.toolchain

Compile libgdtl static libraries, by typing:

$ ninja -C ./_android_arm8
$ ninja -C ./_android_arm7
$ ninja -C ./_android_x86_64

Copy .so files to the libgdtl/bin/android.{arch}/.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>Compiling GDNative module for Windows, macOS and Linux — libgdtl latest documentation</title>

  <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="Compiling GDNative module for Android" href="compiling_android.html" />
    <link rel="prev" title="Rich text typesetting" href="../getting_started/rich_text_typesetting.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

Compiling GDNative module for Windows, macOS and Linux

Compiling GDNative module for Windows, macOS and Linux¶

Requirements¶

Meson build system

SCons build system

Building godot-cpp static library¶

Open a Terminal and navigate to the godot-cpp subdirectory.

Compile godot-cpp static libraries for required platforms ({os} - windows, osx or linux), by typing:

$ scons platform={os} target=release bits=64 generate_bindings=yes

Building libgdtl static library and built-in dependencies¶

Navigate to the root directory of the source.

For MinGW cross-build edit toolchain path in the Meson cross compile files (toolchains/ming.{arch}.toolchain).

Configure libgdtl static libraries, by typing:

$ meson ./_{os_build_dir} -Dgodot-cpp-lib-name=libgodot-cpp.{os}.release.{bits} --buildtype=release

Compile libgdtl static libraries, by typing:

$ ninja -C ./{os_build_dir}

Copy .so`.dll``.dylib` files to the libgdtl/bin/{os}.{arch}/.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
<!DOCTYPE html>

  <meta charset="utf-8">

  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <title>Compiling GDNative module for iOS — libgdtl latest documentation</title>

  <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="libgdtl API" href="../classes/index.html" />
    <link rel="prev" title="Compiling GDNative module for Android" href="compiling_android.html" />

                latest

  <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>

General

libgdtl introduction

Dependencies

Compiling (as builtin module)

Build options

Building libdgtl module

Compiling (as gdnative module)

Build options

Building godot-cpp static library

Building libdgtl module

License

Demo data

Getting started

Installation

Module

GDNative

Font substitution

Rich text typesetting

Setting formatting for the range of text

Removing formatting

Embedding child control into the text flow

Development

Compiling GDNative module for Windows, macOS and Linux

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for Android

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Compiling GDNative module for iOS

Requirements

Building godot-cpp static library

Building libgdtl static library and built-in dependencies

Adding libgdtl static library to the exported Xcode project

Class reference

libgdtl API

TLBitmapFontFace

Brief Description

Properties

Description

TLDynamicFontFace

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLFontFace

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontFamily

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLFontIterator

Brief Description

Methods

Method Descriptions

TLGDFontWrapper

Brief Description

Properties

Description

Property Descriptions

TLICUDataLoader

Brief Description

Properties

Methods

Property Descriptions

Method Descriptions

TLLabel

Brief Description

Properties

Methods

Enumerations

Description

Property Descriptions

Method Descriptions

TLLineEdit

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

TLRichTextEdit

Brief Description

Properties

Methods

Signals

Property Descriptions

Method Descriptions

TLRichTextEditSelection

Brief Description

Properties

Signals

Property Descriptions

TLShapedAttributedString

Brief Description

Properties

Methods

Enumerations

Property Descriptions

Method Descriptions

TLShapedParagraph

Brief Description

Properties

Methods

Signals

Enumerations

Property Descriptions

Method Descriptions

TLShapedString

Brief Description

Properties

Methods

Signals

Enumerations

Description

Property Descriptions

Method Descriptions

          libgdtl

Docs »

Compiling GDNative module for iOS

Compiling GDNative module for iOS¶

Requirements¶

Meson build system

SCons build system

Xcode 10.0 (or later) with the iOS (10.0) SDK and the command line tools.

Building godot-cpp static library¶

Open a Terminal and navigate to the godot-cpp subdirectory.

Apply provided patch for iOS build:

$ git apply ../patch_gdcpp_ios.diff

Compile godot-cpp static libraries for required platforms (arm64 and armv7 for real devices and x86_64 for simulator), by typing:

$ scons platform=ios target=release ios_arch=arm64 generate_bindings=yes
$ scons platform=ios target=release ios_arch=armv7 generate_bindings=yes
$ scons platform=ios target=release ios_arch=x86_64 generate_bindings=yes

Building libgdtl static library and built-in dependencies¶

Navigate to the root directory of the source.

Edit iOS SDK and toolchain paths in the Meson cross compile files (toolchains/ios.{arch}.toolchain).

Configure libgdtl static libraries, by typing:

$ meson ./_ios_arm8 -Dgodot-cpp-lib-name=libgodot-cpp.ios.release.arm64 --buildtype=release --cross-file ./toolchains/ios.arm64.toolchain
$ meson ./_ios_arm7 -Dgodot-cpp-lib-name=libgodot-cpp.ios.release.armv7 --buildtype=release --cross-file ./toolchains/ios.armv7.toolchain
$ meson ./_ios_x86_64 -Dgodot-cpp-lib-name=libgodot-cpp.ios.release.x86_64 --buildtype=release --cross-file ./toolchains/ios.x86_64.toolchain

Compile libgdtl static libraries, by typing:

$ ninja -C ./_ios_arm8
$ ninja -C ./_ios_arm7
$ ninja -C ./_ios_x86_64

(Optional) Bundle libgdtl and it’s dependencies into one file:

$ libtool -static -o ./_ios_arm8/libgdtl_full.a ./_ios_arm8/libgdtl.a ./_ios_arm8/subprojects/freetype2/libfreetype2.a ./_ios_arm8/subprojects/graphite2/libgraphite2.a ./_ios_arm8/subprojects/harfbuzz/libharfbuzz.a ./_ios_arm8/subprojects/icu4c/libicu4c.a ./_ios_arm8/subprojects/libpng/liblibpng.a ./_ios_arm8/subprojects/zlib/libzlib.a ./godot-cpp/bin/libgodot-cpp.ios.release.arm64.a
$ libtool -static -o ./_ios_arm7/libgdtl_full.a ./_ios_arm7/libgdtl.a ./_ios_arm7/subprojects/freetype2/libfreetype2.a ./_ios_arm7/subprojects/graphite2/libgraphite2.a ./_ios_arm7/subprojects/harfbuzz/libharfbuzz.a ./_ios_arm7/subprojects/icu4c/libicu4c.a ./_ios_arm7/subprojects/libpng/liblibpng.a ./_ios_arm7/subprojects/zlib/libzlib.a ./godot-cpp/bin/libgodot-cpp.ios.release.armv7.a
$ libtool -static -o ./_ios_x86_64/libgdtl_full.a ./_ios_x86_64/libgdtl.a ./_ios_x86_64/subprojects/freetype2/libfreetype2.a ./_ios_x86_64/subprojects/graphite2/libgraphite2.a ./_ios_x86_64/subprojects/harfbuzz/libharfbuzz.a ./_ios_x86_64/subprojects/icu4c/libicu4c.a ./_ios_x86_64/subprojects/libpng/liblibpng.a ./_ios_x86_64/subprojects/zlib/libzlib.a ./godot-cpp/bin/libgodot-cpp.ios.release.x86_64.a

(Optional) Bundle static libs for all platforms into one “fat” file:

$ lipo -create ./_ios_arm8/libgdtl_full.a ./_ios_arm7/libgdtl_full.a ./_ios_x86_64/libgdtl_full.a -output ./libgdtl/bin/libgdtl_ios_fat.a

Adding libgdtl static library to the exported Xcode project¶

Copy libgdtl static library file(s) into exported project directory (alongside with {app_name}.xcode and {app_name}.a files).

Open exported project in the Xcode.

Select Targets > Exported App Name > General > Frameworks, Libraries, and Embedded Content

Drag-and-drop (or use + button) libgdtl fat (or individual platform) file(s) to the list.

        Next

         Previous

  Built with Sphinx using a theme provided by Read the Docs.


text:
/*
 * basic.css
 * ~~~~~~~~~
 *
 * Sphinx stylesheet -- basic theme.
 *
 * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
 * :license: BSD, see LICENSE for details.
 *
 */

/* -- main layout ----------------------------------------------------------- */

div.clearer {
    clear: both;
}

/* -- relbar ---------------------------------------------------------------- */

div.related {
    width: 100%;
    font-size: 90%;
}

div.related h3 {
    display: none;
}

div.related ul {
    margin: 0;
    padding: 0 0 0 10px;
    list-style: none;
}

div.related li {
    display: inline;
}

div.related li.right {
    float: right;
    margin-right: 5px;
}

/* -- sidebar --------------------------------------------------------------- */

div.sphinxsidebarwrapper {
    padding: 10px 5px 0 10px;
}

div.sphinxsidebar {
    float: left;
    width: 230px;
    margin-left: -100%;
    font-size: 90%;
    word-wrap: break-word;
    overflow-wrap : break-word;
}

div.sphinxsidebar ul {
    list-style: none;
}

div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
    margin-left: 20px;
    list-style: square;
}

div.sphinxsidebar ul ul {
    margin-top: 0;
    margin-bottom: 0;
}

div.sphinxsidebar form {
    margin-top: 10px;
}

div.sphinxsidebar input {
    border: 1px solid #98dbcc;
    font-family: sans-serif;
    font-size: 1em;
}

div.sphinxsidebar #searchbox form.search {
    overflow: hidden;
}

div.sphinxsidebar #searchbox input[type="text"] {
    float: left;
    width: 80%;
    padding: 0.25em;
    box-sizing: border-box;
}

div.sphinxsidebar #searchbox input[type="submit"] {
    float: left;
    width: 20%;
    border-left: none;
    padding: 0.25em;
    box-sizing: border-box;
}

img {
    border: 0;
    max-width: 100%;
}

/* -- search page ----------------------------------------------------------- */

ul.search {
    margin: 10px 0 0 20px;
    padding: 0;
}

ul.search li {
    padding: 5px 0 5px 20px;
    background-image: url(file.png);
    background-repeat: no-repeat;
    background-position: 0 7px;
}

ul.search li a {
    font-weight: bold;
}

ul.search li div.context {
    color: #888;
    margin: 2px 0 0 30px;
    text-align: left;
}

ul.keywordmatches li.goodmatch a {
    font-weight: bold;
}

/* -- index page ------------------------------------------------------------ */

table.contentstable {
    width: 90%;
    margin-left: auto;
    margin-right: auto;
}

table.contentstable p.biglink {
    line-height: 150%;
}

a.biglink {
    font-size: 1.3em;
}

span.linkdescr {
    font-style: italic;
    padding-top: 5px;
    font-size: 90%;
}

/* -- general index --------------------------------------------------------- */

table.indextable {
    width: 100%;
}

table.indextable td {
    text-align: left;
    vertical-align: top;
}

table.indextable ul {
    margin-top: 0;
    margin-bottom: 0;
    list-style-type: none;
}

table.indextable > tbody > tr > td > ul {
    padding-left: 0em;
}

table.indextable tr.pcap {
    height: 10px;
}

table.indextable tr.cap {
    margin-top: 10px;
    background-color: #f2f2f2;
}

img.toggler {
    margin-right: 3px;
    margin-top: 3px;
    cursor: pointer;
}

div.modindex-jumpbox {
    border-top: 1px solid #ddd;
    border-bottom: 1px solid #ddd;
    margin: 1em 0 1em 0;
    padding: 0.4em;
}

div.genindex-jumpbox {
    border-top: 1px solid #ddd;
    border-bottom: 1px solid #ddd;
    margin: 1em 0 1em 0;
    padding: 0.4em;
}

/* -- domain module index --------------------------------------------------- */

table.modindextable td {
    padding: 2px;
    border-collapse: collapse;
}

/* -- general body styles --------------------------------------------------- */

div.body {
    min-width: 450px;
    max-width: 800px;
}

div.body p, div.body dd, div.body li, div.body blockquote {
    -moz-hyphens: auto;
    -ms-hyphens: auto;
    -webkit-hyphens: auto;
    hyphens: auto;
}

a.headerlink {
    visibility: hidden;
}

a.brackets:before,
span.brackets > a:before{
    content: "[";
}

a.brackets:after,
span.brackets > a:after {
    content: "]";
}

h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
    visibility: visible;
}

div.body p.caption {
    text-align: inherit;
}

div.body td {
    text-align: left;
}

.first {
    margin-top: 0 !important;
}

p.rubric {
    margin-top: 30px;
    font-weight: bold;
}

img.align-left, .figure.align-left, object.align-left {
    clear: left;
    float: left;
    margin-right: 1em;
}

img.align-right, .figure.align-right, object.align-right {
    clear: right;
    float: right;
    margin-left: 1em;
}

img.align-center, .figure.align-center, object.align-center {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

img.align-default, .figure.align-default {
  display: block;
  margin-left: auto;
  margin-right: auto;
}

.align-left {
    text-align: left;
}

.align-center {
    text-align: center;
}

.align-default {
    text-align: center;
}

.align-right {
    text-align: right;
}

/* -- sidebars -------------------------------------------------------------- */

div.sidebar {
    margin: 0 0 0.5em 1em;
    border: 1px solid #ddb;
    padding: 7px 7px 0 7px;
    background-color: #ffe;
    width: 40%;
    float: right;
}

p.sidebar-title {
    font-weight: bold;
}

/* -- topics ---------------------------------------------------------------- */

div.topic {
    border: 1px solid #ccc;
    padding: 7px 7px 0 7px;
    margin: 10px 0 10px 0;
}

p.topic-title {
    font-size: 1.1em;
    font-weight: bold;
    margin-top: 10px;
}

/* -- admonitions ----------------------------------------------------------- */

div.admonition {
    margin-top: 10px;
    margin-bottom: 10px;
    padding: 7px;
}

div.admonition dt {
    font-weight: bold;
}

div.admonition dl {
    margin-bottom: 0;
}

p.admonition-title {
    margin: 0px 10px 5px 0px;
    font-weight: bold;
}

div.body p.centered {
    text-align: center;
    margin-top: 25px;
}

/* -- tables ---------------------------------------------------------------- */

table.docutils {
    border: 0;
    border-collapse: collapse;
}

table.align-center {
    margin-left: auto;
    margin-right: auto;
}

table.align-default {
    margin-left: auto;
    margin-right: auto;
}

table caption span.caption-number {
    font-style: italic;
}

table caption span.caption-text {
}

table.docutils td, table.docutils th {
    padding: 1px 8px 1px 5px;
    border-top: 0;
    border-left: 0;
    border-right: 0;
    border-bottom: 1px solid #aaa;
}

table.footnote td, table.footnote th {
    border: 0 !important;
}

th {
    text-align: left;
    padding-right: 5px;
}

table.citation {
    border-left: solid 1px gray;
    margin-left: 1px;
}

table.citation td {
    border-bottom: none;
}

th > p:first-child,
td > p:first-child {
    margin-top: 0px;
}

th > p:last-child,
td > p:last-child {
    margin-bottom: 0px;
}

/* -- figures --------------------------------------------------------------- */

div.figure {
    margin: 0.5em;
    padding: 0.5em;
}

div.figure p.caption {
    padding: 0.3em;
}

div.figure p.caption span.caption-number {
    font-style: italic;
}

div.figure p.caption span.caption-text {
}

/* -- field list styles ----------------------------------------------------- */

table.field-list td, table.field-list th {
    border: 0 !important;
}

.field-list ul {
    margin: 0;
    padding-left: 1em;
}

.field-list p {
    margin: 0;
}

.field-name {
    -moz-hyphens: manual;
    -ms-hyphens: manual;
    -webkit-hyphens: manual;
    hyphens: manual;
}

/* -- hlist styles ---------------------------------------------------------- */

table.hlist td {
    vertical-align: top;
}

/* -- other body styles ----------------------------------------------------- */

ol.arabic {
    list-style: decimal;
}

ol.loweralpha {
    list-style: lower-alpha;
}

ol.upperalpha {
    list-style: upper-alpha;
}

ol.lowerroman {
    list-style: lower-roman;
}

ol.upperroman {
    list-style: upper-roman;
}

li > p:first-child {
    margin-top: 0px;
}

li > p:last-child {
    margin-bottom: 0px;
}

dl.footnote > dt,
dl.citation > dt {
    float: left;
}

dl.footnote > dd,
dl.citation > dd {
    margin-bottom: 0em;
}

dl.footnote > dd:after,
dl.citation > dd:after {
    content: "";
    clear: both;
}

dl.field-list {
    display: grid;
    grid-template-columns: fit-content(30%) auto;
}

dl.field-list > dt {
    font-weight: bold;
    word-break: break-word;
    padding-left: 0.5em;
    padding-right: 5px;
}

dl.field-list > dt:after {
    content: ":";
}

dl.field-list > dd {
    padding-left: 0.5em;
    margin-top: 0em;
    margin-left: 0em;
    margin-bottom: 0em;
}

dl {
    margin-bottom: 15px;
}

dd > p:first-child {
    margin-top: 0px;
}

dd ul, dd table {
    margin-bottom: 10px;
}

dd {
    margin-top: 3px;
    margin-bottom: 10px;
    margin-left: 30px;
}

dt:target, span.highlighted {
    background-color: #fbe54e;
}

rect.highlighted {
    fill: #fbe54e;
}

dl.glossary dt {
    font-weight: bold;
    font-size: 1.1em;
}

.optional {
    font-size: 1.3em;
}

.sig-paren {
    font-size: larger;
}

.versionmodified {
    font-style: italic;
}

.system-message {
    background-color: #fda;
    padding: 5px;
    border: 3px solid red;
}

.footnote:target  {
    background-color: #ffa;
}

.line-block {
    display: block;
    margin-top: 1em;
    margin-bottom: 1em;
}

.line-block .line-block {
    margin-top: 0;
    margin-bottom: 0;
    margin-left: 1.5em;
}

.guilabel, .menuselection {
    font-family: sans-serif;
}

.accelerator {
    text-decoration: underline;
}

.classifier {
    font-style: oblique;
}

.classifier:before {
    font-style: normal;
    margin: 0.5em;
    content: ":";
}

abbr, acronym {
    border-bottom: dotted 1px;
    cursor: help;
}

/* -- code displays --------------------------------------------------------- */

pre {
    overflow: auto;
    overflow-y: hidden;  /* fixes display issues on Chrome browsers */
}

span.pre {
    -moz-hyphens: none;
    -ms-hyphens: none;
    -webkit-hyphens: none;
    hyphens: none;
}

td.linenos pre {
    padding: 5px 0px;
    border: 0;
    background-color: transparent;
    color: #aaa;
}

table.highlighttable {
    margin-left: 0.5em;
}

table.highlighttable td {
    padding: 0 0.5em 0 0.5em;
}

div.code-block-caption {
    padding: 2px 5px;
    font-size: small;
}

div.code-block-caption code {
    background-color: transparent;
}

div.code-block-caption + div > div.highlight > pre {
    margin-top: 0;
}

div.code-block-caption span.caption-number {
    padding: 0.1em 0.3em;
    font-style: italic;
}

div.code-block-caption span.caption-text {
}

div.literal-block-wrapper {
    padding: 1em 1em 0;
}

div.literal-block-wrapper div.highlight {
    margin: 0;
}

code.descname {
    background-color: transparent;
    font-weight: bold;
    font-size: 1.2em;
}

code.descclassname {
    background-color: transparent;
}

code.xref, a code {
    background-color: transparent;
    font-weight: bold;
}

h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
    background-color: transparent;
}

.viewcode-link {
    float: right;
}

.viewcode-back {
    float: right;
    font-family: sans-serif;
}

div.viewcode-block:target {
    margin: -1px -10px;
    padding: 0 10px;
}

/* -- math display ---------------------------------------------------------- */

img.math {
    vertical-align: middle;
}

div.body div.math p {
    text-align: center;
}

span.eqno {
    float: right;
}

span.eqno a.headerlink {
    position: relative;
    left: 0px;
    z-index: 1;
}

div.math:hover a.headerlink {
    visibility: visible;
}

/* -- printout stylesheet --------------------------------------------------- */

@media print {
    div.document,
    div.documentwrapper,
    div.bodywrapper {
        margin: 0 !important;
        width: 100%;
    }

    div.sphinxsidebar,
    div.related,
    div.footer,
    #top-link {
        display: none;
    }
}


text:
var DOCUMENTATION_OPTIONS = {
    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
    VERSION: 'latest',
    LANGUAGE: 'en',
    COLLAPSE_INDEX: false,
    FILE_SUFFIX: '.html',
    HAS_SOURCE: true,
    SOURCELINK_SUFFIX: '.txt',
    NAVIGATION_WITH_KEYS: false
};


text:
.highlight .hll { background-color: #ffffcc }
.highlight  { background: #eeffcc; }
.highlight .c { color: #408090; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #333333 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #208050 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #208050 } /* Literal.Number.Bin */
.highlight .mf { color: #208050 } /* Literal.Number.Float */
.highlight .mh { color: #208050 } /* Literal.Number.Hex */
.highlight .mi { color: #208050 } /* Literal.Number.Integer */
.highlight .mo { color: #208050 } /* Literal.Number.Oct */
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #06287e } /* Name.Function.Magic */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
.highlight .il { color: #208050 } /* Literal.Number.Integer.Long */