externalreader.xml 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <fpdoc-descriptions>
  3. <package name="fcl-res">
  4. <!--
  5. ====================================================================
  6. externalreader
  7. ====================================================================
  8. -->
  9. <module name="externalreader">
  10. <short>Contains a resource reader for external resource files</short>
  11. <descr>
  12. <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>
  13. <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>
  14. <p><b>See also</b></p>
  15. <p><link id="externaltypes.Free Pascal external resource file format description">Free Pascal external resource file format description</link></p>
  16. </descr>
  17. <!-- unresolved type reference Visibility: default -->
  18. <element name="Classes">
  19. </element>
  20. <!-- unresolved type reference Visibility: default -->
  21. <element name="SysUtils">
  22. </element>
  23. <!-- unresolved type reference Visibility: default -->
  24. <element name="resource">
  25. </element>
  26. <!-- unresolved type reference Visibility: default -->
  27. <element name="resourcetree">
  28. </element>
  29. <!-- unresolved type reference Visibility: default -->
  30. <element name="externaltypes">
  31. </element>
  32. <!-- object Visibility: default -->
  33. <element name="TExternalResourceReader">
  34. <short>External file resource reader</short>
  35. <descr>
  36. <p>This class provides a reader for .fpcres files: they are standalone files containing resources.</p>
  37. <p>Standalone files are files that don't get linked with the final executable. They are used as a
  38. fallback solution on all those platforms for which an internal resource format is not available.</p>
  39. <p>At runtime the resource file is read by Free Pascal RTL to provide resource support to the application.</p>
  40. <p>After an external file has been read, <link id="TExternalResourceReader.Endianess">Endianess</link> property holds the byte order used in the file.</p>
  41. </descr>
  42. <seealso>
  43. <link id="TExternalResourceReader.Endianess"/>
  44. <link id="resource.TAbstractResourceReader">TAbstractResourceReader</link>
  45. <link id="externalwriter.TExternalResourceWriter">TExternalResourceWriter</link>
  46. </seealso>
  47. </element>
  48. <!-- property Visibility: public -->
  49. <element name="TExternalResourceReader.Endianess">
  50. <short>The byte order used in the file</short>
  51. <descr>
  52. <p>This property holds the byte order (endianess) of the file that has been read.</p>
  53. <remark>Obviously, this property is meaningful only after a file has been read.</remark>
  54. </descr>
  55. <seealso>
  56. <link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link>
  57. <link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link>
  58. </seealso>
  59. </element>
  60. </module> <!-- externalreader -->
  61. </package>
  62. </fpdoc-descriptions>