View Issue Details

IDProjectCategoryView StatusLast Update
0037494LazarusDocumentationpublic2020-08-11 15:39
ReporterDon Siders Assigned ToJuha Manninen  
PrioritynormalSeverityminorReproducibilityN/A
Status closedResolutionfixed 
Product Version2.1 (SVN) 
Summary0037494: Documentation updates for LCL, LazUtils
DescriptionLCL
===

lcl/buttonpanel.xml
* Added topic: TCustomButtonPanel.Loaded

lcl/buttons.xml
* Added topic: TCustomBitBtn.SetDefaultCaption
* Grammar/spelling fixes

lcl/forms.xml
* Added content to topic: TCustomForm.Activate
* Grammar/spelling fixes

LazUtils
========

lazutils/lazutils.xml
* Added missing topic: Register
* Updated external references

lazutils/lconvencoding.xml
* Removed text outside of topic or element tag
* Updated external references

Added topic files/skeletons for new units:
* lazutils/codepagesasian.xml
* lazutils/codepagescommon.xml

See attached files.
TagsNo tags attached.
Fixed in Revisionr63716
LazTarget-
Widgetset
Attached Files

Activities

Don Siders

2020-08-05 22:56

reporter  

buttonpanel.xml.diff (1,760 bytes)   
Index: docs/xml/lcl/buttonpanel.xml
===================================================================
--- docs/xml/lcl/buttonpanel.xml	(revision 63692)
+++ docs/xml/lcl/buttonpanel.xml	(working copy)
@@ -615,6 +615,28 @@
         <short></short>
       </element>
 
+      <element name="TCustomButtonPanel.Loaded">
+        <short>
+          Performs actions after the component has finished loading during LCL streaming
+        </short>
+        <descr>
+          <p>
+            <var>Loaded</var> is an overridden method in <var>TCustomButtonPanel</var>, and calls the inherited method on entry.
+          </p>
+          <p>
+            Loaded ensures that glyphs for panel buttons are either assigned or cleared based on the value in the <var>ShowGlyphs</var> property. When ShowGlyphs is <b>True</b>, each of the button instances is given the corresponding value in the internal list of glyphs for the class instance. Otherwise, the glyph is set to <b>Nil</b> to suppress display of the graphic image on the button. These are the same actions performed when the value in the ShowGlyph property is changed.
+          </p>
+          <p>
+            Please note: <var>AutoSize</var> is temporarily disabled in the control while assigning the button glyphs, and re-enabled prior to exit.
+          </p>
+        </descr>
+        <seealso>
+          <link id="TCustomButtonPanel.ShowGlyphs"/>
+          <link id="#lcl.controls.TControl.AutoSize"/>
+          <link id="#lcl.extctrls.TCustomPanel.Loaded"/>
+        </seealso>
+      </element>
+
       <element name="TCustomButtonPanel.Notification" link="#rtl.Classes.TComponent.Notification"/>
       <element name="TCustomButtonPanel.Notification.AComponent">
         <short></short>
buttonpanel.xml.diff (1,760 bytes)   
buttons.xml.diff (3,868 bytes)   
Index: docs/xml/lcl/buttons.xml
===================================================================
--- docs/xml/lcl/buttons.xml	(revision 63692)
+++ docs/xml/lcl/buttons.xml	(working copy)
@@ -1078,8 +1078,30 @@
         <short>True if the default values for properties are used in the control</short>
       </element>
 
+      <element name="TCustomBitBtn.SetDefaultCaption">
+        <short>Sets the value for the DefaultCaption property</short>
+        <descr>
+          <p>
+            <var>SetDefaultCaption</var> is the write access specifier for the <var>DefaultCaption</var> property. <var>AValue</var> contains the new value assigned to the property.
+          </p>
+          <p>
+            When <var>AValue</var> is <b>True</b>, and <var>Kind</var> contains a value other than <var>bkCustom</var>, the <var>Caption</var> property is updated to use the value returned from <var>GetCaptionOfKind</var>. This also causes the <var>TextChanged</var> method to be called when the Caption property is updated.
+          </p>
+        </descr>
+        <seealso>
+          <link id="TCustomBitBtn.DefaultCaption"/>
+          <link id="TCustomBitBtn.Caption"/>
+          <link id="TCustomBitBtn.Kind"/>
+          <link id="TCustomBitBtn.GetCaptionOfKind"/>
+          <link id="TCustomBitBtn.TextChanged"/>
+        </seealso>
+      </element>
+      <element name="TCustomBitBtn.SetDefaultCaption.AValue">
+        <short>New value for the property</short>
+      </element>
+
       <element name="TCustomBitBtn.GetCaptionOfKind">
-        <short>Gets the default value for the Caption used for the button Kind</short>
+        <short>Gets the default Caption value for the button Kind</short>
         <descr></descr>
         <seealso>
         </seealso>
@@ -1359,7 +1381,7 @@
         <short>Contains the descriptive text displayed for the Bitmap button control</short>
         <descr>
           <p>
-            <var>Caption</var> is a public <var>TCaption</var> property which contains the descriptive text displayed for the Bitmap button control. Assign a value to Caption when the <var>Kind</var> property is set to <var>bkCustom</var>. When Kind contains one of the other <var>TBtiBtnKind</var> enumeration values, the Caption is normally set using the <var>GetCaptionOfKind</var> method.
+            <var>Caption</var> is a public <var>TCaption</var> property which contains the descriptive text displayed for the Bitmap button control. Assign a value to Caption when the <var>Kind</var> property is set to <var>bkCustom</var>. When Kind contains one of the other <var>TBitBtnKind</var> enumeration values, the Caption is normally set using the <var>GetCaptionOfKind</var> method.
           </p>
           <p>
             Use <var>DefaultCaption</var> to determine if the value in Caption is the default one for the control.
@@ -1373,7 +1395,7 @@
       </element>
 
       <element name="TCustomBitBtn.DefaultCaption">
-        <short>Indicates if Caption contains a default value</short>
+        <short>Indicates if Caption contains the default value for the button Kind</short>
         <descr></descr>
         <seealso>
           <link id="TCustomBitBtn.Caption"/>
@@ -1503,7 +1525,7 @@
 
       <element name="TBitBtn.Cancel" link="#LCL.StdCtrls.TCustomButton.Cancel">
         <descr>
-          <p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</p>
+          <p>Setting this property to True, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</p>
         </descr>
       </element>
 
buttons.xml.diff (3,868 bytes)   
forms.xml.diff (4,559 bytes)   
Index: docs/xml/lcl/forms.xml
===================================================================
--- docs/xml/lcl/forms.xml	(revision 63692)
+++ docs/xml/lcl/forms.xml	(working copy)
@@ -2528,14 +2528,33 @@
       </element>
       <element name="TCustomForm.Activate">
         <short>Notifies the OnActivate handler</short>
-        <descr/>
-        <seealso/>
+        <descr>
+          <p>
+            <var>Activate</var> is a procedure used to signal the <var>OnActivate</var> event handler (if  assigned) when the form is activated. Activate is called when the <b>CM_Activate</b> message is handled for the form.
+          </p>
+          <p>
+            Activate uses an internal member to determine whether the form is being displayed for the first time, or following a change of focus between forms. No actions are performed in the method when the form is being displayed for the first time and the <var>WindowState</var> property contains <var>wsMaximized</var> or <var>wsFullScreen</var>.
+          </p>
+          <p>
+            Use <var>OnShow</var> to respond to the event notification performed when the form is displayed for the first time.
+          </p>
+          <p>
+            Use <var>OnChangeBounds</var> or <var>OnResize</var> to respond to delayed changes to the form bounds (position) or resize events.
+          </p>
+        </descr>
+        <seealso>
+          <link id="TCustomForm.OnActivate"/>
+          <link id="TCustomForm.OnShow"/>
+          <link id="TCustomForm.OnChangeBounds"/>
+          <link id="TCustomForm.OnResize"/>
+          <link id="TCustomForm.WindowState"/>
+        </seealso>
       </element>
       <element name="TCustomForm.ActiveChanged">
         <short>An empty implementation in TCustomForm</short>
         <descr>
-          Just like VCL.
           Can be implemented in a descendant to perform actions needed when the active form is changed.
+          Just like Delphi VCL.
         </descr>
         <seealso/>
       </element>
@@ -2560,7 +2579,6 @@
       <element name="TCustomForm.ColorIsStored.Result">
         <short/>
       </element>
-      <!-- procedure Visibility: protected -->
       <element name="TCustomForm.CreateParams" link="#LCL.Controls.TWinControl.CreateParams">
         <short>Initializes parameters used to create the handle for the form instance</short>
         <descr>
@@ -2568,7 +2586,7 @@
             <var>CreateParams</var> is used to initialize parameters needed to create the handle for the form instance.
           </p>
           <p>
-            CreateParams is an overridden procedure in TCustomForm, and calls the inherited method on entry. CreateParams ensures that values in the Params argument are valid. This includes setting the realized parent form and window handle for forms which are not the main form in the application. Style flags are also updated to indicate how the form is displayed in the task bar.
+            CreateParams is an overridden procedure in <var>TCustomForm</var>, and calls the inherited method on entry. CreateParams ensures that values in the <var>Params</var> argument are valid. This includes setting the realized parent form and window handle for a form which is  not the main form in the application. <var>Style</var> flags are also updated to indicate how the form is displayed in the task bar.
           </p>
         </descr>
         <seealso>
@@ -2686,10 +2704,13 @@
       </element>
       <element name="TCustomForm.ChildHandlesCreated">
         <short>
-          Called after all child control handles are created. When this is a
-          top level form (Parent=Nil) also invokes ParentFormHandleInitialized.
+          Called when handles for child control are created in the form instance
         </short>
-        <descr/>
+        <descr>
+          <p>
+            ChildHandlesCreated is called after all handles for child controls are created. When this is a top-level form (<var>Parent</var> is Nil),  the ParentFormHandleInitialized method is also called.
+          </p>
+        </descr>
         <seealso>
           <link id="#LCL.Controls.TWinControl.ChildHandlesCreated">TWinControl.ChildHandlesCreated</link>
         </seealso>
@@ -2764,7 +2785,7 @@
         <short/>
       </element>
       <element name="TCustomForm.MoveToDefaultPosition" link="TCustomForm.Position">
-        <short>Moves the form to the initial Position</short>
+        <short>Moves the form to its initial Position</short>
         <descr>
         </descr>
         <seealso>
forms.xml.diff (4,559 bytes)   
lazutils.xml.diff (3,699 bytes)   
Index: docs/xml/lazutils/lazutils.xml
===================================================================
--- docs/xml/lazutils/lazutils.xml	(revision 63692)
+++ docs/xml/lazutils/lazutils.xml	(working copy)
@@ -1,13 +1,91 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <fpdoc-descriptions>
-<package name="lazutils">
-<short>Lazutils</short>
-<descr>
-<p>
-The Lazutils package contains basic non visual stuff, needed by the LCL and
-other packages.
-Historically some units originated from the LCL and the codetools.
-</p>
-</descr>
-</package>
+  <package name="lazutils">
+
+    <module name="lazutils">
+      <short>LazUtils</short>
+      <descr>
+        <p>
+          <file>LazUtils</file> contains non-visual routines, types, and classes needed by the LCL and other packages. Historically, some units originated from the LCL and the CodeTools used in the Lazarus IDE.
+        </p>
+        <p>
+          This unit contains code in the initialization section to register the <file>lazutils</file> package for use in the Lazarus IDE.
+        </p>
+      </descr>
+
+      <!-- unresolved external references -->
+      <element name="AvgLvlTree"/>
+      <element name="DynamicArray"/>
+      <element name="DynHashArray"/>
+      <element name="DynQueue"/>
+      <element name="ExtendedStrings"/>
+      <element name="FileUtil"/>
+      <element name="FPCAdds"/>
+      <element name="Laz2_DOM"/>
+      <element name="Laz2_XMLCfg"/>
+      <element name="laz2_XMLRead"/>
+      <element name="laz2_xmlutils"/>
+      <element name="laz2_XMLWrite"/>
+      <element name="laz2_xpath"/>
+      <element name="Laz_DOM"/>
+      <element name="Laz_XMLCfg"/>
+      <element name="Laz_XMLRead"/>
+      <element name="Laz_XMLStreaming"/>
+      <element name="Laz_XMLWrite"/>
+      <element name="LazClasses"/>
+      <element name="lazCollections"/>
+      <element name="LazConfigStorage"/>
+      <element name="LazDbgLog"/>
+      <element name="lazfglhash"/>
+      <element name="LazFileCache"/>
+      <element name="LazFileUtils"/>
+      <element name="LazLinkedList"/>
+      <element name="LazListClasses "/>
+      <element name="LazLogger"/>
+      <element name="LazLoggerBase"/>
+      <element name="LazLoggerDummy"/>
+      <element name="LazLoggerProfiling"/>
+      <element name="LazMethodList"/>
+      <element name="LazUnicode"/>
+      <element name="LazUTF16"/>
+      <element name="LazUTF8"/>
+      <element name="LazUTF8Classes"/>
+      <element name="LazSysUtils"/>
+      <element name="LazUtilities"/>
+      <element name="LazUtilsStrConsts"/>
+      <element name="LConvEncoding"/>
+      <element name="lcsvutils"/>
+      <element name="LookupStringList"/>
+      <element name="Maps"/>
+      <element name="Masks"/>
+      <element name="PasWString"/>
+      <element name="StringHashList"/>
+      <element name="TextStrings"/>
+      <element name="Translations"/>
+      <element name="UTF8Process"/>
+      <element name="HTML2TextRender"/>
+      <element name="Laz_AVL_Tree"/>
+      <element name="CompWriterPas"/>
+      <element name="LazPasReadUtil"/>
+      <element name="IntegerList"/>
+      <element name="LazVersion"/>
+      <element name="UITypes"/>
+      <element name="GraphType"/>
+      <element name="LazTracer"/>
+      <element name="LazStringUtils"/>
+      <element name="LazUTF8SysUtils"/>
+      <element name="ObjectLists"/>
+      <element name="CodepagesAsian"/>
+      <element name="CodepagesCommon"/>
+      <element name="LazarusPackageIntf"/>
+
+      <element name="Register">
+        <short/>
+        <descr/>
+        <seealso/>
+      </element>
+
+    </module>
+
+  </package>
 </fpdoc-descriptions>
lazutils.xml.diff (3,699 bytes)   
lconvencoding.xml.diff (815 bytes)   
Index: docs/xml/lazutils/lconvencoding.xml
===================================================================
--- docs/xml/lazutils/lconvencoding.xml	(revision 63692)
+++ docs/xml/lazutils/lconvencoding.xml	(working copy)
@@ -24,6 +24,8 @@
       <element name="Classes"/>
       <element name="Dos"/>
       <element name="LazUTF8"/>
+      <element name="CodepagesCommon"/>
+      <element name="CodepagesAsian"/>
       <element name="iconvenc"/>
 
       <element name="TConvertEncodingErrorMode">
@@ -44,9 +46,6 @@
         <short/>
       </element>
 
-      //Global variable which controls behaviour of encoding conversion error, in 3 places:
-      ConvertEncodingErrorMode: TConvertEncodingErrorMode = ceemSkip;
-
       <element name="ConvertEncodingErrorMode">
         <short/>
         <descr>
lconvencoding.xml.diff (815 bytes)   
codepagesasian.xml (2,450 bytes)   
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lazutils">

    <module name="codepagesasian">
      <short>Contains Unicode conversion tables for asian code pages</short>
      <descr></descr>

      <element name="CP936Arr">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP950Arr">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP949Arr">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP932Arr">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP936CC">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni936C">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP936CU">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni936U">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP950CC">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni950C">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP950CU">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni950U">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP949CC">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni949C">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP949CU">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni949U">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP932CC">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni932C">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="CP932CU">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="Uni932U">
        <short/>
        <descr/>
        <seealso/>
      </element>

    </module>

  </package>
</fpdoc-descriptions>
codepagesasian.xml (2,450 bytes)   
codepagescommon.xml (2,986 bytes)   
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
  <package name="lazutils">

    <module name="codepagescommon">
      <short>Contains Unicode conversion tables for common code pages</short>
      <descr></descr>

      <element name="TCharToUTF8Table">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayISO_8859_1ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayISO_8859_15ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayISO_8859_2ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1250ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1251ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1252ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1253ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1254ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1255ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1256ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1257ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP1258ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP437ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP850ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP852ToUTF8">
        <short/>
        <descr>
          ftp://ftp.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/PC/CP852.TXT
        </descr>
        <seealso/>
      </element>

      <element name="ArrayCP866ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayCP874ToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayKOI8RToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayKOI8UToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayKOI8RUToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

      <element name="ArrayMacintoshToUTF8">
        <short/>
        <descr/>
        <seealso/>
      </element>

    </module>

  </package>
</fpdoc-descriptions>
codepagescommon.xml (2,986 bytes)   

Juha Manninen

2020-08-11 11:42

developer   ~0124748

Applied, thanks.

Issue History

Date Modified Username Field Change
2020-08-05 22:56 Don Siders New Issue
2020-08-05 22:56 Don Siders File Added: buttonpanel.xml.diff
2020-08-05 22:56 Don Siders File Added: buttons.xml.diff
2020-08-05 22:56 Don Siders File Added: forms.xml.diff
2020-08-05 22:56 Don Siders File Added: lazutils.xml.diff
2020-08-05 22:56 Don Siders File Added: lconvencoding.xml.diff
2020-08-05 22:56 Don Siders File Added: codepagesasian.xml
2020-08-05 22:56 Don Siders File Added: codepagescommon.xml
2020-08-11 11:17 Juha Manninen Assigned To => Juha Manninen
2020-08-11 11:17 Juha Manninen Status new => assigned
2020-08-11 11:42 Juha Manninen Status assigned => resolved
2020-08-11 11:42 Juha Manninen Resolution open => fixed
2020-08-11 11:42 Juha Manninen Fixed in Revision => r63716
2020-08-11 11:42 Juha Manninen LazTarget => -
2020-08-11 11:42 Juha Manninen Note Added: 0124748
2020-08-11 15:39 Don Siders Status resolved => closed