summaryrefslogtreecommitdiff
path: root/doc/classes/TextServerManager.xml
blob: 29586f30b4bd131bddd90634285e96dfea89cccf (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
82
<?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.
		Note: 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="find_interface" qualifiers="const">
			<return type="TextServer">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<description>
				Finds an interface by its name.
			</description>
		</method>
		<method name="get_interface" qualifiers="const">
			<return type="TextServer">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<description>
				Returns the interface registered at a given index.
			</description>
		</method>
		<method name="get_interface_count" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Returns the number of interfaces currently registered.
			</description>
		</method>
		<method name="get_interface_features" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<description>
				Returns text server supported features (binary OR).
			</description>
		</method>
		<method name="get_interface_name" qualifiers="const">
			<return type="String">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<description>
				Returns the interface name registered at a given index.
			</description>
		</method>
		<method name="get_interfaces" qualifiers="const">
			<return type="Array">
			</return>
			<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">
			</return>
			<description>
				Returns the primary [TextServer] interface.
			</description>
		</method>
		<method name="set_primary_interface">
			<return type="bool">
			</return>
			<argument index="0" name="index" type="int">
			</argument>
			<description>
				Sets (and initializes it if required) interface registered at a given index as the primary. Invalidates all references to the fonts and text buffers.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>