externalwriter.xml 4.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <fpdoc-descriptions>
  3. <package name="fcl-res">
  4. <!--
  5. ====================================================================
  6. externalwriter
  7. ====================================================================
  8. -->
  9. <module name="externalwriter">
  10. <short>Contains a resource writer for external resource files</short>
  11. <descr>
  12. <p>This unit contains <link id="TExternalResourceWriter"/>, a <link id="resource.TAbstractResourceWriter">TAbstractResourceWriter</link> descendant that is able to write 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="TExternalResourceWriter"/> 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="EExternalResourceWriterException">
  34. <short>Base class for external resource writer-related exceptions</short>
  35. </element>
  36. <!-- object Visibility: default -->
  37. <element name="EExternalResInvalidEndianessException">
  38. <short>Invalid endianess error</short>
  39. <descr>
  40. <p>This exception is raised when an attempt is made to set <link id="TExternalResourceWriter.Endianess">Endianess</link> property of a <link id="TExternalResourceWriter"/> object to a value other than <link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link> or <link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link>.</p>
  41. </descr>
  42. <seealso>
  43. <link id="TExternalResourceWriter.Endianess"/>
  44. </seealso>
  45. </element>
  46. <!-- object Visibility: default -->
  47. <element name="TExternalResStringTable">
  48. <short>External resource file string table</short>
  49. <descr>
  50. <p>This class is used internally by <link id="TExternalResourceWriter"/>.</p>
  51. </descr>
  52. </element>
  53. <!-- object Visibility: default -->
  54. <element name="TExternalResourceWriter">
  55. <short>External file resource writer</short>
  56. <descr>
  57. <p>This class provides a writer for .fpcres files: they are standalone files containing resources.</p>
  58. <p>Standalone files are files that don't get linked with the final executable. They are used as a
  59. fallback solution on all those platforms for which an internal resource format is not available.</p>
  60. <p>At runtime the resource file is read by Free Pascal RTL to provide resource support to the application.</p>
  61. <p><link id="TExternalResourceWriter.Endianess">Endianess</link> property can be used to set the byte order to use in the file to generate.</p>
  62. </descr>
  63. <seealso>
  64. <link id="TExternalResourceWriter.Endianess"/>
  65. <link id="resource.TAbstractResourceWriter">TAbstractResourceWriter</link>
  66. <link id="externalreader.TExternalResourceReader">TExternalResourceReader</link>
  67. </seealso>
  68. </element>
  69. <!-- property Visibility: public -->
  70. <element name="TExternalResourceWriter.Endianess">
  71. <short>The byte order to use in the file</short>
  72. <descr>
  73. <p>This property can be used to set the byte order (endianess) of the file to write.</p>
  74. <remark>If a value other than <link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link> or <link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link> is used, an <link id="EExternalResInvalidEndianessException"/> exception is raised.</remark>
  75. </descr>
  76. <seealso>
  77. <link id="externaltypes.EXT_ENDIAN_BIG">EXT_ENDIAN_BIG</link>
  78. <link id="externaltypes.EXT_ENDIAN_LITTLE">EXT_ENDIAN_LITTLE</link>
  79. </seealso>
  80. </element>
  81. </module> <!-- externalwriter -->
  82. </package>
  83. </fpdoc-descriptions>