mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-21 23:19:29 +02:00
Docs: InterfaceBase synced
git-svn-id: trunk@33170 -
This commit is contained in:
dodi
parent
6f5ea1d56b
commit
73f2164806
File diff suppressed because it is too large
Load Diff
@ -21,154 +21,202 @@
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TLCLComponent">
|
||||
<short>
|
||||
<var>TLCLComponent</var> - base class for LCL components</short>
|
||||
<short>The base class for LCL components associated with widgets.
|
||||
</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TLCLComponent.FWidgetSetClass">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLCLComponent.FWidgetSetClass" link="TLCLComponent.WidgetSetClass"/>
|
||||
<element name="TLCLComponent.FLCLRefCount" link="TLCLComponent.LCLRefCount"/>
|
||||
<!-- property Visibility: protected -->
|
||||
<element name="TLCLComponent.WidgetSetClass">
|
||||
<short>
|
||||
<var>WidgetSetClass</var> - the set of Widgets to be used by this Component</short>
|
||||
<short>The widget for this component is derived from WidgetSetClass.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLCLComponent.BeforeDestruction">
|
||||
<short>
|
||||
<var>BeforeDestruction</var> - code to execute before destruction of Control: performs inherited <var>Destroying</var> method</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<element name="TLCLComponent.WSRegisterClass">
|
||||
<short>Registers this component class with the current WidgetSet.
|
||||
</short>
|
||||
</element>
|
||||
<!-- class function Visibility: default -->
|
||||
<element name="TLCLComponent.GetWSComponentClass">
|
||||
<short>This method allows descendents to override the WidgetSetClass.
|
||||
</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<errors>
|
||||
</errors>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TComponent.Destroying">TComponent.Destroying</link>
|
||||
</seealso>
|
||||
</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 -->
|
||||
<element name="TLCLComponent.NewInstance">
|
||||
<short>
|
||||
<var>NewInstance</var> - performs inherited <var>NewInstance</var> to allocate space on the heap, and loads the correct WidgetSet</short>
|
||||
<short>Registers the class and initializes WidgetSetClass.
|
||||
</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso>
|
||||
<link id="TLCLComponent.WidgetSetClass"/>
|
||||
<link id="#rtl.System.TObject.NewInstance">TObject.NewInstance</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- function result Visibility: default -->
|
||||
<element name="TLCLComponent.NewInstance.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLCLComponent.RemoveAllHandlersOfObject">
|
||||
<short>
|
||||
<var>RemoveAllHandlersOfObject</var> - method for removing all of an object's handlers: part of a clean-up procedure</short>
|
||||
<descr/>
|
||||
<short>Override this method to remove all references to notification handlers in AnObject.
|
||||
</short>
|
||||
<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/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- argument Visibility: default -->
|
||||
<element name="TLCLComponent.RemoveAllHandlersOfObject.AnObject">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TLCLComponent.Create">
|
||||
<short>
|
||||
<var>Create</var> - constructor for <var>TLCLComponent</var>: calls inherited <var>Create</var>
|
||||
<short>The object whose handlers shall be removed.
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TComponent.Create">TComponent.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TLCLComponent.Destroy">
|
||||
<short>
|
||||
<var>Destroy</var> - destructor for <var>TLCLComponent</var>: calls inherited <var>Destroy</var>
|
||||
</short>
|
||||
<seealso>
|
||||
<link id="#rtl.Classes.TComponent.Destroy">TComponent.Destroy</link>
|
||||
</seealso>
|
||||
<element name="TLCLComponent.IncLCLRefCount" link="TLCLComponent.LCLRefCount"/>
|
||||
<element name="TLCLComponent.DecLCLRefCount" link="TLCLComponent.LCLRefCount"/>
|
||||
<element name="TLCLComponent.LCLRefCount">
|
||||
<short>The number of references to this component.</short>
|
||||
<descr>[Which are the possible owners of such references?]
|
||||
</descr>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TLCLReferenceComponent">
|
||||
<short>Base class for all components having a handle.</short>
|
||||
<descr>Apart from the OS/window manager specific window Handle, LCL components can include a Reference to an widgetset specific object.
|
||||
|
||||
Application use is restricted to sending messages to a windowed control, using its window Handle.
|
||||
</descr>
|
||||
</element>
|
||||
<element name="TLCLReferenceComponent.Destroy">
|
||||
<short>Destroys the Reference, prior to calling the inherited destructor.</short>
|
||||
<short>Base class for all components having an associated widget.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
The widget is created by the LCL control whenever required,
|
||||
and its reference is stored in FReferencePtr.
|
||||
This reference is for internal use by the LCL control, not by application code.
|
||||
</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>
|
||||
<link id="#LCL.LCLClasses.TLCLComponent.Destroy">TLCLComponent.Destroy</link>
|
||||
<link id="TLCLReferenceComponent.ReferenceNeeded"/>
|
||||
</seealso>
|
||||
</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">
|
||||
<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.
|
||||
|
||||
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>
|
||||
A window handle can be used for sending messages to the component.[?]</descr>
|
||||
</element>
|
||||
<element name="TLCLReferenceComponent.HandleAllocated" link="TLCLReferenceComponent.ReferenceAllocated"/>
|
||||
<element name="TLCLReferenceComponent.ReferenceAllocated">
|
||||
<short>
|
||||
<var>ReferenceAllocated</var> - if True, a handle (reference) has been allocated to this component</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>
|
||||
<short>If True, a Reference has been allocated for this component.
|
||||
</short>
|
||||
</element>
|
||||
</module>
|
||||
<!-- LCLClasses -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user