summaryrefslogtreecommitdiff
path: root/fpcsrc/packages/fcl-res/xml/resreader.xml
blob: 7188c20c26ce96cda17ad1d61c543cf653295e63 (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<fpdoc-descriptions>
<package name="fcl-res">

<!--
  ====================================================================
    resreader
  ====================================================================
-->

<module name="resreader">
<short>Contains a resource reader for .res files</short>
<descr>
<p>This unit contains <link id="TResResourceReader"/>, a <link id="resource.TAbstractResourceReader">TAbstractResourceReader</link> descendant that is able to read .res resource files.</p>
<p>Adding this unit to a program's <var>uses</var> clause registers class <link id="TResResourceReader"/> with <link id="resource.TResources">TResources</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>

<!-- object Visibility: default -->
<element name="TResResourceReader">
<short>.res resource reader</short>
<descr>
<p>This class provides a reader for .res resource files.</p>
<p>A .res file is a standard Windows file type that contains resources. This is not an object file format, so it's not suitable for being linked with other object files. For this reason, it is a good choice for a platform-independent format to store resources.</p>
</descr>
<seealso>
<link id="resource.TAbstractResourceReader">TAbstractResourceReader</link>
<link id="reswriter.TResResourceWriter">TResResourceWriter</link>
</seealso>
</element>

</module> <!-- resreader -->

</package>
</fpdoc-descriptions>