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

Docs: LCL/various. Fixes spelling and grammar errors.

Browse Source 
Modified files:
  docs/xml/lcl/buttons.xml
  docs/xml/lcl/comboex.xml
  docs/xml/lcl/comctrls.xml
  docs/xml/lcl/controls.xml
  docs/xml/lcl/dialogs.xml
  docs/xml/lcl/extctrls.xml
  docs/xml/lcl/extdlgs.xml
  docs/xml/lcl/forms.xml
  docs/xml/lcl/graphics.xml
  docs/xml/lcl/graphutil.xml
  docs/xml/lcl/grids.xml
  docs/xml/lcl/interfacebase.xml
  docs/xml/lcl/jsonpropstorage.xml
  docs/xml/lcl/lazregions.xml
  docs/xml/lcl/lclintf.xml
  docs/xml/lcl/lcltype.xml
  docs/xml/lcl/maskedit.xml
  docs/xml/lcl/propertystorage.xml
  docs/xml/lcl/stdctrls.xml
  docs/xml/lcl/themes.xml
  docs/xml/lcl/valedit.xml
  docs/xml/lcl/xmlpropstorage.xml
This commit is contained in:
dsiders 2022-04-19 04:01:08 +01:00
parent 517b29cbbd
commit 252d8218ef
22 changed files with 182 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -352,7 +352,7 @@
</element>
<element name="TButtonGlyph._AddRef">
<short>Implements the method from IUnkown.</short>
<short>Implements the method from IUnknown.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -628,7 +628,7 @@
</short>
<descr>
<p>
<var>Draw</var> is a method used to draw the glyph for the button using the target and configuration specified in the arguments. Draw is overloaded to provide a variant which uses a scalilng factor for the glyph image.
<var>Draw</var> is a method used to draw the glyph for the button using the target and configuration specified in the arguments. Draw is overloaded to provide a variant which uses a scaling factor for the glyph image.
</p>
<p>
<var>Canvas</var> is the TCanvas instance where the glyph is rendered.

18
docs/xml/lcl/comboex.xml
View File

@ -43,10 +43,12 @@
<element name="Forms"/>
<element name="TAutoCompleteOption">
<short>Enumerated type with values representing the autocomplete options used in TComboBoxEx.</short>
<short>
Enumerated type with values representing the auto-complete options used in TComboBoxEx.
</short>
<descr>
<p>
<var>TAutoCompleteOption</var> is an enumerated type with values representing the autocomplete options used in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. Values from the enumeration are stored in the <var>TAutoCompleteOptions</var> set type used to implement the <var>AutoCompleteOptions</var> property in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. Including a value from the enumeration in the TAutoCompleteOptions set enables the corresponding feature.
<var>TAutoCompleteOption</var> is an enumerated type with values representing the autocomplete options used in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. Values from the enumeration are stored in the <var>TAutoCompleteOptions</var> set type used to implement the <var>AutoCompleteOptions</var> property in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>. Including a value from the enumeration in the TAutoCompleteOptions set enables the corresponding feature.
</p>
</descr>
<seealso>
@ -62,7 +64,9 @@
<short>Enables auto-appending items to the combo-box.</short>
</element>
<element name="TAutoCompleteOption.acoSearch">
<short>Enables searching items for the current value in the edit control.</short>
<short>
Enables searching items for the current value in the edit control.
</short>
</element>
<element name="TAutoCompleteOption.acoFilterPrefixes">
<short>Enables prefixes in the filter for the control.</short>
@ -71,10 +75,14 @@
<short>Enables Tab key navigation in the control.</short>
</element>
<element name="TAutoCompleteOption.acoUpDownKeyDropsList">
<short>Enables toggling the visibility of the drop down using Up and Down cursor keys.</short>
<short>
Enables toggling the visibility of the drop down using Up and Down cursor keys.
</short>
</element>
<element name="TAutoCompleteOption.acoRtlReading">
<short>Enables Right-to-Left text rendering (BiDi Mode) in the control.</short>
<short>
Enables Right-to-Left text rendering (BiDi Mode) in the control.
</short>
</element>
<element name="TAutoCompleteOptions">

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

@ -5952,7 +5952,7 @@ end;
<short>Control is drawn using the hot tracking style.</short>
</element>
<element name="TCustomDrawStateFlag.cdsMarked">
<short>Control is drawn using the marked (multiselected) style.</short>
<short>Control is drawn using the marked (multi-selected) style.</short>
</element>
<element name="TCustomDrawStateFlag.cdsIndeterminate">
<short>Control is drawn using the indeterminate state style.</short>
@ -9782,7 +9782,7 @@ end;
<short>Not implemented in the current LCL version.</short>
<descr>
<p>
Not implemented in the current LCL version. Updates to scrll bar visibility, position, or range are handled in the widgetset class.
Not implemented in the current LCL version. Updates to scroll bar visibility, position, or range are handled in the widgetset class.
</p>
</descr>
<seealso/>
@ -10974,7 +10974,7 @@ end;
<short>Contains the Width for the large images used in the list view.</short>
<descr>
<p>
<var>LargeImagesWidth</var> is an <var>Integer</var> property with the width for large images in the list view. The value indicates the image resolution requested from the LargeImages image list. If a resoution using the requested width does not already exist, it is created by scaling a candidate resolution for the image list.
<var>LargeImagesWidth</var> is an <var>Integer</var> property with the width for large images in the list view. The value indicates the image resolution requested from the LargeImages image list. If a resolution using the requested width does not already exist, it is created by scaling a candidate resolution for the image list.
</p>
<p>
The default value for the property is zero (<b>0</b>), and causes the width stored in LargeImages to be used for the large images.
@ -11073,7 +11073,7 @@ end;
<short>Width for the images in the SmallImages property.</short>
<descr>
<p>
<var>SmallImagesWidth</var> is an <var>Integer</var> property that indicates the width for the small images displayed in the list view. The value indicates the image resolution requested from the SmallImages image list. If a resoution using the requested width does not already exist, it is created by scaling a candidate resolution for the image list.
<var>SmallImagesWidth</var> is an <var>Integer</var> property that indicates the width for the small images displayed in the list view. The value indicates the image resolution requested from the SmallImages image list. If a resolution using the requested width does not already exist, it is created by scaling a candidate resolution for the image list.
</p>
<p>
The default value for the property is zero (<b>0</b>), and causes the width stored in the image list to be used for its images.
@ -22843,7 +22843,7 @@ AToolbar.ButtonHeight := 30;
No actions are performed in the method for any of the following conditions:
</p>
<ul>
<li>ANode has not been assigned (contains <b>Nilb></b>).</li>
<li>ANode has not been assigned (contains <b>Nil</b>).</li>
<li>ANode is not visible.</li>
<li>
BeginEditing has been called and EndEditing has not yet been called.
@ -26262,7 +26262,9 @@ OldExpanded.Free;
<short>Tree view with nodes examined in the method.</short>
</element>
<element name="TTreeNodeExpandedState.Apply.CollapseToo">
<short>Collapses previously expanded child nodes when <b>True</b>.</short>
<short>
Collapses previously expanded child nodes when <b>True</b>.
</short>
</element>
<element name="TTreeNodeExpandedState.OnGetNodeText">

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

@ -10006,7 +10006,7 @@
</short>
<descr>
<p>
GetChildAccessibleObjectAtPos returns the accesibility object at the position expressed in client coordinates. This method is provided for controls which wish to override this behavior without sub-classing TLazAccessibleObject.
GetChildAccessibleObjectAtPos returns the accessibility object at the position expressed in client coordinates. This method is provided for controls which wish to override this behavior without sub-classing TLazAccessibleObject.
</p>
</descr>
<seealso>
@ -10567,7 +10567,7 @@
GetDefaultColor uses the value provided by the corresponding method in the widgetset class instance when a value other than clDefault is returned. When not resolved in the widgetset class, the return value is retrieved using the Parent color or the local values in the class instance. If <var>ParentColor</var> is <b>True</b> (and <var>Parent</var> is assigned), the GetDefaultColor method in the Parent control is called to get the specified color type. Otherwise, one of the values from the preceding list is used for the color type.
</p>
<p>
GetDefaultColor is a virtual method and can be overridden in descedent classes to use the colors needed for a specific control.
GetDefaultColor is a virtual method and can be overridden in descendent classes to use the colors needed for a specific control.
</p>
<p>
GetDefaultColor is used in the implementation of the GetColorResolvingParent and GetRGBColorResolvingParent methods. It is also called from the SetColor and CreateBrush methods in the TWinControl descendant.
@ -11110,7 +11110,7 @@
The return value is <b>True</b> when the Visible property is set to <b>True</b>. The value is <b>False</b> at design-time if the ControlStyle property includes the value csNoDesignVisible. IsControlVisible does not check the visibility for parent controls in the control hierarchy.
</p>
<p>
Use IsVisible to consider the visiblity for any Parent controls.
Use IsVisible to consider the visibility for any Parent controls.
</p>
</descr>
<seealso>
@ -12523,7 +12523,7 @@ ALabel.Caption := '&amp;Notes &amp;&amp; Comments';
<short>Event handler signalled when the Bounds of the control have been changed.</short>
<descr>
<p>
<var>OnChangeBounds</var> is signalled from the DoOnChangeBounds method (when assigned). It occurs after the internal control flags have been updated to excelude cfOnChangeBoundsNeeded, and before DoCallNotifyHandler is called to notify handlers for the chtOnChangeBounds type.
<var>OnChangeBounds</var> is signalled from the DoOnChangeBounds method (when assigned). It occurs after the internal control flags have been updated to exclude cfOnChangeBoundsNeeded, and before DoCallNotifyHandler is called to notify handlers for the chtOnChangeBounds type.
</p>
</descr>
<seealso>
@ -13231,7 +13231,7 @@ ALabel.Caption := '&amp;Notes &amp;&amp; Comments';
<short>Enlarge children equally, i.e. by the same amount of pixels.</short>
<descr>
<p>
Enlarge children equally. Children are resized to their normal/adviced size. If there is some space left in the client area of the parent, then the remaining space is distributed equally to each child.
Enlarge children equally. Children are resized to their normal/advised size. If there is space left in the client area of the parent, the remaining space is distributed equally to each child.
</p>
<p>
For example: 3 child controls A, B, C with A.Width=10, B.Width=20 and C.Width=30 (total=60). If the Parent's client area has a ClientWidth of 120, then 60/3=20 is added to each Child.

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

@ -876,7 +876,7 @@
<short/>
</element>
<element name="TOpenOption.ofAllowMultiSelect">
<short>allow multiselection.</short>
<short>Enaboles multi-selection.</short>
</element>
<element name="TOpenOption.ofExtensionDifferent">
<short/>
@ -3630,7 +3630,7 @@ ADialog.CustomColors.Values['ColorA'] := 'FFFF00';
<var>ExpandButtonCaption</var> is a TTranslateString property with the caption text displayed beside the button used to expand or collapse the ExpandedText on the Task dialog. The property value can be localized using the standard LCL translation facilities.
</p>
<p>
The default value for the property is an empty String (''), and cause the values "See details" or "Hide details" to be used on the Task dialog (when the lanuguage is English). Setting a value for the property causes the same caption to be displayed for both the expanded and collapsed states; only the button indicator changes.
The default value for the property is an empty String (''), and cause the values "See details" or "Hide details" to be used on the Task dialog (when the language is English). Setting a value for the property causes the same caption to be displayed for both the expanded and collapsed states; only the button indicator changes.
</p>
<p>
Use the Flags property to control the position (tfExpandFooterArea) or the expanded / collapsed state (tfExpandedByDefault) for the ExpandedText on the Task dialog.

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

@ -2050,7 +2050,7 @@
</short>
<descr>
<p>
<var>OnCanResize</var> is a <var>TCanResizeEvent</var> proprety with the event handler signalled to determine if the splitter control can be resized. OnCanResise is signalled (when assigned) from the <var>CheckNewSize</var> method using the splitter control and the new size for the anchored control as arguments. The <var>Accept</var> argument can be updated in the event handler to indicate whether the new size is acceptable (True) or rejected (False).
<var>OnCanResize</var> is a <var>TCanResizeEvent</var> property with the event handler signalled to determine if the splitter control can be resized. OnCanResise is signalled (when assigned) from the <var>CheckNewSize</var> method using the splitter control and the new size for the anchored control as arguments. The <var>Accept</var> argument can be updated in the event handler to indicate whether the new size is acceptable (True) or rejected (False).
</p>
</descr>
<seealso>
@ -2061,7 +2061,9 @@
</element>
<element name="TCustomSplitter.OnMoved">
<short>Event handler signalled when the splitter has been dragged / moved.</short>
<short>
Event handler signalled when the splitter has been dragged / moved.
</short>
<descr>
<p>
<var>OnMoved</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the splitter control has been dragged / moved. It is signalled (when assigned) from the <var>StopSplitterMove</var> method when the mouse button is released to end the drag operation. It occurs after the splitter has been moved using the <var>MoveSplitter</var> method.
@ -7156,7 +7158,9 @@
</seealso>
</element>
<element name="TBandDrawingStyle.dsNormal">
<short>Bands are drawn noramlly using the color for the control bar.</short>
<short>
Bands are drawn normally using the color for the control bar.
</short>
</element>
<element name="TBandDrawingStyle.dsGradient">
<short>Bands are drawn using a gradient for the background colors.</short>

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

@ -356,7 +356,7 @@
The <var>FileName</var> property is assigned to <var>PreviewFileName</var>, which is used as the source for the content displayed in <var>ImageCtrl</var>. FileName must be a valid file name on the local file system, and have read permissions. PreviewFileName is loaded into the picture for the ImageCtrl, and the caption in <var>PictureGroupBox</var> is updated to display the Width and Height for the stored image in the format <b>'(%dx%d)'</b>.
</p>
<p>
If the file is not successully loaded (due to permissions or image format), the <var>ClearPreview</var> method is called.
If the file is not successfully loaded (due to permissions or image format), the <var>ClearPreview</var> method is called.
</p>
<p>
UpdatePreview is called from the <var>DoSelectionChange</var> method when the selected file name for the preview dialog has changed.
@ -442,7 +442,7 @@
</short>
<descr>
<p>
<var>DoShow</var> is an overridden procedure used to display the Picture FIle Open preview dialog. DoShow calls <var>ClearPreview</var> to set the dialog to the state needed prior to selecting an image file name in the preview dialog.
<var>DoShow</var> is an overridden procedure used to display the Picture File Open preview dialog. DoShow calls <var>ClearPreview</var> to set the dialog to the state needed prior to selecting an image file name in the preview dialog.
</p>
<p>
DoShow calls the inherited method to signal the <var>OnShow</var> event handler (when assigned).
@ -1208,7 +1208,7 @@
</short>
<descr>
<p>
<var>DialogScale</var> is an <var>Integer</var> property which indicates the scaling percentage applied to the height and width for the calculator dialog. When the value for the property is changed, it its validated and adjusted to ensure that it is in the range <b>80...400</b> (the minuimum and maximum allowed for the property).
<var>DialogScale</var> is an <var>Integer</var> property which indicates the scaling percentage applied to the height and width for the calculator dialog. When the value for the property is changed, it its validated and adjusted to ensure that it is in the range <b>80...400</b> (the minimum and maximum allowed for the property).
</p>
<p>
DialogScale is passed as the multiplier argument to the <var>ScaleBy</var> method in <var>TCalculatorForm</var>; the divisor is always set to <b>100</b>.
@ -1431,7 +1431,7 @@
<element name="TCalendarDialog.Execute">
<short>
Configures and dIsplays the form for the calendar dialog, and captures the results.
Configures and displays the form for the calendar dialog, and captures the results.
</short>
<descr/>
<seealso>

6
docs/xml/lcl/forms.xml
View File

@ -174,7 +174,7 @@
</element>
<element name="TWindowState.wsFullScreen">
<short>
The window appears in full screen mode, when allowed by the platform. It will, for example, attempt to appear on the top of taskbars and other static platform user interface elements. wsFullScreen is converted to wsMaximized for use on the the Windows platform; the API does not provide a full screen option.
The window appears in full screen mode, when allowed by the platform. It will, for example, attempt to appear on the top of task bars and other static platform user interface elements. wsFullScreen is converted to wsMaximized for use on the the Windows platform; the API does not provide a full screen option.
</short>
</element>
@ -6169,7 +6169,7 @@
<short>Arranges MDI child forms so they overlap.</short>
<descr>
<p>
Cascade is a method used to arrange MDI Chid forms so that they overlap in a cascading fashion.
Cascade is a method used to arrange MDI Child forms so that they overlap in a cascading fashion.
</p>
<p>
No actions are performed in the method when FormStyle has a value other than fsMDIForm. At run-time, the Cascade method in the widgetset class is called when its Handle has been allocated.
@ -13384,7 +13384,7 @@ HintWindow.ActivateHint(Rect, 'This is the hint');
</short>
<descr>
<p>
<var>OnUserInput</var> is a <var>TOnUserInputEvent</var> property with the event handler signalled when an input message is available in the processing loop for the widgetset class. It is signalled (when assigned) from the <var>NotifyUserInputHandler</var> method, and occurs before other application handlers using the <var>ahtUserInput</var> type are notififed.
<var>OnUserInput</var> is a <var>TOnUserInputEvent</var> property with the event handler signalled when an input message is available in the processing loop for the widgetset class. It is signalled (when assigned) from the <var>NotifyUserInputHandler</var> method, and occurs before other application handlers using the <var>ahtUserInput</var> type are notified.
</p>
</descr>
<seealso>

44
docs/xml/lcl/graphics.xml
View File

@ -2488,8 +2488,7 @@
<short>Rotation for the current font in 1/10ths of a degree.</short>
<descr>
<p>
<var>Orientation</var> is an
<var>Integer</var> property which contains the rotation angle used for text in 1/10ths of a degree. The rotation angle is determined by the relationship between the X Axis for the Canvas and the baseline for the font, and uses the following directionality:
<var>Orientation</var> is an <var>Integer</var> property which contains the rotation angle used for text in 1/10ths of a degree. The rotation angle is determined by the relationship between the X Axis for the Canvas and the baseline for the font, and uses the following directions:
</p>
<table>
<caption>Orientation Values and Directions</caption>
@ -2510,9 +2509,11 @@
<td>Text is drawn vertically from top to bottom.</td>
</tr>
</table>
<p>Setting a new value for the property causes the font Reference to be re-created, and calls Changes to signal the OnChange event handler (when assigned).
<p>
Setting a new value for the property causes the font Reference to be re-created, and calls Changes to signal the OnChange event handler (when assigned).
</p>
<p>The default value for the property is <b>0</b> (<b>zero</b>).
<p>
The default value for the property is <b>0</b> (<b>zero</b>).
</p>
</descr>
</element>
@ -6257,7 +6258,7 @@
</element>
<element name="TCanvas.SetClipping">
<short>
<var>SetClipping</var> specifies (via boolean argument) whether clipping is to be performed.
<var>SetClipping</var> specifies whether clipping is to be performed.
</short>
<descr/>
<seealso/>
@ -8278,19 +8279,21 @@
</short>
<descr>
<p>
<var>IsEmpy</var> is a
<var>Boolean</var> function which indicates if image content has been assigned for the shared image. The return value is <b>True</b> when both the Handle and the <var>SaveStream</var> for the shared image are unassigned. Specifically, Handle contains <b>0</b> and SaveStream is <b>Nil</b>.
<var>IsEmpty</var> is a <var>Boolean</var> function which indicates if image content has been assigned for the shared image. The return value is <b>True</b> when both the Handle and the <var>SaveStream</var> for the shared image are unassigned. Specifically, Handle contains <b>0</b> and SaveStream is <b>Nil</b>.
</p>
</descr>
<seealso/>
</element>
<element name="TSharedRasterImage.IsEmpty.Result">
<short/>
<short>
True if both the handle and the storage stream are not assigned.
</short>
</element>
<element name="TSharedRasterImage.Create">
<short>Constructor for the class instance.</short>
<descr>
<p>Create is the constructor for the class instance, and calls the inherited constructor on entry.
<p>
Create is the constructor for the class instance, and calls the inherited constructor on entry.
</p>
</descr>
<seealso>
@ -9530,7 +9533,8 @@
<element name="TRasterImage.Mask">
<short>Applies the color used for transparent pixels to the image.</short>
<descr>
<p>Calls CreateMask to create and appy the mask handle required for the fixed color transparency.
<p>
Calls CreateMask to create and apply the mask handle required for the fixed color transparency.
</p>
</descr>
<seealso/>
@ -9733,15 +9737,17 @@
<short>Color used for transparent pixels in the image.</short>
<descr>
<p>
<var>TransparentColor</var> is a
<var>TColor</var> property which indicates the color used for transparent pixels in the raw image data. The default value for the property is
<var>TransparentColor</var> is a <var>TColor</var> property which indicates the color used for transparent pixels in the raw image data. The default value for the property is
<var>clDefault</var>.
</p>
<p>TransparentColor is used along with <var>TransparentMode</var> to determine whether a fixed color is used for transparency, or if the tranparent color is read from a specified pixel in the raw image data.
<p>
TransparentColor is used along with <var>TransparentMode</var> to determine whether a fixed color is used for transparency, or if the transparent color is read from a specified pixel in the raw image data.
</p>
<p>When TransparentColor contains <var>clDefault</var>, the <var>RequestTransparentColor</var> method is used to get the transparency color value from the bottom-left pixel in the raw image data.
<p>
When TransparentColor contains <var>clDefault</var>, the <var>RequestTransparentColor</var> method is used to get the transparency color value from the bottom-left pixel in the raw image data.
</p>
<p>When setting a new value for the property, the TransparentMode property is updated as well. When clDefault is assigned to the property, TransparentMode is set to <var>tmAuto</var>. For other color values, TransparentMode is set to <var>tmFixed</var>.
<p>
When setting a new value for the property, the TransparentMode property is updated as well. When clDefault is assigned to the property, TransparentMode is set to <var>tmAuto</var>. For other color values, TransparentMode is set to <var>tmFixed</var>.
</p>
<p>
<var>MaskHandleAllocated</var> is called to determine if a HBITMAP handle has been allocated for the MaskHandle property. When <b>True</b>, the <var>MaskHandle</var> is reset to 0 to indicate the handle is no longer in use or is invalid.
@ -9940,7 +9946,7 @@
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is theoverridden destructor for
<var>Destroy</var> is the overridden destructor for
<var>TSharedCustomBitmap</var>.
</p>
<p>Destroy frees the internal save stream for the class instance. It also calls FreeHandle and FreeImage to free the handle and the raw image data for the shared bitmap. Calls the inherited destructor prior to exiting from the method.
@ -10272,7 +10278,7 @@
<short>Gets a pointer to the image descriptor for the shared Bitmap image.
</short>
<descr>
<p>Calls <var>RawimageNeeded</var> to ensure that the image desriptor is valid.
<p>Calls <var>RawimageNeeded</var> to ensure that the image descriptor is valid.
</p>
</descr>
<seealso>
@ -12205,7 +12211,7 @@
<var>ReadStream</var> is an overridden procedure used to read the content for the icon from the stream specified in
<var>AStream</var>. ReadStream implements the abstract virtual method defined in the ancestor class.
</p>
<p>ReadStream verifies that AStream contains an icon image by checking for header value(s) that are valid for .ICO data. If the header values are nopt found, an <var>EInvalidGraphic</var> exception is raised.
<p>ReadStream verifies that AStream contains an icon image by checking for header value(s) that are valid for .ICO data. If the header values are not found, an <var>EInvalidGraphic</var> exception is raised.
</p>
<p>For icon data, the icon directory must be read from the stream. The header contains the number of icon directory entries included in the stream. The icon directory entries are read from AStream, and include values for each icon image that includes:
</p>
@ -12215,7 +12221,7 @@
<li>BytesInRes</li>
<li>ImageOffset</li>
</ul>
<p>ReadStream positions the stream, and reads image data for the each of the icon directory entries. It handles both DIB Bitmap and PNG (used in WIndows Vista) image data for the icon images. An FCL-compatible image reader is created as required for the image type, and a <var>TLazIntfImage</var> instance is used to capture the raw image data from the stream. Images read from the stream are added to the internal list of images in the <var>TSharedIcon</var> member for the class instance.
<p>ReadStream positions the stream, and reads image data for the each of the icon directory entries. It handles both DIB Bitmap and PNG (used in Windows Vista) image data for the icon images. An FCL-compatible image reader is created as required for the image type, and a <var>TLazIntfImage</var> instance is used to capture the raw image data from the stream. Images read from the stream are added to the internal list of images in the <var>TSharedIcon</var> member for the class instance.
</p>
<p>ReadStream calls <var>CheckRequestedSize</var> to use the <var>Width</var> and/or <var>Height</var> specified in the class instance. <var>GetBestIndexForSize</var> is called to determine the value in <var>Current</var> with the requested image size.
</p>

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

@ -503,7 +503,7 @@
<var>FloodFill</var> is a procedure which implements a simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels. This algorithm avoids stack problems associated simple recursive algorithms described in the discussion at <url href="http://steve.hollasch.net/cgindex/polygons/floodfill.html"/>. Please note that the routine is slow because of its use of <var>Canvas.Pixels</var>.
</p>
<p>
Orginal author: Chris Rorden
Original author: Chris Rorden
</p>
</descr>
<seealso></seealso>
@ -649,7 +649,9 @@
</element>
<element name="WaveTo">
<short>Draws a hoizontal or vertical wave at the specified position to the given device context.</short>
<short>
Draws a horizontal or vertical wave at the specified position to the given device context.
</short>
<descr></descr>
<seealso></seealso>
</element>

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

@ -2927,7 +2927,7 @@
<li>IsDefaultFont returns True.</li>
</ul>
<p>
IsDefault is when the coloumns for the parent grid are streamed using the LCL component streaming mechanism. Columns which contain default values (including the title) are not written during component streaming.
IsDefault is when the columns for the parent grid are streamed using the LCL component streaming mechanism. Columns which contain default values (including the title) are not written during component streaming.
</p>
</descr>
<seealso>
@ -4601,13 +4601,13 @@
</element>
<element name="TGridDataCache.AccumWidth">
<short>Cumulative preceeding width per grid column.</short>
<short>Cumulative preceding width per grid column.</short>
<descr/>
<seealso/>
</element>
<element name="TGridDataCache.AccumHeight">
<short>Cumulative preceeding height per grid row.</short>
<short>Cumulative preceding height per grid row.</short>
<descr/>
<seealso/>
</element>
@ -8797,7 +8797,7 @@
<short>Gets the default text used as the column title for the specified column number.</short>
<descr>
<p>
<var>GetDefaultColumnTitle</var> provides the text used for the specified column number when <var>Columns</var> have not been enabled for the grid control. GetDefaultColumnTitle always returns an empty strng ('') in <var>TCustomGrid</var>.
<var>GetDefaultColumnTitle</var> provides the text used for the specified column number when <var>Columns</var> have not been enabled for the grid control. GetDefaultColumnTitle always returns an empty string ('') in <var>TCustomGrid</var>.
</p>
<p>
GetDefaultColumnTitle is called from the <var>GetColumnTitle</var> method.
@ -8959,7 +8959,7 @@
</seealso>
</element>
<element name="TCustomGrid.GetScrollBarPosition.Result">
<short>Current position in the secified scrollbar.</short>
<short>Current position in the specified scrollbar.</short>
</element>
<element name="TCustomGrid.GetScrollBarPosition.Which">
<short>Indicates the scrollbar (horizontal or vertical) examined in the method.</short>
@ -9765,7 +9765,7 @@
</dd>
</dl>
<p>
MouseMove sets the Hint displayed for the cell under the mouse pointer when ShowHint is enabled. Values in Hint, CellHintPriority, Options, and the OnGetCellHint event hander are used for the purpose. If the mouse pointer is not over a cell, the Hint for the application is reset to a previous hint or an empty string ('') when saved hint text is not available.
MouseMove sets the Hint displayed for the cell under the mouse pointer when ShowHint is enabled. Values in Hint, CellHintPriority, Options, and the OnGetCellHint event handler are used for the purpose. If the mouse pointer is not over a cell, the Hint for the application is reset to a previous hint or an empty string ('') when saved hint text is not available.
</p>
<p>
Called from WMMouseMove when a LM_MOUSEMOVE window message is handled for the grid control.
@ -11335,7 +11335,7 @@
<var>EditorMode</var> is a <var>Boolean</var> property which indicates whether the cell <var>Editor</var> has been enabled for the grid control. Set EditorMode to <b>True</b> to display the cell Editor for the control. Set it to <b>False</b> to hide the cell Editor.
</p>
<p>
The value in EditorMode is updated when handling key presses and mouse clicks, scrolling the visible area for the control, or changing the configration of the grid.
The value in EditorMode is updated when handling key presses and mouse clicks, scrolling the visible area for the control, or changing the configuration of the grid.
</p>
</descr>
<seealso>
@ -13516,7 +13516,7 @@
<var>ColRowDeleted</var> is an overridden method used to remove the specified column or row, and perform a notification for the change.
</p>
<p>
<var>IsColumn</var> indicates whether a column or a row is affected in the method. When set to True, a column is removed. Othewise, a row is removed.
<var>IsColumn</var> indicates whether a column or a row is affected in the method. When set to True, a column is removed. Otherwise, a row is removed.
</p>
<p>
<var>Index</var> contains the column or row number removed in the method.
@ -13873,7 +13873,7 @@
<var>WasInsert</var> determines the event handler signalled in the method. When WasInsert is set to <b>True</b>, the <var>OnColRowInserted</var> event handler is signalled (when assigned). When set to <b>False</b>, the <var>OnColRowDeleted</var> event handler is signalled (when assigned).
</p>
<p>
<var>FromIndex</var> and <var>ToIndex</var> indicate the column(s) or row(s) affected by the change. FromIndex has the column or row number where the action was performed. When a column or row was inserted, ToIndex has the same value as FromIndex. For changes to <var>ColCout</var> or <var>RowCount</var>, FromIndex and ToIndex contain the column or row count prior to and following the change.
<var>FromIndex</var> and <var>ToIndex</var> indicate the column(s) or row(s) affected by the change. FromIndex has the column or row number where the action was performed. When a column or row was inserted, ToIndex has the same value as FromIndex. For changes to <var>ColCount</var> or <var>RowCount</var>, FromIndex and ToIndex contain the column or row count prior to and following the change.
</p>
<p>
NotifyColRowChange is called from methods like <var>ColRowInserted</var>, <var>ColRowDeleted</var>, and <var>SizeChanged</var>.
@ -15765,7 +15765,7 @@
While values in Cells and Objects are related, they are handled independently. The value in Objects is not changed when a new value is assigned to Cells.
</p>
<p>
Values stored in Objects are set to Nil when the Clean method is callled to remove content in the grid. The application is responsible for allocating and freeing resources in Objects.
Values stored in Objects are set to Nil when the Clean method is called to remove content in the grid. The application is responsible for allocating and freeing resources in Objects.
</p>
<p>
Values for the Objects property are not included in the grid data read and written during LCL component streaming. They are not handled by the LoadContent and SaveContent either. The property values are available at run-time only.
@ -16177,7 +16177,7 @@
<var>goVertLine, goHorzLine</var>
</dt>
<dd>
The same as previous, but for the normal browseable area. A grid can be made to simulate a listbox by unsetting both of these options.
The same as previous, but for the normal browseable area. A grid can be made to simulate the visual appearance of a listbox by removing both of these options.
</dd>
<dt>
<var>goDrawFocusSelected</var>

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

@ -413,7 +413,7 @@
Create is the overridden constructor for the class instance, and calls the inherited method on entry.
</p>
<p>
ACollection is the <var>TCollection</var> instance which owns the new dialog button. It is assigned to the <var>Collection</var> property in the colleciton item.
ACollection is the <var>TCollection</var> instance which owns the new dialog button. It is assigned to the <var>Collection</var> property in the collection item.
</p>
<p>
Create sets the default values for the <var>Caption</var> and <var>ModalResult</var> properties.
@ -612,7 +612,7 @@
<var>AModalResult</var> contains the modal result value to locate in the collection Items.
</p>
<p>
<var>AOrder</var> allows an array of modal resuilt values to be located in the method. It specifies the search order for the modal result values.
<var>AOrder</var> allows an array of modal result values to be located in the method. It specifies the search order for the modal result values.
</p>
<p>
FindButton iterates over the <var>Items</var> in the collection to find the first button which uses the modal result value(s). The return value is the first TDialogButton instance in Items which matches the requested value(s).
@ -722,10 +722,10 @@
<element name="TWidgetSet.FThemeServices" link="#lcl.interfacebase.TWidgetSet.ThemeServices"/>
<element name="TWidgetSet.PassCmdLineOptions">
<short>Passes commandline arguments needed for the platform.</short>
<short>Passes command line arguments needed for the platform.</short>
<descr>
<p>
<var>PassCmdLineOptions</var> is a procedure used to pass commandline arguments used for the platform-specific widgetset implementation. PassCmdLineOptions has an empty implementation in <var>TWidgetSet</var>, and must be overridden in a descendent class. It allows commandline arguments to be preprocessed or modified prior to starting an application.
<var>PassCmdLineOptions</var> is a procedure used to pass command line arguments used for the platform-specific widgetset implementation. PassCmdLineOptions has an empty implementation in <var>TWidgetSet</var>, and must be overridden in a descendent class. It allows command line arguments to be preprocessed or modified prior to starting an application.
</p>
</descr>
<seealso/>
@ -951,7 +951,7 @@
<var>ACapability</var> contains a <var>TLCLCapability</var> enumeration value examined in the method. The value identifies a feature or behavior in the LCL.
</p>
<p>
The return value is either <var>LCL_CAPABILITY_NO</var> or <var>LCL_CAPABILITY_YES</var>. LCL_CAPABILITY_YES indicates that the capabiity is implemented for the platform.
The return value is either <var>LCL_CAPABILITY_NO</var> or <var>LCL_CAPABILITY_YES</var>. LCL_CAPABILITY_YES indicates that the capability is implemented for the platform.
</p>
<p>
GetLCLCapability is overridden in descendent classes to return a value valid for the platform-specific implementation. The implementation in TWidgetSet handles the capabilities common to all widgetsets supported in the LCL. It is called when the descendent class does not handle the value in ACapability.
@ -1764,7 +1764,7 @@
</element>
<element name="TWidgetSet.DeleteCriticalSection">
<short>Deletes an unowned critical section.</short>
<short>Deletes an un-owned critical section.</short>
<descr/>
<errors>
Results are unpredictable when the section is owned, i.e. has been entered but not yet left.
@ -1875,7 +1875,7 @@
Window managers do not normally allow the user to paint the components for a window frame, and do not supply a DC for that purpose.
</p>
<p>
The available features depend on the window manager for the platform, and the capabiities for the widgetset.
The available features depend on the window manager for the platform, and the capabilities for the widgetset.
</p>
</descr>
<seealso/>
@ -4225,7 +4225,7 @@
</p>
<dl>
<dt>RDW_NOERASE</dt>
<dd>Sppress all pending WM_ERASEBKGND messages.</dd>
<dd>Suppress all pending WM_ERASEBKGND messages.</dd>
<dt>RDW_NOFRAME</dt>
<dd>Suppress all pending WM_NCPAINT messages.</dd>
<dt>RDW_NOINTERNALPAINT</dt>
@ -4800,7 +4800,7 @@
The raster operation specifies how foreground painting (Brush, Pen) is combined with the current pixels in the DC. The operation combines bitwise the distinct red, green and blue values in pixel colors.
</p>
<p>
There are 16 raster operations usig the possible combinations of two (boolean) values:
There are 16 raster operations using the possible combinations of two (boolean) values:
</p>
<dl>
<dt>R2_BLACK</dt>
@ -5821,7 +5821,7 @@
</short>
</element>
<element name="TWidgetSet.ClipboardGetOwnerShip.FormatCount">
<short>Number of clipbpard formats in the list.</short>
<short>Number of clipboard formats in the list.</short>
</element>
<element name="TWidgetSet.ClipboardGetOwnerShip.Formats">
<short>Pointer to the list of registered clipboard formats requested.</short>

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

@ -152,7 +152,9 @@
<!-- function Visibility: protected -->
<element name="TCustomJSONPropStorage.FixPath">
<short>Turns '.' notation into '/' notation for the xpath-ish <url href="http://wiki.freepascal.org/fcl-json">JSONConf</url> underlayer.</short>
<short>
Turns '.' notation into '/' notation for the XPATH-like <url href="http://wiki.freepascal.org/fcl-json">JSONConf</url> underlayer.
</short>
<descr />
<errors />
<seealso />

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

@ -167,7 +167,7 @@
<var>TLazRegionPolygon</var> is a <var>TLazRegionPart</var> descendant which implements a region as a polygonal area defined by a series of vertices.
</p>
<p>
The <var>Points</var> member contains the <var>TPoint</var> values that define the vertices for the polygon. <var>FillMode</var> defines how the interior of the polygon is fillled, as uses values like those defined for the Windows GDI API. An overridden <var>IsPointInPart</var> is provided to determine if a point is within the bounds for the polygonal area.
The <var>Points</var> member contains the <var>TPoint</var> values that define the vertices for the polygon. <var>FillMode</var> defines how the interior of the polygon is filled, and uses values like those defined for the Windows GDI API. An overridden <var>IsPointInPart</var> is provided to determine if a point is within the bounds for the polygonal area.
</p>
<p>
Instances of TLazRegionPolygon are created when the <var>AddPolygon</var> method in <var>TLazRegion</var> is called.

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

@ -694,10 +694,10 @@
</element>
<!-- procedure Visibility: default -->
<element name="DeleteCriticalSection">
<short>Deletes an unowned critical section.</short>
<short>Deletes an un-owned critical section.</short>
<descr/>
<errors>
Results are unpredictable when the section is owned, i.e. has been entered but not yet left.
Results are unpredictable when the section is owned, i. e. has been entered but not yet exited.
</errors>
<seealso/>
</element>
@ -1384,7 +1384,7 @@
<short>Returns various device specific information.</short>
<descr>
<p>
Returns information about any DC (Device Context), which might be the screen DC representing the monitor, a control canvas or a offscreen bitmap canvas. The following constants can be utilized in the index argument:
Returns information about any DC (Device Context), which might be the screen DC representing the monitor, a control canvas or a off-screen bitmap canvas. The following constants can be utilized in the index argument:
</p>
<ul>
<li>HORZSIZE</li>
@ -4166,7 +4166,7 @@ end;
<descr>
<p>
The bytes are shifted into place, following the format $00bbggrr, which is the format of the
Windows API type COLORREF. Their actual physical order depends on the endianness of the machine.
Windows API type COLORREF. Their actual physical order depends on the endian-ness of the machine.
</p>
</descr>
<seealso/>

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

@ -774,7 +774,7 @@
<element name="DT_EDITCONTROL">
<short>
<var>DrawText</var> formatting:
emulate behavior of a multiline EDIT control.
emulates the behavior of a multi-line edit control.
</short>
<descr/>
<seealso/>

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

@ -1151,7 +1151,7 @@
</element>
<element name="TCustomMaskEdit.DeleteChars.NextChar">
<short>
When True the following character(s) are deleted; when False the preceeding character(s) are deleted.
When True the following character(s) are deleted; when False the preceding character(s) are deleted.
</short>
</element>

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

@ -1236,7 +1236,7 @@
</short>
<descr>
<p>
<var>StoredValues</var> is a <var>TStoredValues</var> property with the collection of names and values for properties handled by the storage container. StoredValues is used in the <var>Save</var> and <var>Restore</var> methods when the collection items are read or written using the underlying storage mechamism for the container. It is also used to read or write the value for the indexed <var>StoreValue</var> property.
<var>StoredValues</var> is a <var>TStoredValues</var> property with the collection of names and values for properties handled by the storage container. StoredValues is used in the <var>Save</var> and <var>Restore</var> methods when the collection items are read or written using the underlying storage mechanism for the container. It is also used to read or write the value for the indexed <var>StoreValue</var> property.
</p>
</descr>
<seealso>

14
docs/xml/lcl/stdctrls.xml
View File

@ -951,7 +951,7 @@
<short>Indicates if the control uses the background from the parent.</short>
<descr>
<p>
The write access specifier is overridden in <var>TCustomGroupBox</var>. It calls the inherited method on enty.
The write access specifier is overridden in <var>TCustomGroupBox</var>. It calls the inherited method on entry.
</p>
<p>
If <var>AParentBackground</var> is <b>True</b> and ParentColor is <b>True</b>, the <var>Color</var> from the <var>Parent</var> control is assigned to the <var>Color</var> property. Otherwise, the value <var>clDefault</var> is stored in the Color property.
@ -2197,7 +2197,7 @@
</seealso>
</element>
<element name="TCustomComboBox.SetSelLength.Val">
<short>New value for the SelLength sproperty.</short>
<short>New value for the SelLength property.</short>
</element>
<element name="TCustomComboBox.SetSelStart">
@ -3252,7 +3252,7 @@
<short>Appearance and behavior of the combo-box.</short>
<descr>
<p>
Style is quite Windows centric, reflecting the evolution of combo-box styles. The basic styles are:
Style is quite Windows-centric, reflecting the evolution of combo-box styles. The basic styles are:
</p>
<dl>
<dt>csSimple</dt>
@ -3911,7 +3911,9 @@
<short>Value for the Selected property.</short>
</element>
<element name="TCustomListBox.GetSelected.Index">
<short>Ordinal position for the item retrun as the property value.</short>
<short>
Ordinal position for the item returned as the property value.
</short>
</element>
<element name="TCustomListBox.GetCachedDataSize">
@ -9171,7 +9173,7 @@ end;
<var>ShortCutKey2</var> is a <var>TShortCut</var> property with the secondary shortcut key or accelerator key for the control. The property value contains both the virtual key code and the shift modifier combined to form the short cut key.
</p>
<p>
The property value (along with Shortcut) is passed to the widgetst class when the WSSetText method is called.
The property value (along with Shortcut) is passed to the widgetset class when the WSSetText method is called.
</p>
<p>
Use the <var>ShortCut</var> and <var>ShortCutToKey</var> routines in the <file>menu.pp</file> unit to convert to and from virtual key codes with shift modifiers.
@ -10661,7 +10663,7 @@ end;
<tr>
<td>Items</td>
<td>
The list of 'Things' that the object contains, such as a group of images, a series of lines of text, a number of actions in an actionlist, etc.
The list of 'Things' that the object contains, such as a group of images, a series of lines of text, a number of actions in an action list, etc.
</td>
</tr>
<tr>

6
docs/xml/lcl/themes.xml
View File

@ -228,7 +228,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
<!-- enumeration type Visibility: default -->
<element name="TThemedComboBox">
<short>Represents theme elemenets used to theme combo-box controls.</short>
<short>Represents theme elements used to theme combo-box controls.</short>
<descr/>
<seealso/>
</element>
@ -1981,7 +1981,7 @@ Constructor for the class instance.
</short>
<descr>
<p>
Calls <var>InitThemes</var> to detrmine if theme data is available. Sets the value in the <var>ThemesAvailable</var> property. Calls <var>UpdateThemes</var> to load theme data.
Calls <var>InitThemes</var> to determine if theme data is available. Sets the value in the <var>ThemesAvailable</var> property. Calls <var>UpdateThemes</var> to load theme data.
</p>
</descr>
<seealso>
@ -2274,7 +2274,7 @@ Draws the icon for a theme element.
</short>
<descr>
<p>
Overloaded to provide WIndows and non-Windows variants. Overridden in the TWin32ThemeServices descendant for compatability with Delphi.
Overloaded to provide Windows and non-Windows variants. Overridden in the TWin32ThemeServices descendant for compatibility with Delphi.
</p>
</descr>
<seealso/>

6
docs/xml/lcl/valedit.xml
View File

@ -262,7 +262,9 @@
</p>
<dl>
<dt><b>\</b></dt>
<dd>Quotes the following character; ie. '\-' inserts the literal '-' character</dd>
<dd>
Quotes the following character; i. e. '\-' inserts the literal '-' character
</dd>
<dt><b>&lt;</b></dt>
<dd>Converts following characters to upper case</dd>
<dt><b>&gt;</b></dt>
@ -2191,7 +2193,7 @@
InsertRowWithValues inserts the key name and value in Strings at the specified position using the "Key=Value" convention used in the control.
</p>
<p>
Use <var>InsertRow</var> to insert a new row using seperate key and item value parameters.
Use <var>InsertRow</var> to insert a new row using separate key and item value parameters.
</p>
</descr>
<seealso>

84
docs/xml/lcl/xmlpropstorage.xml
View File

@ -9,10 +9,16 @@
-->
<module name="XMLPropStorage">
<short>Contains a component that stores Form Session Properties in XML format.</short>
<short>
Contains a component that stores Form Session Properties in XML format.
</short>
<descr>
<p>In this unit you can find an implementation of a name/value pair storage container in XML format.</p>
<p>This container will get the Form's Session Properties that you setup in <link id="#LCL.Forms.TForm">TForm.SessionProperties</link> and read/write them on the file you specify on <link id="#LCL.XmlPropStorage.TXMLPropStorage.FileName">TXMLPropStorage.FileName</link>.</p>
<p>
In this unit you can find an implementation of a name/value pair storage container in XML format.
</p>
<p>
This container will get the Form's Session Properties that you setup in <link id="#LCL.Forms.TForm">TForm.SessionProperties</link> and read/write them on the file you specify on <link id="#LCL.XmlPropStorage.TXMLPropStorage.FileName">TXMLPropStorage.FileName</link>.
</p>
</descr>
<!-- unresolved type references -->
@ -29,7 +35,9 @@
<!-- object Visibility: default -->
<element name="TPropStorageXMLConfig">
<short>Wrapper class around <url href="http://wiki.freepascal.org/xmlconf">XMLConf</url>.<url href="http://wiki.freepascal.org/TXMLConfig">TXMLConfig</url>.</short>
<short>
Wrapper class around <url href="http://wiki.freepascal.org/xmlconf">XMLConf</url>.<url href="http://wiki.freepascal.org/TXMLConfig">TXMLConfig</url>.
</short>
<descr />
<errors />
<seealso />
@ -84,7 +92,9 @@
<!-- object Visibility: default -->
<element name="TCustomXMLPropStorage">
<short>Implements the base class for the XML Form's Session Properties Storage.</short>
<short>
Implements the base class for the XML Form's Session Properties Storage.
</short>
<descr />
<errors />
<seealso />
@ -135,7 +145,9 @@
<!-- function result Visibility: default -->
<element name="TCustomXMLPropStorage.GetXMLFileName.Result">
<short>The current value of the property <link id="#LCL.XmlPropStorage.TCustomXMLPropStorage.FileName">TCustomXMLPropStorage.FileName</link>.</short>
<short>
The current value of the property <link id="#LCL.XmlPropStorage.TCustomXMLPropStorage.FileName">TCustomXMLPropStorage.FileName</link>.
</short>
</element> <!-- function result TCustomXMLPropStorage.GetXMLFileName.Result -->
<!-- function Visibility: protected -->
@ -153,7 +165,9 @@
<!-- function Visibility: protected -->
<element name="TCustomXMLPropStorage.FixPath">
<short>Turns '.' notation into '/' notation for the xpath-like implementation in <url href="http://wiki.freepascal.org/xmlconf">XMLConf</url>.</short>
<short>
Turns '.' notation into '/' notation for the XPATH-like implementation in <url href="http://wiki.freepascal.org/xmlconf">XMLConf</url>.
</short>
<descr />
<errors />
<seealso />
@ -171,7 +185,9 @@
<!-- property Visibility: protected -->
<element name="TCustomXMLPropStorage.XMLConfig">
<short>Property to access the <link id="#LCL.XmlPropStorage.TPropStorageXMLConfig">TPropStorageXMLConfig</link>.</short>
<short>
Property to access the <link id="#LCL.XmlPropStorage.TPropStorageXMLConfig">TPropStorageXMLConfig</link>.
</short>
<descr />
<seealso />
</element> <!-- property TCustomXMLPropStorage.XMLConfig -->
@ -227,7 +243,9 @@
<!-- procedure Visibility: public -->
<element name="TCustomXMLPropStorage.DoWriteString">
<short>Implements the actual writing of a value from the underlying storage container.</short>
<short>
Implements writing of a string value to the underlying storage container.
</short>
<descr />
<errors />
<seealso />
@ -263,7 +281,9 @@
<!-- property Visibility: public -->
<element name="TCustomXMLPropStorage.FileName">
<short>Name of the file where the property data is saved in XML format.</short>
<short>
Name of the file where the property data is saved in XML format.
</short>
<descr />
<seealso />
</element> <!-- propert TCustomXMLPropStorage.FileName -->
@ -277,7 +297,9 @@
<!-- object Visibility: default -->
<element name="TXMLPropStorage">
<short>Implements the final class for the XML Form Session Properties storage.</short>
<short>
Implements a class for XML Form Session Properties storage.
</short>
<descr />
<errors />
<seealso>
@ -349,7 +371,7 @@
<element name="TXMLConfigStorage">
<short>
Implements a configation storage mechanism using XML-tagged content.
Implements a configuration storage mechanism using XML-tagged content.
</short>
<descr>
<p>
@ -384,7 +406,9 @@
<!-- protected -->
<element name="TXMLConfigStorage.GetFullPathValue">
<short>Gets the String value stored at the specified path in the XML storage.</short>
<short>
Gets the String value stored at the specified path in the XML storage.
</short>
<descr>
<p>
Calls the GetValue method for the internal TXMLConfig instance.
@ -401,7 +425,9 @@
<short>Path to the XML node with the requested value.</short>
</element>
<element name="TXMLConfigStorage.GetFullPathValue.ADefault">
<short>Default value returned if APath is not found in the internal storage.</short>
<short>
Default value returned if APath is not found in the internal storage.
</short>
</element>
<element name="TXMLConfigStorage.SetFullPathValue">
@ -431,7 +457,9 @@
</element>
<element name="TXMLConfigStorage.DeleteFullPath">
<short>Deletes the XML node and its content and the specified path.</short>
<short>
Deletes the XML node and its content and the specified path.
</short>
<descr/>
<seealso/>
</element>
@ -468,7 +496,7 @@
<var>Create</var> is the overridden, overloaded constructor for the class instance. The overloaded variants allow the XML content to read from various sources like a file name, a TXMLConfig instance, a scoped TXMLConfig instance, or a TStream instance.
</p>
<p>
Use WriteToDisk or SaveToStream to speciy where the XML content is stored .
Use WriteToDisk or SaveToStream to specify where the XML content is stored .
</p>
</descr>
<seealso/>
@ -482,13 +510,19 @@
</short>
</element>
<element name="TXMLConfigStorage.Create.TheXMLConfig">
<short>TXMLConfig instance where the XML paths and values are stored.</short>
<short>
TXMLConfig instance where the XML paths and values are stored.
</short>
</element>
<element name="TXMLConfigStorage.Create.StartPath">
<short>Intial path for values read and written in the class instance.</short>
<short>
Initial path for values read and written in the class instance.
</short>
</element>
<element name="TXMLConfigStorage.Create.s">
<short>Stream with the XML content loaded in the XMLConfig storage.</short>
<short>
Stream with the XML content loaded in the XMLConfig storage.
</short>
</element>
<element name="TXMLConfigStorage.Destroy">
@ -509,7 +543,9 @@
</element>
<element name="TXMLConfigStorage.XMLConfig">
<short>TXMLConfig with the values accessed and maintained in the class instance.</short>
<short>
TXMLConfig with the values accessed and maintained in the class instance.
</short>
<descr>
Read-only TXMLConfig property.
</descr>
@ -544,7 +580,9 @@
</element>
<element name="TXMLConfigStorage.SaveToStream">
<short>Saves the content in XMLConfig to the specified TStream instance.</short>
<short>
Saves the content in XMLConfig to the specified TStream instance.
</short>
<descr/>
<seealso/>
</element>
@ -554,7 +592,9 @@
<!-- procedure Visibility: default -->
<element name="Register">
<short>Registers <link id="#LCL.XmlPropStorage.TXMLPropStorage">TXMLPropStorage</link> on the 'Misc' tab of the component palette.</short>
<short>
Registers <link id="#LCL.XmlPropStorage.TXMLPropStorage">TXMLPropStorage</link> on the 'Misc' tab of the component palette.
</short>
<descr />
<errors />
<seealso />