mirror of
https://gitlab.com/freepascal.org/fpc/source.git
synced 2025-04-13 20:19:26 +02:00
174de3eab1
svn+ssh://svn.freepascal.org/FPC/svn/fpc/branches/resources
........
r9694 | michael | 2008-01-09 21:31:18 +0100 (Wed, 09 Jan 2008) | 1 line
* Initial check-in
........
r9695 | michael | 2008-01-09 21:35:58 +0100 (Wed, 09 Jan 2008) | 1 line
* New version from Giulio Bernardi
........
r9697 | michael | 2008-01-09 21:41:54 +0100 (Wed, 09 Jan 2008) | 1 line
* Patch from Giulio Bernardi with resource support
........
r9698 | michael | 2008-01-09 21:46:33 +0100 (Wed, 09 Jan 2008) | 1 line
* Patch from Giulio Bernardi to add more resource testing
........
r9699 | michael | 2008-01-09 21:57:26 +0100 (Wed, 09 Jan 2008) | 1 line
* New tool from Giulio Bernardi
........
r9700 | michael | 2008-01-09 21:58:23 +0100 (Wed, 09 Jan 2008) | 1 line
* New tool from Giulio Bernardi
........
r9701 | michael | 2008-01-09 22:01:54 +0100 (Wed, 09 Jan 2008) | 1 line
* Added fcl-res
........
r9702 | michael | 2008-01-09 22:01:58 +0100 (Wed, 09 Jan 2008) | 1 line
* Added fcl-res
........
r9703 | michael | 2008-01-10 08:54:26 +0100 (Thu, 10 Jan 2008) | 1 line
* Fixed double code
........
r9704 | jonas | 2008-01-10 10:59:20 +0100 (Thu, 10 Jan 2008) | 2 lines
- removed duplicate code
........
r9705 | jonas | 2008-01-10 11:25:21 +0100 (Thu, 10 Jan 2008) | 2 lines
+ added missing fcl-res dependencies
........
r9706 | jonas | 2008-01-10 11:58:30 +0100 (Thu, 10 Jan 2008) | 2 lines
+ dependencies for fpintres and fpextres
........
r9707 | yury | 2008-01-10 12:47:51 +0100 (Thu, 10 Jan 2008) | 3 lines
* Fixed compilation of resource, which is included in a unit located in different folder than main source.
* .res files must be copied to units output folder, otherwise .res files will not be found when only compiled units path is available and compiler does not know anything about sources folder.
* Improved resource related error messages.
........
r9708 | michael | 2008-01-10 12:52:13 +0100 (Thu, 10 Jan 2008) | 1 line
* Removed double source after end.
........
r9709 | michael | 2008-01-10 12:52:48 +0100 (Thu, 10 Jan 2008) | 1 line
* No longer needed
........
r9710 | tom_at_work | 2008-01-10 22:09:08 +0100 (Thu, 10 Jan 2008) | 1 line
* properly align FPC_RESLOCATION so that linking does not fail on some architectures (e.g. ppc64)
........
r9711 | tom_at_work | 2008-01-10 23:53:12 +0100 (Thu, 10 Jan 2008) | 1 line
* fix splitting of 64 bit load/stores from/to unaligned memory locations into multiple load/stores, which in some cases generated wrong code
........
r9712 | michael | 2008-01-11 11:00:08 +0100 (Fri, 11 Jan 2008) | 1 line
* Fixed bug in BSS section on 64-bit platforms
........
r9720 | giulio | 2008-01-12 10:02:04 +0100 (Sat, 12 Jan 2008) | 1 line
Updated fcl-res documentation: occurrences of reslib changed to fcl-res.
........
r9740 | giulio | 2008-01-13 19:36:44 +0100 (Sun, 13 Jan 2008) | 3 lines
- Don't try to compile resources on systems with a non windows-like resource support.
- Don't add the .or file to the list of object files if resource compiling failed.
........
r10201 | giulio | 2008-02-04 11:35:44 +0100 (Mon, 04 Feb 2008) | 5 lines
* resource compiling supported on OS/2 via wrc
* CompileResourceFiles and CollectResourceFiles don't do target-specific checks anymore
* refactored a bit
........
r10389 | giulio | 2008-02-25 21:32:52 +0100 (Mon, 25 Feb 2008) | 2 lines
Deleted test file which was committed by mistake
........
r10472 | giulio | 2008-03-10 12:22:18 +0100 (Mon, 10 Mar 2008) | 2 lines
changed define FPC_HAS_RESOURCES to FPC_HAS_WINLIKERESOURCES
........
git-svn-id: trunk@10481 -
229 lines
7.7 KiB
XML
229 lines
7.7 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
|
<fpdoc-descriptions>
|
|
<package name="fcl-res">
|
|
|
|
<!--
|
|
====================================================================
|
|
acceleratorsresource
|
|
====================================================================
|
|
-->
|
|
|
|
<module name="acceleratorsresource">
|
|
<short>Contains an accelerator table resource type</short>
|
|
<descr>
|
|
<p>This unit contains <link id="TAcceleratorsResource"/>, a <link id="resource.TAbstractResource">TAbstractResource</link> descendant specialized in handling resource of type <link id="resource.RT_ACCELERATOR">RT_ACCELERATOR</link>.</p>
|
|
<p>Adding this unit to a program's <var>uses</var> clause registers class <link id="TAcceleratorsResource"/> for type <link id="resource.RT_ACCELERATOR">RT_ACCELERATOR</link> with <link id="resfactory.TResourceFactory">TResourceFactory</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>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="FVirtKey">
|
|
<short>The accelerator key is a virtual key code</short>
|
|
<descr>
|
|
<p>When this flag is set, the accelerator key is a virtual key code. Otherwise, it is a ASCII character</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="FNoInvert">
|
|
<short>Obsolete</short>
|
|
<descr>
|
|
<p>This flag is obsolete and is provided only for compatibility with 16 bit Windows.</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="FShift">
|
|
<short>The accelerator is activated only if <var>SHIFT</var> key is pressed</short>
|
|
<descr>
|
|
<p>This flag is valid only if the key is a virtual key.</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="FControl">
|
|
<short>The accelerator is activated only if <var>CTRL</var> key is pressed</short>
|
|
<descr>
|
|
<p>This flag is valid only if the key is a virtual key.</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- constant Visibility: default -->
|
|
<element name="FAlt">
|
|
<short>The accelerator is activated only if <var>ALT</var> key is pressed</short>
|
|
<descr>
|
|
<p>This flag is valid only if the key is a virtual key.</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- record type Visibility: default -->
|
|
<element name="TAccelerator">
|
|
<short>A single accelerator entry</short>
|
|
<descr>
|
|
<p>A single accelerator entry in the accelerator table resource.</p>
|
|
<p>The key associated with the accelerator is represented by <var>Ansi</var> field: it can be a character or a virtual-key code (in the latter case, <link id="FVirtKey"/> flag must be active).</p>
|
|
<p>The accelerator is identified by the value of <var>id</var> field.</p>
|
|
<p><var>Flags</var> is a combination of the following values:</p>
|
|
<ul>
|
|
<li><link id="FVirtKey"/></li>
|
|
<li><link id="FShift"/></li>
|
|
<li><link id="FNoInvert"/></li>
|
|
<li><link id="FControl"/></li>
|
|
<li><link id="FAlt"/></li>
|
|
</ul>
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TAccelerator.Flags">
|
|
<short>A set of flags that can be combined to specify an accelerator's characteristics.</short>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TAccelerator.Ansi">
|
|
<short>An ANSI character value or a virtual-key code</short>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TAccelerator.Id">
|
|
<short>An integer value that identifies the accelerator</short>
|
|
</element>
|
|
|
|
<!-- variable Visibility: default -->
|
|
<element name="TAccelerator.padding">
|
|
<short>Used to keep record size aligned on a DWORD boundary</short>
|
|
</element>
|
|
|
|
<!-- pointer type Visibility: default -->
|
|
<element name="PAccelerator">
|
|
<short>A pointer to a TAccelerator record</short>
|
|
<seealso>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- object Visibility: default -->
|
|
<element name="TAcceleratorsResource">
|
|
<short>Accelerator table resource type</short>
|
|
<descr>
|
|
<p>This class represents a resource of type <link id="resource.RT_ACCELERATOR">RT_ACCELERATOR</link>.</p>
|
|
<p>An accelerator table resource is a collection of accelerators (represented by <link id="TAccelerator"/> records).</p>
|
|
<p>An accelerator represents a keystroke that can be associated with some action.</p>
|
|
<p>This resource type is very Microsoft Windows-specific, so it might not be of interest for many users.</p>
|
|
<p>Methods are provided to add, delete and modify single accelerators.</p>
|
|
<remark>This class doesn't allow its type to be changed to anything else than <link id="resource.RT_ACCELERATOR">RT_ACCELERATOR</link>. Attempts to do so result in a <link id="resource.EResourceDescChangeNotAllowedException">EResourceDescChangeNotAllowedException</link>.</remark>
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- constructor Visibility: public -->
|
|
<element name="TAcceleratorsResource.Create">
|
|
<short>Creates a new accelerator table resource</short>
|
|
<descr>
|
|
<p>Please note that <var>aType</var> parameter is not used, since this class always uses <link id="resource.RT_ACCELERATOR">RT_ACCELERATOR</link> as type.</p>
|
|
</descr>
|
|
</element>
|
|
|
|
<!-- argument Visibility: default -->
|
|
<element name="TAcceleratorsResource.Create.aType">
|
|
<short>Ignored. Can be <var>nil</var>.</short>
|
|
</element>
|
|
|
|
<!-- argument Visibility: default -->
|
|
<element name="TAcceleratorsResource.Create.aName">
|
|
<short>The name of the resource</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TAcceleratorsResource.Add">
|
|
<short>Adds a new accelerator to the table</short>
|
|
<seealso>
|
|
<link id="TAcceleratorsResource.Items"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- argument Visibility: default -->
|
|
<element name="TAcceleratorsResource.Add.aItem">
|
|
<short>The accelerator to add</short>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TAcceleratorsResource.Clear">
|
|
<short>Empties the accelerator table</short>
|
|
<seealso>
|
|
<link id="TAcceleratorsResource.Items"/>
|
|
<link id="TAcceleratorsResource.Delete"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- procedure Visibility: public -->
|
|
<element name="TAcceleratorsResource.Delete">
|
|
<short>Deletes an accelerator from the table</short>
|
|
<seealso>
|
|
<link id="TAcceleratorsResource.Items"/>
|
|
<link id="TAcceleratorsResource.Clear"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- argument Visibility: default -->
|
|
<element name="TAcceleratorsResource.Delete.aIndex">
|
|
<short>The index of the accelerator to delete</short>
|
|
</element>
|
|
|
|
<!-- property Visibility: public -->
|
|
<element name="TAcceleratorsResource.Count">
|
|
<short>The number of accelerators in the table</short>
|
|
<seealso>
|
|
<link id="TAcceleratorsResource.Items"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- property Visibility: public -->
|
|
<element name="TAcceleratorsResource.Items">
|
|
<short>Indexed array of accelerators in the table</short>
|
|
<descr>
|
|
<p>This property can be used to access all accelerators in the object.</p>
|
|
<remark>This array is 0-based: valid elements range from 0 to <link id="TAcceleratorsResource.Count">Count</link>-1.</remark>
|
|
<remark>If you need to access <link id="resource.TAbstractResource.RawData">RawData</link> after you added, deleted or modified accelerators, be sure to call <link id="resource.TAbstractResource.UpdateRawData">UpdateRawData</link> first. This isn't needed however when resource is written to a stream, since <link id="resource.TResources">TResources</link> takes care of it.</remark>
|
|
</descr>
|
|
<seealso>
|
|
<link id="TAcceleratorsResource.Count"/>
|
|
<link id="TAccelerator"/>
|
|
</seealso>
|
|
</element>
|
|
|
|
<!-- argument Visibility: default -->
|
|
<element name="TAcceleratorsResource.Items.index">
|
|
<short>The index of the accelerator to access</short>
|
|
</element>
|
|
|
|
</module> <!-- acceleratorsresource -->
|
|
|
|
</package>
|
|
</fpdoc-descriptions>
|