paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-21 03:59:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: InterfaceBase synced

Browse Source 
git-svn-id: trunk@33170 -
This commit is contained in:
dodi 2011-10-30 11:43:23 +00:00
parent 6f5ea1d56b
commit 73f2164806
2 changed files with 2340 additions and 1147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3229
docs/xml/lcl/interfacebase.xml
View File

File diff suppressed because it is too large Load Diff

258
docs/xml/lcl/lclclasses.xml
View File

@ -21,154 +21,202 @@
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TLCLComponent"> <element name="TLCLComponent">
<short> <short>The base class for LCL components associated with widgets.
<var>TLCLComponent</var> - base class for LCL components</short> </short>
<descr/> <descr/>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TLCLComponent.FWidgetSetClass"> <element name="TLCLComponent.FWidgetSetClass" link="TLCLComponent.WidgetSetClass"/>
<short/> <element name="TLCLComponent.FLCLRefCount" link="TLCLComponent.LCLRefCount"/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: protected --> <!-- property Visibility: protected -->
<element name="TLCLComponent.WidgetSetClass"> <element name="TLCLComponent.WidgetSetClass">
<short> <short>The widget for this component is derived from WidgetSetClass.
<var>WidgetSetClass</var> - the set of Widgets to be used by this Component</short> </short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>
<!-- procedure Visibility: public --> <element name="TLCLComponent.WSRegisterClass">
<element name="TLCLComponent.BeforeDestruction"> <short>Registers this component class with the current WidgetSet.
<short> </short>
<var>BeforeDestruction</var> - code to execute before destruction of Control: performs inherited <var>Destroying</var> method</short> </element>
<descr/> <!-- class function Visibility: default -->
<errors/> <element name="TLCLComponent.GetWSComponentClass">
<short>This method allows descendents to override the WidgetSetClass.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso> <seealso>
<link id="#rtl.Classes.TComponent.Destroying">TComponent.Destroying</link>
</seealso> </seealso>
</element> </element>
<element name="TLCLComponent.GetWSComponentClass.Result">
<short></short>
</element>
<element name="TLCLComponent.GetWSComponentClass.ASelf">
<short></short>
</element>
<element name="TLCLComponent.Create"/>
<element name="TLCLComponent.Create.TheOwner">
<short></short>
</element>
<element name="TLCLComponent.Destroy"/>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TLCLComponent.NewInstance"> <element name="TLCLComponent.NewInstance">
<short> <short>Registers the class and initializes WidgetSetClass.
<var>NewInstance</var> - performs inherited <var>NewInstance</var> to allocate space on the heap, and loads the correct WidgetSet</short> </short>
<descr/> <descr/>
<errors/> <errors/>
<seealso> <seealso>
<link id="TLCLComponent.WidgetSetClass"/>
<link id="#rtl.System.TObject.NewInstance">TObject.NewInstance</link> <link id="#rtl.System.TObject.NewInstance">TObject.NewInstance</link>
</seealso> </seealso>
</element> </element>
<!-- function result Visibility: default -->
<element name="TLCLComponent.NewInstance.Result"> <element name="TLCLComponent.NewInstance.Result">
<short/> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TLCLComponent.RemoveAllHandlersOfObject"> <element name="TLCLComponent.RemoveAllHandlersOfObject">
<short> <short>Override this method to remove all references to notification handlers in AnObject.
<var>RemoveAllHandlersOfObject</var> - method for removing all of an object's handlers: part of a clean-up procedure</short> </short>
<descr/> <descr>An override is required as soon as a component allows to add notification handlers.
Then all such handlers must be removed, when their owner (AnObject) is destroyed.
</descr>
<errors/> <errors/>
<seealso/> <seealso/>
</element> </element>
<!-- argument Visibility: default -->
<element name="TLCLComponent.RemoveAllHandlersOfObject.AnObject"> <element name="TLCLComponent.RemoveAllHandlersOfObject.AnObject">
<short/> <short>The object whose handlers shall be removed.
</element>
<element name="TLCLComponent.Create">
<short>
<var>Create</var> - constructor for <var>TLCLComponent</var>: calls inherited <var>Create</var>
</short> </short>
<seealso>
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
</seealso>
</element> </element>
<element name="TLCLComponent.Destroy"> <element name="TLCLComponent.IncLCLRefCount" link="TLCLComponent.LCLRefCount"/>
<short> <element name="TLCLComponent.DecLCLRefCount" link="TLCLComponent.LCLRefCount"/>
<var>Destroy</var> - destructor for <var>TLCLComponent</var>: calls inherited <var>Destroy</var> <element name="TLCLComponent.LCLRefCount">
</short> <short>The number of references to this component.</short>
<seealso> <descr>[Which are the possible owners of such references?]
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link> </descr>
</seealso>
</element> </element>
<!-- object Visibility: default -->
<element name="TLCLReferenceComponent"> <element name="TLCLReferenceComponent">
<short>Base class for all components having a handle.</short> <short>Base class for all components having an associated widget.
<descr>Apart from the OS/window manager specific window Handle, LCL components can include a Reference to an widgetset specific object. </short>
<descr>
Application use is restricted to sending messages to a windowed control, using its window Handle. <p>
</descr> The widget is created by the LCL control whenever required,
</element> and its reference is stored in FReferencePtr.
<element name="TLCLReferenceComponent.Destroy"> This reference is for internal use by the LCL control, not by application code.
<short>Destroys the Reference, prior to calling the inherited destructor.</short> </p><p>
This reference is [can be?] different from the OS/window manager specific window Handle.
</p><p>
Applications only can send messages to a windowed control,
using its window Handle.
</p>
</descr>
<seealso> <seealso>
<link id="#LCL.LCLClasses.TLCLComponent.Destroy">TLCLComponent.Destroy</link> <link id="TLCLReferenceComponent.ReferenceNeeded"/>
</seealso> </seealso>
</element> </element>
<!-- variable Visibility: private -->
<element name="TLCLReferenceComponent.FReferencePtr">
<short>Pointer to a widget class Reference.</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TLCLReferenceComponent.FCreating">
<short>Set while we are creating the Reference.</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- function Visibility: private -->
<element name="TLCLReferenceComponent.GetHandle" link="TLCLReferenceComponent.Handle"/>
<element name="TLCLReferenceComponent.GetHandle.Result">
<short></short>
</element>
<!-- function Visibility: private -->
<element name="TLCLReferenceComponent.GetReferenceAllocated">
<short>Checks for a valid widget reference.
</short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="TLCLReferenceComponent.GetReferenceAllocated.Result">
<short></short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.CreateParams">
<short>Override this method to supply specific widget creation parameters.
</short>
</element>
<element name="TLCLReferenceComponent.CreateParams.AParams">
<short>The parameter record to update.</short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.DestroyReference">
<short>Destroys the reference object.
</short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.GetReferenceHandle">
<short>Override this method to return the Handle from the reference [what is Handle?]
</short>
</element>
<element name="TLCLReferenceComponent.GetReferenceHandle.Result">
<short></short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.ReferenceCreated">
<short>Called after the Reference is created.</short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.ReferenceDestroying">
<short>Called before the Reference is destroyed</short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.ReferenceNeeded">
<short>Creates a Reference, if not already done.
</short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.WSCreateReference">
<short>Tells the widgetset to create a Reference.
</short>
<descr>This implementation returns Nil, should be overriden in every derived class.
</descr>
</element>
<element name="TLCLReferenceComponent.WSCreateReference.Result">
<short></short>
</element>
<element name="TLCLReferenceComponent.WSCreateReference.AParams">
<short></short>
</element>
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.WSDestroyReference">
<short>Tells the widgetset to destroy the Reference.</short>
</element>
<!-- function Visibility: public -->
<element name="TLCLReferenceComponent.Destroy"/>
<element name="TLCLReferenceComponent.Handle"> <element name="TLCLReferenceComponent.Handle">
<short>Get the Handle of this component.</short> <short>Get the Handle of this component.</short>
<descr>The Handle is sort of pointer or reference, allocated by the operating system or widgetset to this component. <descr>The Handle is sort of pointer or reference, allocated by the operating system or widgetset to this component.
A window handle can be used for sending messages to the component.[?]</descr>
A window handle can be used for sending messages to the component.[?]</descr>
</element>
<element name="TLCLReferenceComponent.HandleAllocated">
<short>
<var>HandleAllocated</var> - if True, a handle (reference) has been allocated to this component</short>
</element> </element>
<element name="TLCLReferenceComponent.HandleAllocated" link="TLCLReferenceComponent.ReferenceAllocated"/>
<element name="TLCLReferenceComponent.ReferenceAllocated"> <element name="TLCLReferenceComponent.ReferenceAllocated">
<short> <short>If True, a Reference has been allocated for this component.
<var>ReferenceAllocated</var> - if True, a handle (reference) has been allocated to this component</short> </short>
</element>
<element name="TLCLReferenceComponent.CreateParams">
<short>
<var>CreateParams</var> - create parameters</short>
</element>
<element name="TLCLReferenceComponent.GetReferenceHandle">
<short>
<var>GetReferenceHandle</var> - returns the Handle for this reference</short>
</element>
<element name="TLCLReferenceComponent.DestroyReference">
<short>
<var>DestroyReference</var> - destroys the reference if it has been allocated and adjusts the pointers</short>
</element>
<element name="TLCLReferenceComponent.ReferenceDestroying">
<short>
<var>ReferenceDestroying</var> - the reference is being destroyed; gets called before the Handle is destroyed</short>
</element>
<element name="TLCLReferenceComponent.ReferenceNeeded">
<short>If <var>ReferenceNeeded</var> and not yet allocated, creates a reference using the correct widgetset and parameters</short>
</element>
<element name="TLCLComponent.IncLCLRefCount">
<short>
<var>IncLCLRefCount</var> - method for incrementing the reference count</short>
</element>
<element name="TLCLComponent.DecLCLRefCount">
<short>
<var>DecLCLRefCount</var> - method for decrementing the reference count</short>
</element>
<element name="TLCLComponent.LCLRefCount">
<short>
<var>LCLRefCount</var> - the number of references to this component</short>
</element>
<element name="TLCLReferenceComponent.ReferenceCreated">
<short>
<var>ReferenceCreated</var> - gets called after the Handle is created</short>
</element>
<element name="TLCLReferenceComponent.WSCreateReference">
<short>
<var>WSCreateReference</var> - returns a widget set reference</short>
<descr>this function returns nil and should be overriden in derrived class
</descr>
</element>
<element name="TLCLReferenceComponent.WSDestroyReference">
<short>
<var>WSDestroyReference</var> - destroys widget set reference</short>
</element>
<element name="TLCLComponent.WSRegisterClass">
<short>
<var>WSRegisterClass</var> - Register this Class for the current Widget Set</short>
</element> </element>
</module> </module>
<!-- LCLClasses --> <!-- LCLClasses -->