mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-21 10:25:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
d1aef45072
godot/doc/classes/TextServerManager.xml

82 lines
2.7 KiB
XML
Raw Normal View History

[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextServerManager" inherits="Object" version="4.0">
<brief_description>
Manager for the font and complex text layout servers.
</brief_description>
<description>
[TextServerManager] is the API backend for loading, enumeration and switching [TextServer]s.
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst.
2021-10-05 20:24:34 +08:00
[b]Note:[/b] Switching text server at runtime is possible, but will invalidate all fonts and text buffers. Make sure to unload all controls, fonts, and themes before doing so.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
</description>
<tutorials>
</tutorials>
<methods>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-28 05:19:51 +08:00
<method name="add_interface">
<return type="void" />
<argument index="0" name="interface" type="TextServer" />
<description>
Registers an [TextServer] interface.
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<method name="find_interface" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="TextServer" />
<argument index="0" name="name" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Finds an interface by its name.
</description>
</method>
<method name="get_interface" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="TextServer" />
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-28 05:19:51 +08:00
<argument index="0" name="idx" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns the interface registered at a given index.
</description>
</method>
<method name="get_interface_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns the number of interfaces currently registered.
</description>
</method>
<method name="get_interfaces" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="Array" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Returns a list of available interfaces the index and name of each interface.
</description>
</method>
<method name="get_primary_interface" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="TextServer" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-28 05:19:51 +08:00
Returns the primary [TextServer] interface currently in use.
</description>
</method>
<method name="remove_interface">
<return type="void" />
<argument index="0" name="interface" type="TextServer" />
<description>
Removes interface. All fonts and shaped text caches should be freed before removing interface.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
</description>
</method>
<method name="set_primary_interface">
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-28 05:19:51 +08:00
<return type="void" />
<argument index="0" name="index" type="TextServer" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
<description>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-28 05:19:51 +08:00
Sets the primary [TextServer] interface.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
</description>
</method>
</methods>
Implement TextServer GDExtension interface, remove TextServer GDNative interface.
2021-08-28 05:19:51 +08:00
<signals>
<signal name="interface_added">
<argument index="0" name="interface_name" type="StringName" />
<description>
Emitted when a new interface has been added.
</description>
</signal>
<signal name="interface_removed">
<argument index="0" name="interface_name" type="StringName" />
<description>
Emitted when an interface is removed.
</description>
</signal>
</signals>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 19:49:10 +08:00
</class>
Reference in New Issue Copy Permalink