blob: 65d99a748619fff7e54d0b7ffb9c490dc497172c (
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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fcl-res">
<!--
====================================================================
externalreader
====================================================================
-->
<module name="externalreader">
<short>Contains a resource reader for external resource files</short>
<descr>
<p>This unit contains <link id="TExternalResourceReader"/>, a <link id="resource.TAbstractResourceReader">TAbstractResourceReader</link> descendant that is able to read standalone resource files in a Free Pascal-specific format.</p>
<p>Adding this unit to a program's <var>uses</var> clause registers class <link id="TExternalResourceReader"/> with <link id="resource.TResources">TResources</link>.</p>
<p><b>See also</b></p>
<p><link id="externaltypes.Free Pascal external resource file format description">Free Pascal external resource file format description</link></p>
</descr>
<!-- unresolved type reference Visibility: default -->
<element name="Classes">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="SysUtils">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="resource">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="resourcetree">
</element>
<!-- unresolved type reference Visibility: default -->
<element name="externaltypes">
</element>
<!-- object Visibility: default -->
<element name="TExternalResourceReader">
<short>External file resource reader</short>
<descr>
<p>This class provides a reader for .fpcres files: they are standalone files containing resources.</p>
<p>Standalone files are files that don't get linked with the final executable. They are used as a
fallback solution on all those platforms for which an internal resource format is not available.</p>
<p>At runtime the resource file is read by Free Pascal RTL to provide resource support to the application.</p>
<p>After an external file has been read, <link id="TExternalResourceReader.Endianess">Endianess</link> property holds the byte order used in the file.</p>
</descr>
<seealso>
<link id="TExternalResourceReader.Endianess"/>
<link id="resource.TAbstractResourceReader">TAbstractResourceReader</link>
<link id="externalwriter.TExternalResourceWriter">TExternalResourceWriter</link>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TExternalResourceReader.Endianess">
<short>The byte order used in the file</short>
<descr>
<p>This property holds the byte order (endianess) of the file that has been read.</p>
<remark>Obviously, this property is meaningful only after a file has been read.</remark>
</descr>
<seealso>
<link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link>
<link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link>
</seealso>
</element>
</module> <!-- externalreader -->
</package>
</fpdoc-descriptions>
|
