Merge branch 'lazarus'

This commit is contained in:
dsiders 2022-08-19 02:23:33 +01:00
commit f27fb527a1
5 changed files with 107 additions and 24 deletions

View File

@ -244,9 +244,18 @@ threshold is exceeded.
<short>
Gets a TCustomImageList instance with the specified image size.
</short>
<descr>
<p>
Called from the RegisterBitmap method when the cache item is retrieved for a
registered cached listener.
</p>
</descr>
</element>
<element name="TImageListCache.GetImageListFor.Result">
<short/>
<short>
Image list using the specified image size retrieved from the cache or created
on demand.
</short>
</element>
<element name="TImageListCache.GetImageListFor.AWidth">
<short>Width for the images in the image list.</short>

View File

@ -1631,21 +1631,34 @@ the value in both Height and Width are set to <b>0</b> (<b>zero</b>).
<element name="TScaledImageListResolution.StretchDraw">
<short>Draws the scaled image sized to the target rectangle.</short>
<descr>
<p>
Calls the StretchDraw method in the Resolution member.
</p>
</descr>
<seealso>
<link id="TCustomImageListResolution.StretchDraw"/>
</seealso>
</element>
<element name="TScaledImageListResolution.StretchDraw.ACanvas">
<short/>
<short>
Canvas where the specified image is drawn.
</short>
</element>
<element name="TScaledImageListResolution.StretchDraw.Index">
<short/>
<short>
Ordinal position for the image drawn in method.
</short>
</element>
<element name="TScaledImageListResolution.StretchDraw.ARect">
<short/>
<short>
Rectangle with the coordinates where the image is drawn on the canvas.
</short>
</element>
<element name="TScaledImageListResolution.StretchDraw.Enabled">
<short/>
<short>
<b>True</b> if the image is drawn in the enabled state.
</short>
</element>
<element name="TScaledImageListResolution.DrawOverlay">

View File

@ -47,9 +47,52 @@ Enumerated type which represents the dialog kind in a Lazarus dialog form.
</element>
<element name="TLazarusFileDialogForm">
<short></short>
<descr></descr>
<seealso></seealso>
<short>
Implements the form displayed for TLazOpenDialog descendants.
</short>
<descr>
<p>
<var>TLazarusFileDialogForm</var> is a <var>TForm</var> descendant which
implements the form displayed for dialogs which are not wrappers for native
dialogs on a given platform. The form includes public members that are used
to store input or output values for the dialog, like:
</p>
<ul>
<li>FileName</li>
<li>Filter</li>
<li>IntialDir</li>
<li>Title</li>
</ul>
<p>
It includes public user interface elements needed for the dialog form. The
active UI elements are determined by the TLazFileDialogKind value passed as
an argument when a dialog calls the Initialize method for the form. The UI
elements include:
</p>
<ul>
<li>ShellTreeView (TShellTreeView)</li>
<li>ShellListView (TShellListView)</li>
<li>SaveEdit (TEdit)</li>
<li>FilterComboBox (TFilterComboBox)</li>
<li>ButtonPanel (TButtonPanel)</li>
</ul>
<p>
TLazarusFileDialogForm includes methods that implement routines assigned to
event handlers in the various UI elements. The routines perform actions like
setting the ModalResult value when a button is clicked, updating FileName
from selected nodes in the shell controls, and enabling / disabling controls
as needed.
</p>
<p>
TLazarusFileDialogForm is used to implement the private form member in the
TLazOpenDialog component.
</p>
</descr>
<seealso>
<link id="TLazOpenDialog"/>
<link id="TLazFileDialogKind"/>
<link id="#lcl.forms.TForm">TForm</link>
</seealso>
</element>
<element name="TLazarusFileDialogForm.FKind">
@ -93,10 +136,10 @@ Button panel for the Lazarus dialog form.
<descr>
<p>
<var>ButtonPanel</var> is a <var>TButtonPanel</var> member that contains the
buttons appropriate for the kind of Lazarus dialog. ButtonPanel is configured
by default to display and respond to Ok and Cancel buttons in the Initialize
method. Specialized dialog types can alter the default buttons and their
actions.
buttons appropriate for a specific kind of Lazarus dialog. ButtonPanel is
configured by default to display and respond to Ok and Cancel buttons in the
Initialize method. Specialized dialog types can alter the default buttons and
their actions.
</p>
</descr>
<seealso>
@ -122,7 +165,7 @@ Shell list view control for the Lazarus dialog form.
</element>
<element name="TLazarusFileDialogForm.SaveEdit">
<short></short>
<short>Edit control used for a FileName on the dialog form.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -232,7 +275,7 @@ Lazarus dialog form appropriate for the dialog type specified in AKind.
<p>
The value in AKind is stored in an internal member in the class instance, and
is used to determine the child controls configured and displayed on the
Lazarus dialog form. It affects the following child controls:
Lazarus dialog form. It affects the following:
</p>
<ul>
<li>ShellTreeView</li>

View File

@ -231,18 +231,18 @@ Handle.
<!-- function Visibility: private -->
<element name="TLCLReferenceComponent.GetHandle" link="#lcl.lclclasses.TLCLReferenceComponent.Handle"/>
<element name="TLCLReferenceComponent.GetHandle.Result">
<short/>
</element>
<element name="TLCLReferenceComponent.GetHandle.Result"/>
<!-- function Visibility: private -->
<element name="TLCLReferenceComponent.GetReferenceAllocated">
<short>Checks for a valid widget reference.</short>
<short>Gets the value for the ReferenceAllocated property.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TLCLReferenceComponent.GetReferenceAllocated.Result">
<short/>
<short>
Value for the ReferenceAllocated property.
</short>
</element>
<!-- function Visibility: protected -->
@ -263,9 +263,14 @@ Override this method to supply specific widget creation parameters.
<!-- function Visibility: protected -->
<element name="TLCLReferenceComponent.GetReferenceHandle">
<short>Override this method to return the Handle from the reference.</short>
<seealso>
<link id="TLCLReferenceComponent.HandleAllocated"/>
</seealso>
</element>
<element name="TLCLReferenceComponent.GetReferenceHandle.Result">
<short/>
<short>
<b>True</b> if both the component reference pointer and its Handle have been allocated.
</short>
</element>
<!-- function Visibility: protected -->
@ -287,14 +292,25 @@ Override this method to supply specific widget creation parameters.
<element name="TLCLReferenceComponent.WSCreateReference">
<short>Tells the widgetset to create a Reference.</short>
<descr>
This implementation returns Nil, and should be overridden in derived classes.
<p>
This implementation returns <b>Nil</b>, and should be overridden in derived
classes.
</p>
</descr>
<seealso>
<link id="TLCLReferenceComponent.ReferenceNeeded"/>
</seealso>
</element>
<element name="TLCLReferenceComponent.WSCreateReference.Result">
<short/>
<short>
Pointer to the reference for the widgetset class instance, or <b>Nil</b> when
not allocated.
</short>
</element>
<element name="TLCLReferenceComponent.WSCreateReference.AParams">
<short/>
<short>
Creation parameters for the reference.
</short>
</element>
<!-- function Visibility: protected -->

View File

@ -437,7 +437,9 @@ inherited constructor on entry. Create sets the value for the
</seealso>
</element>
<element name="TPrinterCanvas.Create.APrinter">
<short/>
<short>
Printer where the canvas class instance is used.
</short>
</element>
<element name="TPrinterCanvas.BeginDoc">