summaryrefslogtreecommitdiff
path: root/doc/classes/TextServerManager.xml
blob: d6a1cde94536557acf1c2aa494d0b572bcbcc1a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?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.
		[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" />
			<argument index="0" name="interface" type="TextServer" />
			<description>
				Registers an [TextServer] interface.
			</description>
		</method>
		<method name="find_interface" qualifiers="const">
			<return type="TextServer" />
			<argument index="0" name="name" type="String" />
			<description>
				Finds an interface by its name.
			</description>
		</method>
		<method name="get_interface" qualifiers="const">
			<return type="TextServer" />
			<argument 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="Array" />
			<description>
				Returns a list of available interfaces 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" />
			<argument index="0" name="interface" type="TextServer" />
			<description>
				Removes interface. All fonts and shaped text caches should be freed before removing interface.
			</description>
		</method>
		<method name="set_primary_interface">
			<return type="void" />
			<argument index="0" name="index" type="TextServer" />
			<description>
				Sets the primary [TextServer] interface.
			</description>
		</method>
	</methods>
	<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>
</class>