paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-07 06:38:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL. Fixes missing punctuation in short descriptions (partial).

Browse Source 
git-svn-id: trunk@65266 -
This commit is contained in:
dsiders 2021-06-18 03:19:11 +00:00
parent 2bce16012a
commit 322d30c7e8
17 changed files with 2083 additions and 2084 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/xml/lcl/comctrls.xml
View File

@ -23061,7 +23061,7 @@ OldExpanded.Free;
</seealso>
</element>
<element name="THeaderSection.Assign.Source">
<short> </short>
<short></short>
</element>
<element name="THeaderSection.Left">
@ -23318,16 +23318,16 @@ OldExpanded.Free;
</short>
</element>
<element name="TCustomSectionTrackEvent.HeaderControl">
<short> </short>
<short></short>
</element>
<element name="TCustomSectionTrackEvent.Section">
<short> </short>
<short></short>
</element>
<element name="TCustomSectionTrackEvent.Width">
<short> </short>
<short></short>
</element>
<element name="TCustomSectionTrackEvent.State">
<short> </short>
<short></short>
</element>
<element name="TSectionDragEvent">

2
docs/xml/lcl/dblogdlg.xml
View File

@ -47,7 +47,7 @@
<element name="TLoginDialog.lDatabase">
<short>Label for the Database Name field.</short>
<short>.</short>
<short></short>
<descr/>
<seealso/>
</element>

76
docs/xml/lcl/editbtn.xml
View File

@ -345,27 +345,27 @@
</element>
<element name="TCustomEditButton.BuddyClick">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomEditButton.GetEditorClassType">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomEditButton.GetEditorClassType.Result">
<short>.</short>
<short></short>
</element>
<element name="TCustomEditButton.GetBuddyClassType">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomEditButton.GetBuddyClassType.Result">
<short>.</short>
<short></short>
</element>
<element name="TCustomEditButton.GetControlClassDefaultSize">
@ -410,7 +410,7 @@
</seealso>
</element>
<element name="TCustomEditButton.CalcButtonVisible.Result">
<short>.</short>
<short></short>
</element>
<element name="TCustomEditButton.GetDefaultGlyphName">
@ -421,7 +421,7 @@
<seealso></seealso>
</element>
<element name="TCustomEditButton.GetDefaultGlyphName.Result">
<short>.</short>
<short></short>
</element>
<element name="TCustomEditButton.CalculatePreferredSize" link="#lcl.groupededit.TCustomAbstractGroupedEdit.CalculatePreferredSize"/>
@ -459,7 +459,7 @@
<seealso></seealso>
</element>
<element name="TCustomEditButton.GlyphChanged.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCustomEditButton.Button">
@ -903,7 +903,7 @@
<short>Object for the event notification.</short>
</element>
<element name="TCustomControlFilterEdit.OnIdle.Done">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.IsTextHintStored">
@ -1008,10 +1008,10 @@
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.EditKeyDown.Key">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.EditKeyDown.Shift">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.EditChange">
@ -1021,7 +1021,7 @@
</element>
<element name="TCustomControlFilterEdit.BuddyClick">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
@ -1059,80 +1059,80 @@
</element>
<element name="TCustomControlFilterEdit.MoveNext">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.MoveNext.ASelect">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.MovePrev">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.MovePrev.ASelect">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.MovePageUp">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.MovePageUp.ASelect">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.MovePageDown">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.MovePageDown.ASelect">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.MoveHome">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.MoveHome.ASelect">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.MoveEnd">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.MoveEnd.ASelect">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.ReturnKeyHandled">
<short>.</short>
<short></short>
<descr>
Abstract virtual method that must be implemented in a descendent class.
</descr>
<seealso></seealso>
</element>
<element name="TCustomControlFilterEdit.ReturnKeyHandled.Result">
<short>.</short>
<short></short>
</element>
<element name="TCustomControlFilterEdit.GetDefaultGlyphName" link="#lcl.editbtn.TCustomEditButton.GetDefaultGlyphName"/>
@ -1207,7 +1207,7 @@
</element>
<element name="TCustomControlFilterEdit.RestoreSelection">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
@ -1315,7 +1315,7 @@
</element>
<element name="TCustomControlFilterEdit.OnFilterItemEx">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
@ -1587,7 +1587,7 @@
<seealso></seealso>
</element>
<element name="TFileNameEdit.DoFolderChange.Sender">
<short>.</short>
<short></short>
</element>
<element name="TFileNameEdit.Create" link="#LCL.EditBtn.TCustomEditButton.Create">
@ -1888,7 +1888,7 @@
</element>
<element name="TDirectoryEdit.GetDefaultGlyphName" link="#LCL.EditBtn.TCustomEditButton.GetDefaultGlyphName">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
@ -2069,7 +2069,7 @@
</element>
<element name="TDirectoryEdit.DialogOptions">
<short>.</short>
<short></short>
<descr>
<p>
The default value for the property is defined in the <var>DefaultOpenDialogOptions</var> set type.
@ -2570,7 +2570,7 @@
<seealso></seealso>
</element>
<element name="TDateEdit.GetDateFormat.Result">
<short>.</short>
<short></short>
</element>
<element name="TDateEdit.AutoSelected" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.AutoSelected"/>
@ -2895,18 +2895,18 @@
</element>
<element name="TTimeEdit.TryParseInput">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TTimeEdit.TryParseInput.Result">
<short>.</short>
<short></short>
</element>
<element name="TTimeEdit.TryParseInput.AInput">
<short>.</short>
<short></short>
</element>
<element name="TTimeEdit.TryParseInput.ParseResult">
<short>.</short>
<short></short>
</element>
<element name="TTimeEdit.GetDefaultGlyphName">
@ -3060,7 +3060,7 @@
<element name="TTimeEdit.ShowHint" link="#LCL.Controls.TControl.ShowHint"/>
<element name="TTimeEdit.SimpleLayout">
<short>.</short>
<short></short>
<descr>
<p>
<var>SimpleLayout</var> is a <var>Boolean</var> property which indicates if the popup dialog for the control uses the 2 (rows) by 6 (columns) layout with 30 minute intervals between time values. The default value for the property is <b>True</b>. When set to <b>False</b>, a more detailed layout with 12 rows by 5 columns using 5 minute time intervals is used.
@ -3266,7 +3266,7 @@
<element name="TCalcEdit.Constraints" link="#LCL.Controls.TControl.Constraints"/>
<element name="TCalcEdit.DialogPosition">
<short>.</short>
<short></short>
<descr>
The default value for the property is <var>poScreenCenter</var>.
</descr>

26
docs/xml/lcl/extdlgs.xml
View File

@ -950,7 +950,7 @@
</seealso>
</element>
<element name="TCalculatorDialog.DefaultTitle.Result">
<short>.</short>
<short></short>
</element>
<element name="TCalculatorDialog.DisplayChange">
@ -1302,10 +1302,10 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnDialogClose.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnDialogClose.CloseAction">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnDialogCloseQuery">
@ -1316,10 +1316,10 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnDialogCloseQuery.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnDialogCloseQuery.CanClose">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnDialogShow">
@ -1330,7 +1330,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnDialogShow.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnCalendarDayChanged">
@ -1341,7 +1341,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarDayChanged.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnCalendarMonthChanged">
@ -1352,7 +1352,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarMonthChanged.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnCalendarYearChanged">
@ -1363,7 +1363,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarYearChanged.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.OnCalendarChange">
@ -1374,7 +1374,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarChange.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
@ -1387,7 +1387,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.GetNewDate.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.CalendarDblClick">
@ -1398,7 +1398,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.CalendarDblClick.Sender">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.DefaultTitle">
@ -1409,7 +1409,7 @@
<seealso></seealso>
</element>
<element name="TCalendarDialog.DefaultTitle.Result">
<short>.</short>
<short></short>
</element>
<element name="TCalendarDialog.Create" link="#rtl.classes.TComponent.Create">

208
docs/xml/lcl/graphutil.xml
View File

@ -72,22 +72,22 @@
<seealso></seealso>
</element>
<element name="RGBtoHLS.R">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHLS.G">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHLS.B">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHLS.H">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHLS.L">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHLS.S">
<short>.</short>
<short></short>
</element>
<element name="HLStoColor">
@ -97,16 +97,16 @@
<seealso></seealso>
</element>
<element name="HLStoColor.Result">
<short>.</short>
<short></short>
</element>
<element name="HLStoColor.H">
<short>.</short>
<short></short>
</element>
<element name="HLStoColor.L">
<short>.</short>
<short></short>
</element>
<element name="HLStoColor.S">
<short>.</short>
<short></short>
</element>
<element name="HLStoRGB">
@ -116,22 +116,22 @@
<seealso></seealso>
</element>
<element name="HLStoRGB.H">
<short>.</short>
<short></short>
</element>
<element name="HLStoRGB.L">
<short>.</short>
<short></short>
</element>
<element name="HLStoRGB.S">
<short>.</short>
<short></short>
</element>
<element name="HLStoRGB.R">
<short>.</short>
<short></short>
</element>
<element name="HLStoRGB.G">
<short>.</short>
<short></short>
</element>
<element name="HLStoRGB.B">
<short>.</short>
<short></short>
</element>
<!-- HSV functions are copied from mbColorLib without changes -->
@ -141,16 +141,16 @@
<seealso></seealso>
</element>
<element name="ColorToHSV.c">
<short>.</short>
<short></short>
</element>
<element name="ColorToHSV.H">
<short>.</short>
<short></short>
</element>
<element name="ColorToHSV.S">
<short>.</short>
<short></short>
</element>
<element name="ColorToHSV.V">
<short>.</short>
<short></short>
</element>
<element name="HSVToColor">
@ -159,16 +159,16 @@
<seealso></seealso>
</element>
<element name="HSVToColor.Result">
<short>.</short>
<short></short>
</element>
<element name="HSVToColor.H">
<short>.</short>
<short></short>
</element>
<element name="HSVToColor.S">
<short>.</short>
<short></short>
</element>
<element name="HSVToColor.V">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV">
@ -177,25 +177,25 @@
<seealso></seealso>
</element>
<element name="RGBToHSV.Result">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV.R">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV.G">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV.B">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV.H">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV.S">
<short>.</short>
<short></short>
</element>
<element name="RGBToHSV.V">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGB">
@ -204,91 +204,91 @@
<seealso></seealso>
</element>
<element name="HSVtoRGB.H">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGB.S">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGB.V">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGB.R">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGB.G">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGB.B">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="RGBtoHSVRange.R">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange.G">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange.B">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange.H">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange.S">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange.V">
<short>.</short>
<short></short>
</element>
<element name="RGBtoHSVRange.">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBRange">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBRange.H">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBRange.S">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBRange.V">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBRange.R">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBRange.G">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBRange.B">
<short>.</short>
<short></short>
</element>
<element name="HSVRangeToColor">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVRangeToColor.Result">
<short>.</short>
<short></short>
</element>
<element name="HSVRangeToColor.H">
<short>.</short>
<short></short>
</element>
<element name="HSVRangeToColor.S">
<short>.</short>
<short></short>
</element>
<element name="HSVRangeToColor.V">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBTriple">
@ -299,16 +299,16 @@
<seealso></seealso>
</element>
<element name="HSVtoRGBTriple.Result">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBTriple.H">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBTriple.S">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBTriple.V">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBQuad">
@ -319,16 +319,16 @@
<seealso></seealso>
</element>
<element name="HSVtoRGBQuad.Result">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBQuad.H">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBQuad.S">
<short>.</short>
<short></short>
</element>
<element name="HSVtoRGBQuad.V">
<short>.</short>
<short></short>
</element>
<element name="GetHValue">
@ -337,10 +337,10 @@
<seealso></seealso>
</element>
<element name="GetHValue.Result">
<short>.</short>
<short></short>
</element>
<element name="GetHValue.Color">
<short>.</short>
<short></short>
</element>
<element name="GetSValue">
@ -427,16 +427,16 @@
<seealso></seealso>
</element>
<element name="TScrollDirection.sdLeft">
<short>.</short>
<short></short>
</element>
<element name="TScrollDirection.sdRight">
<short>.</short>
<short></short>
</element>
<element name="TScrollDirection.sdUp">
<short>.</short>
<short></short>
</element>
<element name="TScrollDirection.sdDown">
<short>.</short>
<short></short>
</element>
<element name="TArrowType">
@ -452,7 +452,7 @@
</element>
<element name="NiceArrowAngle">
<short>.</short>
<short></short>
<descr>
45*pi/180
</descr>
@ -478,22 +478,22 @@
<short>Point that indicates the canvas coordinates where the arrow is drawn.</short>
</element>
<element name="DrawArrow.Size">
<short>.</short>
<short></short>
</element>
<element name="DrawArrow.ArrowType">
<short>Drawing style for the arrow.</short>
</element>
<element name="DrawArrow.p1">
<short>.</short>
<short></short>
</element>
<element name="DrawArrow.p2">
<short>.</short>
<short></short>
</element>
<element name="DrawArrow.ArrowLen">
<short>.</short>
<short></short>
</element>
<element name="DrawArrow.ArrowAngleRad">
<short>.</short>
<short></short>
</element>
<element name="FloodFill">
@ -509,19 +509,19 @@
<seealso></seealso>
</element>
<element name="FloodFill.Canvas">
<short>.</short>
<short></short>
</element>
<element name="FloodFill.X">
<short>.</short>
<short></short>
</element>
<element name="FloodFill.Y">
<short>.</short>
<short></short>
</element>
<element name="FloodFill.lColor">
<short>.</short>
<short></short>
</element>
<element name="FloodFill.FillStyle">
<short>.</short>
<short></short>
</element>
<element name="ScaleImg">
@ -555,85 +555,85 @@
<seealso></seealso>
</element>
<element name="ColorRGBToHLS.clrRGB">
<short>.</short>
<short></short>
</element>
<element name="ColorRGBToHLS.Hue">
<short>.</short>
<short></short>
</element>
<element name="ColorRGBToHLS.Luminance">
<short>.</short>
<short></short>
</element>
<element name="ColorRGBToHLS.Saturation">
<short>.</short>
<short></short>
</element>
<element name="ColorHLSToRGB">
<short>.</short>
<short></short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="ColorHLSToRGB.Result">
<short>.</short>
<short></short>
</element>
<element name="ColorHLSToRGB.Hue">
<short>.</short>
<short></short>
</element>
<element name="ColorHLSToRGB.Luminance">
<short>.</short>
<short></short>
</element>
<element name="ColorHLSToRGB.Saturation">
<short>.</short>
<short></short>
</element>
<element name="ColorAdjustLuma">
<short>.</short>
<short></short>
<descr></descr>
<seealso></seealso>
</element>
<element name="ColorAdjustLuma.Result">
<short>.</short>
<short></short>
</element>
<element name="ColorAdjustLuma.clrRGB">
<short>.</short>
<short></short>
</element>
<element name="ColorAdjustLuma.n">
<short>.</short>
<short></short>
</element>
<element name="ColorAdjustLuma.fScale">
<short>.</short>
<short></short>
</element>
<element name="GetHighLightColor">
<short>.</short>
<short></short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="GetHighLightColor.Result">
<short>.</short>
<short></short>
</element>
<element name="GetHighLightColor.Color">
<short>.</short>
<short></short>
</element>
<element name="GetHighLightColor.Luminance">
<short>.</short>
<short></short>
</element>
<element name="GetShadowColor">
<short>.</short>
<short></short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="GetShadowColor.Result">
<short>.</short>
<short></short>
</element>
<element name="GetShadowColor.Color">
<short>.</short>
<short></short>
</element>
<element name="GetShadowColor.Luminance">
<short>.</short>
<short></short>
</element>
<element name="NormalizeRect">

2
docs/xml/lcl/grids.xml
View File

@ -13909,7 +13909,7 @@
</element>
<element name="TCustomStringGrid.MapGetColsRows">
<short>.</short>
<short></short>
<descr/>
<seealso/>
<notes><note>?</note></notes>

484
docs/xml/lcl/groupededit.xml
View File

File diff suppressed because it is too large Load Diff

54
docs/xml/lcl/helpintfs.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="HelpIntfs">
<short>Interfaces to define the abstract HelpSystem</short>
<short>Interfaces to define the abstract HelpSystem.</short>
<descr>
<p>
<file>helpintfs.pas</file> contains interfaces to define the abstract HelpSystem.
@ -29,7 +29,7 @@
<element name="LCLProc"/>
<element name="EHelpSystemException">
<short>Exception raised for Help system errors</short>
<short>Exception raised for Help system errors.</short>
<descr>
<p>
All help-specific errors should use this Exception type.
@ -39,7 +39,7 @@
</element>
<element name="TShowHelpResult">
<short>Represents result codes returned by THelpManager</short>
<short>Represents result codes returned by THelpManager.</short>
<descr>
<p>
<var>TShowHelpResult</var> is an enumerated type with values that represent result codes for help requests using <var>THelpManager</var>. It is also the type returned from convenience methods like <var>ShowTableOfContents</var>, <var>ShowHelpForKeyword</var>, <var>ShowHelpForPascalContexts</var>, et. al.
@ -50,41 +50,41 @@
</seealso>
</element>
<element name="TShowHelpResult.shrNone">
<short>No help result available (help error)</short>
<short>No help result available (help error).</short>
</element>
<element name="TShowHelpResult.shrSuccess">
<short>Help request successfully completed</short>
<short>Help request successfully completed.</short>
</element>
<element name="TShowHelpResult.shrCancel">
<short>Help request was canceled</short>
<short>Help request was canceled.</short>
</element>
<element name="TShowHelpResult.shrDatabaseNotFound">
<short>Help database was not found</short>
<short>Help database was not found.</short>
</element>
<element name="TShowHelpResult.shrContextNotFound">
<short>Help database found, but the context was not found</short>
<short>Help database found, but the context was not found.</short>
</element>
<element name="TShowHelpResult.shrViewerNotFound">
<short>No Help viewer registered for this format</short>
<short>No Help viewer registered for this format.</short>
</element>
<element name="TShowHelpResult.shrHelpNotFound">
<short>No Help found for the keyword or directive</short>
<short>No Help found for the keyword or directive.</short>
</element>
<element name="TShowHelpResult.shrViewerError">
<short>Help viewer could not display a help node</short>
<short>Help viewer could not display a help node.</short>
</element>
<element name="TShowHelpResult.shrSelectorError">
<short>No help node(s) found for the help selector</short>
<short>No help node(s) found for the help selector.</short>
</element>
<element name="TShowHelpResults">
<short>Set type used to store values from the TShowHelpResult enumeration</short>
<short>Set type used to store values from the TShowHelpResult enumeration.</short>
<descr/>
<seealso/>
</element>
<element name="THelpDatabaseID">
<short>Identifier used to represent a Help database</short>
<short>Identifier used to represent a Help database.</short>
<descr>
<p>
<var>THelpDatabaseID</var> is an alias for the <var>String</var> type.
@ -108,7 +108,7 @@
<element name="THelpQuery.FHelpDatabaseID"/>
<element name="THelpQuery.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -140,7 +140,7 @@
<element name="THelpQueryContext.FContext"/>
<element name="THelpQueryContext.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -168,7 +168,7 @@
<element name="THelpQueryKeyword.FKeyword"/>
<element name="THelpQueryKeyword.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -197,7 +197,7 @@
<element name="THelpQuerySourcePosition.FSourcePosition"/>
<element name="THelpQuerySourcePosition.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -234,7 +234,7 @@
<element name="THelpQueryPascalContexts.FContextLists"/>
<element name="THelpQueryPascalContexts.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -308,7 +308,7 @@
<element name="THelpQueryMessage.FWholeMessage"/>
<element name="THelpQueryMessage.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -324,7 +324,7 @@
</element>
<element name="THelpQueryMessage.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -352,7 +352,7 @@
<element name="THelpQueryClass.FTheClass"/>
<element name="THelpQueryClass.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<errors/>
<seealso/>
@ -372,7 +372,7 @@
<element name="THelpManager">
<short>
Defines a help manager used to display a help query or a table of contents
Defines a help manager used to display a help query or a table of contents.
</short>
<descr>
<p>
@ -596,7 +596,7 @@
</element>
<element name="ShowTableOfContents">
<short>Display the Help table of contents</short>
<short>Display the Help table of contents.</short>
<descr/>
<errors/>
<seealso/>
@ -752,7 +752,7 @@
</element>
<element name="ShowHelpFile">
<short>Displays a Help file wih the given file name and MIME type</short>
<short>Displays a Help file wih the given file name and MIME type.</short>
<descr/>
<errors/>
<seealso/>
@ -793,7 +793,7 @@
</element>
<element name="ShowHelp">
<short>Display a Help file wih the give URL and MIME type</short>
<short>Display a Help file wih the give URL and MIME type.</short>
<descr/>
<errors/>
<seealso/>
@ -834,7 +834,7 @@
</element>
<topic name="HelpDisplay-HowItWorks">
<short>Displaying Help (How It Works)</short>
<short>Displaying Help (How It Works).</short>
<descr>
<ul>
<li>

2
docs/xml/lcl/icnstypes.xml
View File

@ -9,7 +9,7 @@
-->
<module name="IcnsTypes">
<short>Provides support for Mac OS X icon resources</short>
<short>Provides support for Mac OS X icon resources.</short>
<descr>
<p>
<file>icnstypes.pas</file> contains types, constants and functions needed to read Mac OS X icon resource files (or icns). Most defines present here were taken from the univint package in FPC.

82
docs/xml/lcl/imagelistcache.xml
View File

@ -10,7 +10,7 @@
<module name="ImageListCache">
<short>
Implements a caching mechanism for TCustomImageList (TImageList) instances
Implements a caching mechanism for TCustomImageList (TImageList) instances.
</short>
<descr>
<p>
@ -34,7 +34,7 @@ This file is part of the Lazarus Component Library (<b>LCL</b>).
<!-- object Visibility: default -->
<element name="IImageCacheListener">
<short>
Interface that cache user should have to listen for cache changes
Interface that cache user should have to listen for cache changes.
</short>
<descr/>
<seealso>
@ -47,36 +47,36 @@ Interface that cache user should have to listen for cache changes
<!-- procedure Visibility: default -->
<element name="IImageCacheListener.CacheSetImageList">
<short>Sets the image list for the cache listener</short>
<short>Sets the image list for the cache listener.</short>
<descr/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="IImageCacheListener.CacheSetImageList.AImageList">
<short>TCustomImageList instance for the listener</short>
<short>TCustomImageList instance for the listener.</short>
</element>
<!-- procedure Visibility: default -->
<element name="IImageCacheListener.CacheSetImageIndex">
<short>Sets the new image index for an image in the list</short>
<short>Sets the new image index for an image in the list.</short>
<descr/>
<seealso/>
</element>
<!-- argument Visibility: default -->
<element name="IImageCacheListener.CacheSetImageIndex.AIndex">
<short>Old image index in the listener</short>
<short>Old image index in the listener.</short>
</element>
<!-- argument Visibility: default -->
<element name="IImageCacheListener.CacheSetImageIndex.AImageIndex">
<short>New image index in the listener</short>
<short>New image index in the listener.</short>
</element>
<!-- record type Visibility: default -->
<element name="TImageCacheItem">
<short>Represents an item in the cache</short>
<short>Represents an item in the cache.</short>
<descr/>
<seealso>
<link id="TImageCacheItems"/>
@ -86,27 +86,27 @@ Interface that cache user should have to listen for cache changes
<!-- variable Visibility: default -->
<element name="TImageCacheItem.FImageList">
<short>Reference to the image list</short>
<short>Reference to the image list.</short>
</element>
<!-- variable Visibility: default -->
<element name="TImageCacheItem.FListener">
<short>Reference to the listener interface</short>
<short>Reference to the listener interface.</short>
</element>
<!-- variable Visibility: default -->
<element name="TImageCacheItem.FImageIndexes">
<short>Indices in the image list that the listener has reserved</short>
<short>Indices in the image list that the listener has reserved.</short>
</element>
<!-- pointer type Visibility: default -->
<element name="PImageCacheItem">
<short>Pointer to a TImageCacheItem type</short>
<short>Pointer to a TImageCacheItem type.</short>
</element>
<!-- object Visibility: default -->
<element name="TImageCacheItems">
<short>Implements a container for cached image lists</short>
<short>Implements a container for cached image lists.</short>
<descr>
<p>
<var>TImageCacheItems</var> is a <var>TList</var> descendant which implements
@ -136,7 +136,7 @@ TImageCacheItems is used in the implementation of the
<element name="TImageCacheItems.SetItem.AValue"/>
<element name="TImageCacheItems.Notify">
<short>Notifies observers when a value in the container has been changed</short>
<short>Notifies observers when a value in the container has been changed.</short>
<descr/>
<seealso>
<link id="#rtl.classes.TList"/>
@ -145,17 +145,17 @@ TImageCacheItems is used in the implementation of the
<!-- argument Visibility: default -->
<element name="TImageCacheItems.Notify.Ptr">
<short>Untyped Pointer to the value for the change notification</short>
<short>Untyped Pointer to the value for the change notification.</short>
</element>
<!-- argument Visibility: default -->
<element name="TImageCacheItems.Notify.Action">
<short>Action for the notification (Add, Extract, Delete)</short>
<short>Action for the notification (Add, Extract, Delete).</short>
</element>
<!-- function Visibility: public -->
<element name="TImageCacheItems.GetNew">
<short>Allocates and stores a new image list reference in the container</short>
<short>Allocates and stores a new image list reference in the container.</short>
<descr>
<p>
<var>GetNew</var> is a <var>PImageCacheItem</var> function used to allocate and
@ -172,13 +172,13 @@ the container.
<!-- function result Visibility: default -->
<element name="TImageCacheItems.GetNew.Result">
<short>Reference for an image list stored in the container</short>
<short>Reference for an image list stored in the container.</short>
</element>
<!-- property Visibility: public -->
<element name="TImageCacheItems.Items">
<short>
Provides indexed access to image list references in the container
Provides indexed access to image list references in the container.
</short>
<descr>
<p>
@ -198,12 +198,12 @@ Items is the default property for the container.
<!-- argument Visibility: default -->
<element name="TImageCacheItems.Items.AIndex">
<short>Ordinal position in the container for the requested image list</short>
<short>Ordinal position in the container for the requested image list.</short>
</element>
<!-- object Visibility: default -->
<element name="TImageListCache">
<short>Implements a caching mechanism for image lists</short>
<short>Implements a caching mechanism for image lists.</short>
<descr>
<p>
<var>TImageListCache</var> is a class which implements a caching mechanism for
@ -230,37 +230,37 @@ initiate actions affecting the cache storage.
<element name="TImageListCache.CheckRebuildNeed">
<short>
Determines if the cache storage needs to be rebuilt when the change
threshold is exceeded
threshold is exceeded.
</short>
</element>
<element name="TImageListCache.GetImageListFor">
<short>
Gets a TCustomImageList instance with the specified image size
Gets a TCustomImageList instance with the specified image size.
</short>
</element>
<element name="TImageListCache.GetImageListFor.Result">
<short/>
</element>
<element name="TImageListCache.GetImageListFor.AWidth">
<short>Width for the images in the image list</short>
<short>Width for the images in the image list.</short>
</element>
<element name="TImageListCache.GetImageListFor.AHeight">
<short>Height for the images in the image list</short>
<short>Height for the images in the image list.</short>
</element>
<element name="TImageListCache.UnregisterBitmaps">
<short>
Marks an image list and its images as unused for the specified cache listener
Marks an image list and its images as unused for the specified cache listener.
</short>
</element>
<element name="TImageListCache.UnregisterBitmaps.AListener">
<short>Cache listener removed in the method</short>
<short>Cache listener removed in the method.</short>
</element>
<!-- constructor Visibility: public -->
<element name="TImageListCache.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
Allocates resources needed for internal members in the class instance.
@ -271,7 +271,7 @@ Allocates resources needed for internal members in the class instance.
<!-- destructor Visibility: public -->
<element name="TImageListCache.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
Frees resources allocated to internal members in the class instance,
@ -284,7 +284,7 @@ including any stored images requested by cache listeners.
<!-- function Visibility: public -->
<element name="TImageListCache.RegisterListener">
<short>
Adds a listener for an image list stored in the cache
Adds a listener for an image list stored in the cache.
</short>
<descr>
<p>
@ -305,21 +305,21 @@ RegisterListener is called from the <var>RegisterBitmap</var> method.
<!-- function result Visibility: default -->
<element name="TImageListCache.RegisterListener.Result">
<short>
Position where the specified listener was stored in the internal list
Position where the specified listener was stored in the internal list.
</short>
</element>
<!-- argument Visibility: default -->
<element name="TImageListCache.RegisterListener.AListener">
<short>
Listener interface added to the internal list
Listener interface added to the internal list.
</short>
</element>
<!-- procedure Visibility: public -->
<element name="TImageListCache.UnregisterListener">
<short>
Removes the specified cache listener from the internal list
Removes the specified cache listener from the internal list.
</short>
<descr>
<p>
@ -341,13 +341,13 @@ singleton used for the image list cache is set to <b>Nil</b>.
<!-- argument Visibility: default -->
<element name="TImageListCache.UnregisterListener.AListener">
<short>Cache listener removed from the list</short>
<short>Cache listener removed from the list.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TImageListCache.RegisterBitmap">
<short>
Adds the specified bitmap to the image list for a cache listener
Adds the specified bitmap to the image list for a cache listener.
</short>
<descr>
<p>
@ -377,22 +377,22 @@ the index positions used in the image list.
<!-- argument Visibility: default -->
<element name="TImageListCache.RegisterBitmap.AListener">
<short>Interface for the cache listener for the bitmap</short>
<short>Interface for the cache listener for the bitmap.</short>
</element>
<!-- argument Visibility: default -->
<element name="TImageListCache.RegisterBitmap.ABitmap">
<short>Bitmap registered in the method</short>
<short>Bitmap registered in the method.</short>
</element>
<!-- argument Visibility: default -->
<element name="TImageListCache.RegisterBitmap.ABitmapCount">
<short>Number of image "slices" in the bitmap</short>
<short>Number of image "slices" in the bitmap.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TImageListCache.Rebuild">
<short>Rebuilds the cache storage</short>
<short>Rebuilds the cache storage.</short>
<descr>
<p>
Removes unused image lists in the cache where the cache listener is no
@ -407,7 +407,7 @@ indexes.
<!-- function Visibility: default -->
<element name="GetImageListCache">
<short>
Provides access to the TImageListCache singleton in the implementation
Provides access to the TImageListCache singleton in the implementation.
</short>
<descr/>
<seealso/>
@ -415,7 +415,7 @@ Provides access to the TImageListCache singleton in the implementation
<!-- function result Visibility: default -->
<element name="GetImageListCache.Result">
<short>TImageListCache instance for the implementation</short>
<short>TImageListCache instance for the implementation.</short>
</element>
</module>

1038
docs/xml/lcl/imglist.xml
View File

File diff suppressed because it is too large Load Diff

2
docs/xml/lcl/industrialbase.xml
View File

@ -9,7 +9,7 @@
-->
<module name="IndustrialBase">
<short>Contains the base class for graphic controls that support anti-aliasing</short>
<short>Contains the base class for graphic controls that support anti-aliasing.</short>
<descr>
<p>
<file>industrialbase.pp</file> contains the base class for graphic controls that support anti-aliasing.

8
docs/xml/lcl/inipropstorage.xml
View File

@ -52,7 +52,7 @@
<!-- "class of" type Visibility: default -->
<element name="TIniFileClass">
<short>Class of <link id="#fcl.IniFiles.TCustomIniFile">TCustomIniFile</link></short>
<short>Class of <link id="#fcl.IniFiles.TCustomIniFile">TCustomIniFile</link>.</short>
<descr />
<seealso />
</element> <!-- "class of" TIniFileClass -->
@ -102,7 +102,7 @@
<!-- function Visibility: protected -->
<element name="TCustomIniPropStorage.IniFileClass">
<short>Returns the class <link id="#fcl.IniFiles.TIniFile">TIniFile</link></short>
<short>Returns the class <link id="#fcl.IniFiles.TIniFile">TIniFile</link>.</short>
<descr />
<errors />
<seealso />
@ -110,7 +110,7 @@
<!-- function result Visibility: default -->
<element name="TCustomIniPropStorage.IniFileClass.Result">
<short>The class <link id="#fcl.IniFiles.TIniFile">TIniFile</link></short>
<short>The class <link id="#fcl.IniFiles.TIniFile">TIniFile</link>.</short>
</element> <!-- function result TCustomIniPropStorage.IniFileClass.Result -->
<!-- function Visibility: protected -->
@ -148,7 +148,7 @@
<!-- procedure Visibility: public -->
<element name="TCustomIniPropStorage.StorageNeeded">
<short>Ask the underlying storage object for an entry</short>
<short>Ask the underlying storage object for an entry.</short>
<descr />
<errors />
<seealso />

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

File diff suppressed because it is too large Load Diff

123
docs/xml/lcl/intfgraphics.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="IntfGraphics">
<short>Classes and functions for easy handling of raw images (interface images)</short>
<short>Classes and functions for easy handling of raw images (interface images).</short>
<descr>
<p>
Author: Mattias Gaertner
@ -1529,7 +1529,7 @@
</element>
<element name="TLazIntfImage.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -1550,7 +1550,7 @@
</element>
<element name="TLazIntfImage.CreateCompatible">
<short>Alternate constructor for the class instance</short>
<short>Alternate constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -1565,13 +1565,13 @@
</element>
<element name="TLazIntfImage.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImage.Assign">
<short>Stores values from the specified persistent object into the current class instance</short>
<short>Stores values from the specified persistent object into the current class instance.</short>
<descr/>
<seealso/>
</element>
@ -1580,20 +1580,20 @@
</element>
<element name="TLazIntfImage.BeginUpdate">
<short>Increments the internal update counter</short>
<short>Increments the internal update counter.</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImage.EndUpdate">
<short>Decrements the internal update counter</short>
<short>Decrements the internal update counter.</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImage.SetSize">
<short>
<var>SetSize</var> - define the height and width of the image</short>
<var>SetSize</var> - define the height and width of the image.</short>
<descr/>
<seealso/>
</element>
@ -1606,7 +1606,7 @@
<element name="TLazIntfImage.CheckDescription">
<short>
<var>CheckDescription</var> - looks at the supplied Image Description record and returns True if it matches the actual properties of the image</short>
<var>CheckDescription</var> - looks at the supplied Image Description record and returns True if it matches the actual properties of the image.</short>
<descr/>
<errors>Generates an exception if an error is encountered in the image description</errors>
<seealso/>
@ -1623,7 +1623,7 @@
<element name="TLazIntfImage.LoadFromDevice">
<short>
<var>LoadFromDevice</var> - loads the image from the device with specified handle</short>
<var>LoadFromDevice</var> - loads the image from the device with specified handle.</short>
<descr/>
<seealso/>
</element>
@ -1633,7 +1633,7 @@
<element name="TLazIntfImage.LoadFromBitmap">
<short>
<var>LoadFromBitmap</var> - loads the image from a Bitmap</short>
<var>LoadFromBitmap</var> - loads the image from a Bitmap.</short>
<descr/>
<seealso/>
</element>
@ -1648,7 +1648,7 @@
</element>
<element name="TLazIntfImage.CreateBitmaps">
<short><var>CreateBitmaps</var> - generates a Bitmap and an optional Mask for the image data</short>
<short><var>CreateBitmaps</var> - generates a Bitmap and an optional Mask for the image data.</short>
<descr/>
<seealso/>
</element>
@ -1663,7 +1663,7 @@
</element>
<element name="TLazIntfImage.SetRawImage">
<short>Stores the raw image data in the class instance</short>
<short>Stores the raw image data in the class instance.</short>
<descr/>
<seealso/>
</element>
@ -1675,7 +1675,7 @@
</element>
<element name="TLazIntfImage.GetRawImage">
<short>Gets the raw image data stored in the class instance and optionally release ownership</short>
<short>Gets the raw image data stored in the class instance and optionally release ownership.</short>
<descr/>
<seealso/>
</element>
@ -1687,7 +1687,7 @@
</element>
<element name="TLazIntfImage.FillPixels">
<short>Sets the color for all pixels in the raw image data to the specified value</short>
<short>Sets the color for all pixels in the raw image data to the specified value.</short>
<descr/>
<seealso/>
</element>
@ -1717,7 +1717,7 @@
</element>
<element name="TLazIntfImage.AlphaBlend">
<short>Merges a source image with alpha blending</short>
<short>Merges a source image with alpha blending.</short>
<descr>
<p>
Merges an image to a canvas using alpha blending according to a separate image containing the alpha channel. White pixels in the alpha channel will correspond to the source image pixel being fully drawn, grey ones are merged and black ones ignored.
@ -1742,7 +1742,7 @@
</element>
<element name="TLazIntfImage.AlphaFromMask">
<short>Gets the alpha value from the mask if needed</short>
<short>Gets the alpha value from the mask if needed.</short>
<descr>
<p>
<var>AlphaFromMask</var> gets the alpha value from the mask if <var>AKeepAlpha</var> is True (default condition).
@ -1766,7 +1766,7 @@
<element name="TLazIntfImage.GetXYDataPostion">
<short>
<var>GetXYDataPostion</var> - finds the position of the raw image</short>
<var>GetXYDataPostion</var> - finds the position of the raw image.</short>
<descr>Yes, it really is spelled 'Postion'</descr>
<seealso/>
</element>
@ -1781,7 +1781,7 @@
</element>
<element name="TLazIntfImage.GetXYMaskPostion">
<short>
<var>GetXYMaskPostion</var> - finds the position of the raw image mask</short>
<var>GetXYMaskPostion</var> - finds the position of the raw image mask.</short>
<descr/>
<seealso/>
</element>
@ -1796,7 +1796,7 @@
</element>
<element name="TLazIntfImage.GetDataLineStart">
<short>Returns an pointer to the raw data for a scan line</short>
<short>Returns an pointer to the raw data for a scan line.</short>
<descr>
<p>
Similar to Delphi's TBitmap.ScanLine. Works with scan lines aligned to whole bytes.
@ -1846,21 +1846,21 @@
<element name="TLazIntfImage.PixelData">
<short>
<var>PixelData</var> - the raw image data for the image</short>
<var>PixelData</var> - the raw image data for the image.</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImage.MaskData">
<short>
<var>MaskData</var> - the raw data for the mask in the image</short>
<var>MaskData</var> - the raw data for the mask in the image.</short>
<descr/>
<seealso/>
</element>
<element name="TLazIntfImage.DataDescription">
<short>
<var>DataDescription</var> - the raw description record for the current image</short>
<var>DataDescription</var> - the raw description record for the current image.</short>
<descr/>
<seealso/>
</element>
@ -1879,7 +1879,7 @@
<element name="TLazIntfImage.TColors">
<short>
<var>TColors</var> - the colors available for the specified pixel</short>
<var>TColors</var> - the colors available for the specified pixel.</short>
<descr/>
<seealso/>
</element>
@ -1891,7 +1891,7 @@
</element>
<element name="TLazIntfImage.Masked">
<short><var>Masked</var> - whether the image mask applies at the specified position</short>
<short><var>Masked</var> - whether the image mask applies at the specified position.</short>
<descr/>
<seealso/>
</element>
@ -1904,7 +1904,7 @@
<element name="TLazIntfImageMask">
<short>
<var>TLazIntfImageMask</var> - applying a mask at the Raw Image level</short>
<var>TLazIntfImageMask</var> - applying a mask at the Raw Image level.</short>
<descr/>
<seealso/>
</element>
@ -1977,12 +1977,12 @@
</element>
<element name="TLazIntfImageMask.Image">
<short>
<var>Image</var> - the image to which masking is applied</short>
<var>Image</var> - the image to which masking is applied.</short>
<descr/>
<seealso/>
</element>
<element name="TLazAVLPalette">
<short>Descendant of <var>TFPPalette </var> which uses an AVL tree for speed up</short>
<short>Descendant of <var>TFPPalette </var> which uses an AVL tree for speed up.</short>
<descr/>
<seealso/>
</element>
@ -2043,7 +2043,7 @@
<seealso/>
</element>
<element name="TLazAVLPalette.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -2116,12 +2116,12 @@
<seealso/>
</element>
<element name="TArrayNode.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TArrayNode.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -2315,12 +2315,12 @@
<seealso/>
</element>
<element name="TArrayNodesTree.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TArrayNodesTree.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -2331,8 +2331,7 @@
</element>
<element name="ILazImageReader">
<short>
</short>
<short></short>
<descr>
<p>
<var>ILazImageReader</var> is an interface used to extend <var>TFPCustomImageReader</var> to initialize a <var>TRawImgeDescription</var> based on the image to be read.
@ -2357,7 +2356,7 @@
</element>
<element name="TLazReaderXPM">
<short><var>TLazReaderXPM</var> - this is a FPImage reader for xpm images</short>
<short><var>TLazReaderXPM</var> - this is a FPImage reader for xpm images.</short>
<descr/>
<seealso/>
</element>
@ -2454,13 +2453,13 @@
</element>
<element name="TLazReaderXPM.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TLazReaderXPM.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -2472,7 +2471,7 @@
</element>
<element name="TLazWriterXPM">
<short><var>TLazWriterXPM</var> is a <var>FPImage</var> writer for xpm images</short>
<short><var>TLazWriterXPM</var> is a <var>FPImage</var> writer for xpm images.</short>
<descr/>
<seealso/>
</element>
@ -2503,7 +2502,7 @@
</element>
<element name="TLazWriterXPM.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -2520,10 +2519,10 @@
<seealso/>
</element>
<element name="TLazReaderMaskMode.lrmmNone">
<short>No mask is generated</short>
<short>No mask is generated.</short>
</element>
<element name="TLazReaderMaskMode.lrmmAuto">
<short>A mask is generated based on the first pixel read</short>
<short>A mask is generated based on the first pixel read.</short>
<descr>
<p>
Note: when reading images with an alpha channel and the alpha channel has no influence on the mask (the maskcolor is transparent).
@ -2531,7 +2530,7 @@
</descr>
</element>
<element name="TLazReaderMaskMode.lrmmColor">
<short>A mask is generated based on the given color</short>
<short>A mask is generated based on the given color.</short>
<descr>
<p>
Note: when reading images with an alpha channel and the alpha channel has no influence on the mask (the maskcolor is transparent).
@ -2554,15 +2553,15 @@
<short/>
</element>
<element name="TLazReaderDIBEncoding.lrdeJpeg">
<short>For completeness - don't know if they exist</short>
<short>For completeness - don't know if they exist.</short>
<descr/>
<seealso/>
</element>
<element name="TLazReaderDIBEncoding.lrdePng">
<short>For completeness - don't know if they exist</short>
<short>For completeness - don't know if they exist.</short>
</element>
<element name="TLazReaderDIBEncoding.lrdeHuffman">
<short>For completeness - don't know if they exist</short>
<short>For completeness - don't know if they exist.</short>
</element>
<element name="TLazReaderDIBInfo">
@ -2643,31 +2642,31 @@
<element name="TLazReaderDIB.FImage"/>
<element name="TLazReaderDIB.FMaskMode"/>
<element name="TLazReaderDIB.FMaskColor">
<short>Color which should be interpreted as masked</short>
<short>Color which should be interpreted as masked.</short>
</element>
<element name="TLazReaderDIB.FMaskIndex">
<short>For palette based images, index of the color which should be interpreted as masked</short>
<short>For palette based images, index of the color which should be interpreted as masked.</short>
</element>
<element name="TLazReaderDIB.FReadSize">
<short>Size (in bytes) for a scanline</short>
<short>Size (in bytes) for a scanline.</short>
</element>
<element name="TLazReaderDIB.FDIBInfo">
<short>Information about the bitmap as read from the stream</short>
<short>Information about the bitmap as read from the stream.</short>
</element>
<element name="TLazReaderDIB.FPalette">
<short>Buffer with Palette entries</short>
<short>Buffer with Palette entries.</short>
</element>
<element name="TLazReaderDIB.FLineBuf">
<short>Buffer for ascanline. Can be Byte, Word, TColorRGB or TColorRGBA.</short>
</element>
<element name="TLazReaderDIB.FUpdateDescription">
<short>If set, rawimagedescription is updated</short>
<short>If set, rawimagedescription is updated.</short>
</element>
<element name="TLazReaderDIB.FContinue">
<short>For progress support</short>
<short>For progress support.</short>
</element>
<element name="TLazReaderDIB.FIgnoreAlpha">
<short>If alpha channel is declared but does not exist (all values = 0)</short>
<short>If alpha channel is declared but does not exist (all values = 0).</short>
</element>
<element name="TLazReaderDIB.BitfieldsToFPColor">
@ -2833,13 +2832,13 @@
</element>
<element name="TLazReaderDIB.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TLazReaderDIB.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
@ -2864,7 +2863,7 @@
<element name="TLazReaderBMP">
<short>
<var>TLazReaderBMP </var>- This is an improved <var>FPImage</var> reader for bmp images</short>
<var>TLazReaderBMP </var>- This is an improved <var>FPImage</var> reader for bmp images.</short>
<descr/>
<seealso/>
</element>
@ -2950,7 +2949,7 @@
</element>
<element name="TLazReaderIconDIB">
<short>Implements an image readr for a single DIB in an icon file</short>
<short>Implements an image readr for a single DIB in an icon file.</short>
<descr>
<p>
<var>TLazReaderIconDIB</var> is a <var>FPImage</var> reader for a single DIB from an icon file.
@ -3142,7 +3141,7 @@
</element>
<element name="TLazReaderTiff">
<short>Extends the FCL TIFF image reader to support the ILazImageReader interface</short>
<short>Extends the FCL TIFF image reader to support the ILazImageReader interface.</short>
<descr/>
<seealso/>
</element>
@ -3246,7 +3245,7 @@
</element>
<element name="TLazWriterTiff">
<short>Extends the FCL TIFF image writer to support the ILazImageWriter interface</short>
<short>Extends the FCL TIFF image writer to support the ILazImageWriter interface.</short>
<descr/>
<seealso/>
</element>
@ -3453,7 +3452,7 @@
</element>
<element name="TLazReaderIcnsPart.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create initalizes members in the class instance, and sets the default value for <var>IconType</var> to <var>iitNone</var>.
@ -3463,7 +3462,7 @@
</element>
<element name="TLazReaderIcnsPart.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy frees resources allocated for members, and calls the inherited destructor prior to exit.

4
docs/xml/lcl/jsonpropstorage.xml
View File

@ -147,7 +147,7 @@
<!-- argument Visibility: default -->
<element name="TCustomJSONPropStorage.SetFormatted.Value">
<short>A <var>Boolean</var> value to set the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">TCustomJSONPropStorage.Formatted</link></short>
<short>A <var>Boolean</var> value to set the property <link id="#LCL.JsonPropStorage.TCustomJSONPropStorage.Formatted">TCustomJSONPropStorage.Formatted</link>.</short>
</element> <!-- argument TCustomJSONPropStorage.SetFormatted.Value -->
<!-- function Visibility: protected -->
@ -178,7 +178,7 @@
<!-- procedure Visibility: public -->
<element name="TCustomJSONPropStorage.StorageNeeded">
<short>Ask the underlying storage object for an entry</short>
<short>Ask the underlying storage object for an entry.</short>
<descr />
<errors />
<seealso />

158
docs/xml/lcl/lazcanvas.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="LazCanvas">
<short>Classes and functions for extending TFPImageCanvas</short>
<short>Classes and functions for extending TFPImageCanvas.</short>
<descr>
<p>
<file>lazcanvas.pas</file> contains classes and functions for extending TFPImageCanvas to support more stretching filters, and to support all features from the LCL TCanvas. TLazCanvas also fixes various small problems and incompatibilities between TFPImageCanvas versions, making the interface smoother and more consistent.
@ -37,7 +37,7 @@
<element name="LCLProc"/>
<element name="TLazCanvasImageFormat">
<short>Identifies image formats supported in TLazCanvas</short>
<short>Identifies image formats supported in TLazCanvas.</short>
<descr>
<p>
Used in the implementation of the <var>CanvasCopyRect</var> method in <var>TLazCanvas</var>, and in custom-drawn LCL controls to speed up image drawing in the LCL interface.
@ -48,33 +48,33 @@
</seealso>
</element>
<element name="TLazCanvasImageFormat.clfOther">
<short>Images use a format other than those in this enumeration</short>
<short>Images use a format other than those in this enumeration.</short>
</element>
<element name="TLazCanvasImageFormat.clfRGB16_R5G6B5">
<short>Images use 16-bit RGB colors</short>
<short>Images use 16-bit RGB colors.</short>
</element>
<element name="TLazCanvasImageFormat.clfRGB24">
<short>Images use 24-bit RGB colors</short>
<short>Images use 24-bit RGB colors.</short>
</element>
<element name="TLazCanvasImageFormat.clfRGB24UpsideDown">
<short>Images use 24-bit RGB colors with inverse values</short>
<short>Images use 24-bit RGB colors with inverse values.</short>
</element>
<element name="TLazCanvasImageFormat.clfBGR24">
<short>Images use 24-bit BGR colors</short>
<short>Images use 24-bit BGR colors.</short>
</element>
<element name="TLazCanvasImageFormat.clfBGRA32">
<short>Images use 32-bit BGR colors with an Aplha channel</short>
<short>Images use 32-bit BGR colors with an Aplha channel.</short>
</element>
<element name="TLazCanvasImageFormat.clfRGBA32">
<short>Images use 32-bit RGB colors with an Aplha channel</short>
<short>Images use 32-bit RGB colors with an Aplha channel.</short>
</element>
<element name="TLazCanvasImageFormat.clfARGB32">
<short>Images use 32-bit RGB colors with an Aplha channel in the low-order octet</short>
<short>Images use 32-bit RGB colors with an Aplha channel in the low-order octet.</short>
</element>
<!-- class Visibility: default -->
<element name="TFPSharpInterpolation">
<short>Implements a very sharp and square interpolation</short>
<short>Implements a very sharp and square interpolation.</short>
<descr>
<p>
TFPSharpInterpolation implements a very sharp and square interpolation for stretching, similar to StretchBlt from the Windows API.
@ -86,7 +86,7 @@
<!-- procedure Visibility: protected -->
<element name="TFPSharpInterpolation.Execute">
<short>
Paints an image on the Canvas using the specified coordinates and dimensions
Paints an image on the Canvas using the specified coordinates and dimensions.
</short>
<descr></descr>
<seealso></seealso>
@ -106,7 +106,7 @@
<!-- class Visibility: default -->
<element name="TLazCanvasState">
<short>Contains properties reflecting the state for a Lazarus canvas</short>
<short>Contains properties reflecting the state for a Lazarus canvas.</short>
<descr>
<p>
<var>TLazCanvasState</var> is a class with public members that reflect the state for a <var>TLazCanvas</var> instance. A destructor is provided to ensure that resources allocated to members variables are freed before the class instance is destroyed.
@ -128,28 +128,28 @@
<!-- variable Visibility: public -->
<element name="TLazCanvasState.Brush">
<short>Brush for the canvas</short>
<short>Brush for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- variable Visibility: public -->
<element name="TLazCanvasState.Pen">
<short>Pen for the canvas</short>
<short>Pen for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- variable Visibility: public -->
<element name="TLazCanvasState.Font">
<short>Font for the canvas</short>
<short>Font for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- variable Visibility: public -->
<element name="TLazCanvasState.BaseWindowOrg">
<short>Base window origin for the canvas</short>
<short>Base window origin for the canvas.</short>
<descr>
<p>
The values in <var>WindowOrg</var> are relative to the coordinates in <var>BaseWindowOrg</var>. BaseWindowOrg coordinates are relative to the canvas for the containing Form. It is useful when implementing the non-native windowed controls.
@ -160,7 +160,7 @@
<!-- variable Visibility: public -->
<element name="TLazCanvasState.WindowOrg">
<short>Window origin for the canvas</short>
<short>Window origin for the canvas.</short>
<descr>
<p>
Contains the absolute coordinates for the canvas with <var>BaseWindowOrg</var> summed up.
@ -171,21 +171,21 @@
<!-- variable Visibility: public -->
<element name="TLazCanvasState.Clipping">
<short>Indicates if Clipping is enabled for the canvas</short>
<short>Indicates if Clipping is enabled for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- variable Visibility: public -->
<element name="TLazCanvasState.ClipRegion">
<short>Defines the clipping region for the canvas</short>
<short>Defines the clipping region for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- destructor Visibility: public -->
<element name="TLazCanvasState.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that resources allocated for the <var>Brush</var> and <var>Pen</var> properties are freed before the class instance is destroyed. Destroy calls the inherited destructor prior to exiting from the method.
@ -200,7 +200,7 @@
<!-- class Visibility: default -->
<element name="TLazCanvas">
<short>
Implements a canvas which masks differences between FCL and LCL canvas classes
Implements a canvas which masks differences between FCL and LCL canvas classes.
</short>
<descr>
<p>
@ -225,7 +225,7 @@
<!-- variable Visibility: private -->
<element name="TLazCanvas.GraphicStateList">
<short>Stores saved canvas state information</short>
<short>Stores saved canvas state information.</short>
<descr>
<p>
Used to store and restore canvas states in the <var>SaveState</var> and <var>RestoreState</var> methods. Contains <var>TLazCanvasState</var> class instances.
@ -240,83 +240,83 @@
<!-- function Visibility: private -->
<element name="TLazCanvas.GetAssignedBrush">
<short>Gets the value for the AssignedBrush property</short>
<short>Gets the value for the AssignedBrush property.</short>
<descr></descr>
<seealso>
<link id="TLazCanvas.AssignedBrush"/>
</seealso>
</element>
<element name="TLazCanvas.GetAssignedBrush.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<!-- function Visibility: private -->
<element name="TLazCanvas.GetAssignedPen">
<short>Gets the value for the AssignedPen property</short>
<short>Gets the value for the AssignedPen property.</short>
<descr></descr>
<seealso>
<link id="TLazCanvas.AssignedPen"/>
</seealso>
</element>
<element name="TLazCanvas.GetAssignedPen.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<!-- function Visibility: private -->
<element name="TLazCanvas.GetAssignedFont">
<short>Gets the value for the AssignedFont property</short>
<short>Gets the value for the AssignedFont property.</short>
<descr></descr>
<seealso>
<link id="TLazCanvas.AssignedFont"/>
</seealso>
</element>
<element name="TLazCanvas.GetAssignedFont.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<!-- function Visibility: private -->
<element name="TLazCanvas.GetWindowOrg">
<short>Gets the value for the WindowOrg property</short>
<short>Gets the value for the WindowOrg property.</short>
<descr></descr>
<seealso>
<link id="TLazCanvas.WindowOrg"/>
</seealso>
</element>
<element name="TLazCanvas.GetWindowOrg.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TLazCanvas.SetWindowOrg">
<short>Sets the value for the WindowOrg property</short>
<short>Sets the value for the WindowOrg property.</short>
<descr></descr>
<seealso>
<link id="TLazCanvas.WindowOrg"/>
</seealso>
</element>
<element name="TLazCanvas.SetWindowOrg.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazCanvas.SetColor">
<short>Sets the color for the pixel at the specified coordinates</short>
<short>Sets the color for the pixel at the specified coordinates.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TLazCanvas.SetColor.x">
<short>Horizontal pixel coordinate</short>
<short>Horizontal pixel coordinate.</short>
</element>
<element name="TLazCanvas.SetColor.y">
<short>Vertical pixel coordinate</short>
<short>Vertical pixel coordinate.</short>
</element>
<element name="TLazCanvas.SetColor.AValue">
<short>Color for the pixel</short>
<short>Color for the pixel.</short>
</element>
<!-- function Visibility: protected -->
<element name="TLazCanvas.DoCreateDefaultFont">
<short>Creates the custom font used as the default for the canvas</short>
<short>Creates the custom font used as the default for the canvas.</short>
<descr>
<p>
<var>DoCreateDefaultFont</var> is an overridden <var>TFPCustomFont</var> function used to provide the default font for the canvas class instance. DoCreateDefaultFont implements the abstract virtual method defined in an ancestor class, and emulates the method defined in TCanvas.
@ -328,13 +328,13 @@
<seealso></seealso>
</element>
<element name="TLazCanvas.DoCreateDefaultFont.Result">
<short>TFPCustomFont instance created and initialized in the method</short>
<short>TFPCustomFont instance created and initialized in the method.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazCanvas.DoRectangle">
<short>
Adjusts the fcl-image coordinate system to be compatible with coordinates used in TCanvas
Adjusts the fcl-image coordinate system to be compatible with coordinates used in TCanvas.
</short>
<descr>
<p>
@ -349,12 +349,12 @@
</seealso>
</element>
<element name="TLazCanvas.DoRectangle.Bounds">
<short>TRect with the bounds for the rectangular area</short>
<short>TRect with the bounds for the rectangular area.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazCanvas.DoRectangleFill">
<short>Adjusts the FCL image rectangle to be LCL compatible</short>
<short>Adjusts the FCL image rectangle to be LCL compatible.</short>
<descr>
<p>
Adjusts the fcl-image coordinate system to be compatible with coordinates used in <var>TCanvas</var>.
@ -363,12 +363,12 @@
<seealso/>
</element>
<element name="TLazCanvas.DoRectangleFill.Bounds">
<short>Rectangle bounds adjusted in the method</short>
<short>Rectangle bounds adjusted in the method.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazCanvas.DoPolygonFill">
<short>Implements a polygon fill algorithm not present in fcl-image</short>
<short>Implements a polygon fill algorithm not present in fcl-image.</short>
<descr>
<p>
Implements a polygon fill algorithm not present in fcl-image. The algorithm is explained <url href="http://alienryderflex.com/polygon_fill/">here</url>.
@ -377,30 +377,30 @@
<seealso></seealso>
</element>
<element name="TLazCanvas.DoPolygonFill.points">
<short>Array with the TPoint instances for the polygon corners</short>
<short>Array with the TPoint instances for the polygon corners.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TLazCanvas.DoLine">
<short>Draws a line using the specified coordinates and Pen for the canvas</short>
<short>Draws a line using the specified coordinates and Pen for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TLazCanvas.DoLine.x1">
<short>Initial horizontal coordinate for the line</short>
<short>Initial horizontal coordinate for the line.</short>
</element>
<element name="TLazCanvas.DoLine.y1">
<short>Initial vertical coordinate for the line</short>
<short>Initial vertical coordinate for the line.</short>
</element>
<element name="TLazCanvas.DoLine.x2">
<short>Terminal horizontal coordinate for the line</short>
<short>Terminal horizontal coordinate for the line.</short>
</element>
<element name="TLazCanvas.DoLine.y2">
<short>Terminal vertical coordinate for the line</short>
<short>Terminal vertical coordinate for the line.</short>
</element>
<element name="TLazCanvas.DoCopyRect">
<short>Copies a source rectangle to the specified canvas</short>
<short>Copies a source rectangle to the specified canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -418,7 +418,7 @@
</element>
<element name="TLazCanvas.DoDraw">
<short>Draws the specified image at the given coordinates using AlphaBlending</short>
<short>Draws the specified image at the given coordinates using AlphaBlending.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -434,7 +434,7 @@
<!-- variable Visibility: public -->
<element name="TLazCanvas.HasNoImage">
<short>Indicates if a valid image was provided in the constructor</short>
<short>Indicates if a valid image was provided in the constructor.</short>
<descr>
<p>
<var>HasNoImage</var> is a <var>Boolean</var> member used to indicate if a valid <var>TFPCustomImage</var> was provided as an argument to the <var>Create</var> constructor. Used in the implementation of the <var>UpdateControlLazImageAndCanvas</var> routine for non-native custom drawn window controls.
@ -447,7 +447,7 @@
<!-- variable Visibility: public -->
<element name="TLazCanvas.NativeDC">
<short>Native device context for the canvas</short>
<short>Native device context for the canvas.</short>
<descr>
<p>
<var>NativeDC</var> is a <var>PtrInt</var> member which contains the device context used to render a custom-drawn LCL control.
@ -458,7 +458,7 @@
<!-- constructor Visibility: public -->
<element name="TLazCanvas.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance. Create calls the inherited constructor using <var>AnImage</var> as an argument.
@ -472,12 +472,12 @@
</seealso>
</element>
<element name="TLazCanvas.Create.AnImage">
<short>Screen image for the control rendered on the canvas</short>
<short>Screen image for the control rendered on the canvas.</short>
</element>
<!-- destructor Visibility: public -->
<element name="TLazCanvas.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance. Destroy ensures that resources allocated for <var>GraphicStateList</var>, <var>AssignedBrush</var>, and <var>AssignedPen</var> are freed. Destroy calls the inherited destructor prior to exiting from the method.
@ -491,17 +491,17 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.SetLazClipRegion">
<short>Sets the value in the ClipRegion property</short>
<short>Sets the value in the ClipRegion property.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TLazCanvas.SetLazClipRegion.ARegion">
<short>Region stored in the property</short>
<short>Region stored in the property.</short>
</element>
<!-- function Visibility: public -->
<element name="TLazCanvas.SaveState">
<short>Saves the current canvas state in the GraphicStateList member</short>
<short>Saves the current canvas state in the GraphicStateList member.</short>
<descr>
<p>
<var>SaveState</var> is an <var>Integer</var> function used to save the current canvas state in the <var>GraphicStateList</var> member. SaveState creates an instance of <var>TLazCanvasState</var> with copies of the current values for <var>Brush</var>, <var>Pen</var>, and <var>Font</var>. Values from <var>BaseWindowOrg</var>, <var>WindowOrg</var>, and <var>Clipping</var> are also assigned to the class instance.
@ -524,23 +524,23 @@
</element>
<element name="TLazCanvas.SaveState.Result">
<short>
Ordinal position in GraphicStateList where the saved canvas state was stored
Ordinal position in GraphicStateList where the saved canvas state was stored.
</short>
</element>
<!-- procedure Visibility: public -->
<element name="TLazCanvas.RestoreState">
<short>Restores the canvas to the state stored at the specified position</short>
<short>Restores the canvas to the state stored at the specified position.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TLazCanvas.RestoreState.AIndex">
<short>Ordinal position in GraphicStateList restored in the method</short>
<short>Ordinal position in GraphicStateList restored in the method.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TLazCanvas.ResetCanvasState">
<short>Sets the canvas to the default values/state used in the LCL TCanvas class</short>
<short>Sets the canvas to the default values/state used in the LCL TCanvas class.</short>
<descr></descr>
<errors></errors>
<seealso></seealso>
@ -548,7 +548,7 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.AlphaBlend">
<short>Performs an AlphaBlend operation using the specified source canvas</short>
<short>Performs an AlphaBlend operation using the specified source canvas.</short>
<descr></descr>
<errors></errors>
<seealso></seealso>
@ -608,7 +608,7 @@
</element>
<element name="TLazCanvas.AlphaBlend_Image">
<short>AlphaBlends the specified image onto the canvas</short>
<short>AlphaBlends the specified image onto the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -635,7 +635,7 @@
</element>
<element name="TLazCanvas.DoDrawImage">
<short>Calls DoDraw for the specified image and coordinates</short>
<short>Calls DoDraw for the specified image and coordinates.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -651,7 +651,7 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.CanvasCopyRect">
<short>Copies the contents of a supported image format in ASource to the canvas</short>
<short>Copies the contents of a supported image format in ASource to the canvas.</short>
<descr></descr>
<errors></errors>
<seealso></seealso>
@ -680,7 +680,7 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.FillColor">
<short>Fills the entire drawing area with the specified color</short>
<short>Fills the entire drawing area with the specified color.</short>
<descr>
<p>
Fills the entire drawing area with the specified color. <var>AIgnoreClippingAndWindowOrg</var> speeds up canvas drawing operations, but it is dangerous; don't use it unless you know what you are doing.
@ -689,7 +689,7 @@
<seealso></seealso>
</element>
<element name="TLazCanvas.FillColor.AColor">
<short>Color applied to the canvas area</short>
<short>Color applied to the canvas area.</short>
</element>
<element name="TLazCanvas.FillColor.AIgnoreClippingAndWindowOrg">
<short></short>
@ -697,7 +697,7 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.AssignPenData">
<short>Sets the Pen data for the canvas</short>
<short>Sets the Pen data for the canvas.</short>
<descr>
<p>
Utilized by <var>LCLIntf.SelectObject</var> and by the <var>RestoreState</var> method. This is needed because calling <var>Assign</var> for the <var>Pen</var>, <var>Brush</var>, or <var>Font</var> properties raises exceptions.
@ -712,7 +712,7 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.AssignBrushData">
<short>Sets the Brush data for the canvas</short>
<short>Sets the Brush data for the canvas.</short>
<descr>
<p>
Utilized by <var>LCLIntf.SelectObject</var> and by the <var>RestoreState</var> method. This is needed because calling <var>Assign</var> for the <var>Pen</var>, <var>Brush</var>, or <var>Font</var> properties raises exceptions.
@ -727,7 +727,7 @@
<!-- procedure Visibility: public -->
<element name="TLazCanvas.AssignFontData">
<short>Srts the Font data for the canvas</short>
<short>Srts the Font data for the canvas.</short>
<descr>
<p>
Utilized by <var>LCLIntf.SelectObject</var> and by the <var>RestoreState</var> method. This is needed because calling <var>Assign</var> for the <var>Pen</var>, <var>Brush</var>, or <var>Font</var> properties raises exceptions.
@ -742,7 +742,7 @@
<!-- property Visibility: public -->
<element name="TLazCanvas.AssignedPen">
<short>Pen assigned to the canvas</short>
<short>Pen assigned to the canvas.</short>
<descr>
<p>
These properties are utilized to implement <var>LCLIntf.SelectObject</var> to keep track of which pen/brush/font handle was assigned to this canvas. They are not utilized by <var>TLazCanvas</var> itself.
@ -753,7 +753,7 @@
<!-- property Visibility: public -->
<element name="TLazCanvas.AssignedBrush">
<short>Brush assigned to the canvas</short>
<short>Brush assigned to the canvas.</short>
<descr>
<p>
These properties are used to implement <var>LCLIntf.SelectObject</var> to keep track of which pen/brush/font handle was assigned to this canvas. They are not utilized by <var>TLazCanvas</var> itself.
@ -764,7 +764,7 @@
<!-- property Visibility: public -->
<element name="TLazCanvas.AssignedFont">
<short>Font assigned to the canvas</short>
<short>Font assigned to the canvas.</short>
<descr>
<p>
These properties are used to implement <var>LCLIntf.SelectObject</var> to keep track of which pen/brush/font handle was assigned to this canvas. They are not utilized by <var>TLazCanvas</var> itself.
@ -775,7 +775,7 @@
<!-- property Visibility: public -->
<element name="TLazCanvas.BaseWindowOrg">
<short>Base window origin for the canvas</short>
<short>Base window origin for the canvas.</short>
<descr>
<p>
The values in <var>WindowOrg</var> are relative to the coordinates in <var>BaseWindowOrg</var>. BaseWindowOrg coordinates are relative to the canvas for the containing Form. It is useful when implementing the non-native windowed controls.
@ -785,14 +785,14 @@
</element>
<element name="TLazCanvas.ClipRegion">
<short>Clipping region for the canvas</short>
<short>Clipping region for the canvas.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- property Visibility: public -->
<element name="TLazCanvas.WindowOrg">
<short>Window origin for the canvas</short>
<short>Window origin for the canvas.</short>
<descr>
<p>
Contains the absolute coordinates for the canvas with <var>BaseWindowOrg</var> summed up.