virtualx-engine/doc/classes/TextServerManager.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextServerManager" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A singleton for managing [TextServer] implementations.
	</brief_description>
	<description>
		[TextServerManager] is the API backend for loading, enumerating, and switching [TextServer]s.
		[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.
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_interface">
			<return type="void" />
			<param index="0" name="interface" type="TextServer" />
			<description>
				Registers a [TextServer] interface.
			</description>
		</method>
		<method name="find_interface" qualifiers="const">
			<return type="TextServer" />
			<param index="0" name="name" type="String" />
			<description>
				Finds an interface by its [param name].
			</description>
		</method>
		<method name="get_interface" qualifiers="const">
			<return type="TextServer" />
			<param index="0" name="idx" type="int" />
			<description>
				Returns the interface registered at a given index.
			</description>
		</method>
		<method name="get_interface_count" qualifiers="const">
			<return type="int" />
			<description>
				Returns the number of interfaces currently registered.
			</description>
		</method>
		<method name="get_interfaces" qualifiers="const">
			<return type="Dictionary[]" />
			<description>
				Returns a list of available interfaces, with the index and name of each interface.
			</description>
		</method>
		<method name="get_primary_interface" qualifiers="const">
			<return type="TextServer" />
			<description>
				Returns the primary [TextServer] interface currently in use.
			</description>
		</method>
		<method name="remove_interface">
			<return type="void" />
			<param index="0" name="interface" type="TextServer" />
			<description>
				Removes an interface. All fonts and shaped text caches should be freed before removing an interface.
			</description>
		</method>
		<method name="set_primary_interface">
			<return type="void" />
			<param index="0" name="index" type="TextServer" />
			<description>
				Sets the primary [TextServer] interface.
			</description>
		</method>
	</methods>
	<signals>
		<signal name="interface_added">
			<param index="0" name="interface_name" type="StringName" />
			<description>
				Emitted when a new interface has been added.
			</description>
		</signal>
		<signal name="interface_removed">
			<param index="0" name="interface_name" type="StringName" />
			<description>
				Emitted when an interface is removed.
			</description>
		</signal>
	</signals>
</class>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 10:08:05 +02:00			`<class name="TextServerManager" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<brief_description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`A singleton for managing [TextServer] implementations.`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`[TextServerManager] is the API backend for loading, enumerating, and switching [TextServer]s.`
doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphs And fix up formatting not supported by makerst. 2021-10-05 14:24:34 +02: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 13:49:10 +02:00			`</description>`
			`<tutorials>`
			`</tutorials>`
			`<methods>`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<method name="add_interface">`
			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="interface" type="TextServer" />`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`Registers a [TextServer] interface.`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`</description>`
			`</method>`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02: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 15:28:05 +02:00			`<return type="TextServer" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="name" type="String" />`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`Finds an interface by its [param name].`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`</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 15:28:05 +02:00			`<return type="TextServer" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="idx" type="int" />`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02: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 15:28:05 +02:00			`<return type="int" />`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<description>`
			`Returns the number of interfaces currently registered.`
			`</description>`
			`</method>`
			`<method name="get_interfaces" qualifiers="const">`
Replace Array return types with TypedArray 3 2022-08-08 00:52:20 +02:00			`<return type="Dictionary[]" />`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`Returns a list of available interfaces, with the index and name of each interface.`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`</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 15:28:05 +02:00			`<return type="TextServer" />`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<description>`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`Returns the primary [TextServer] interface currently in use.`
			`</description>`
			`</method>`
			`<method name="remove_interface">`
			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="interface" type="TextServer" />`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<description>`
Overhaul the top sections of the class reference (GUI classes) 2023-04-30 16:26:09 +02:00			`Removes an interface. All fonts and shaped text caches should be freed before removing an interface.`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`</description>`
			`</method>`
			`<method name="set_primary_interface">`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<return type="void" />`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="index" type="TextServer" />`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`<description>`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`Sets the primary [TextServer] interface.`
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation. 2020-08-12 13:49:10 +02:00			`</description>`
			`</method>`
			`</methods>`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<signals>`
			`<signal name="interface_added">`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="interface_name" type="StringName" />`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<description>`
			`Emitted when a new interface has been added.`
			`</description>`
			`</signal>`
			`<signal name="interface_removed">`
Rename the argument tag to param in XML documentation 2022-08-06 20:11:48 +02:00			`<param index="0" name="interface_name" type="StringName" />`
Implement TextServer GDExtension interface, remove TextServer GDNative interface. 2021-08-27 23:19:51 +02:00			`<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 13:49:10 +02:00			`</class>`