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

FPDoc - several updates, additions and links for TextStrings.xml; minor changes to Themes .xml

Browse Source 
git-svn-id: trunk@18222 -
This commit is contained in:
kirkpatc 2009-01-09 14:51:45 +00:00
parent eae600b56a
commit d77400a729
2 changed files with 449 additions and 629 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

660
docs/xml/lcl/textstrings.xml
View File

@ -1,634 +1,454 @@
<?xml version="1.0" encoding="ISO8859-1"?> <?xml version="1.0"?>
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lcl">
<!-- <!--
==================================================================== ====================================================================
TextStrings TextStrings
==================================================================== ====================================================================
--> -->
<module name="TextStrings"> <module name="TextStrings">
<short></short> <short>
<descr> <var>TTextStrings</var> describes a TStrings descendant that is optimized for handling the complete text as whole (instead of line by line)</short>
</descr> <descr/>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->
<element name="Classes"> <element name="Classes">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->
<element name="SysUtils"> <element name="SysUtils">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- unresolved type reference Visibility: default --> <!-- unresolved type reference Visibility: default -->
<element name="LCLStrConsts"> <element name="LCLStrConsts">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- record type Visibility: default --> <!-- record type Visibility: default -->
<element name="TTextLineRange"> <element name="TTextLineRange">
<short></short> <short>
<descr> <var>TTextLineRange</var> - record structure showing start and end of line in text, the line as a string, and any user data</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- variable Visibility: default --> <!-- variable Visibility: default -->
<element name="TTextLineRange.StartPos"> <element name="TTextLineRange.StartPos">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: default --> <!-- variable Visibility: default -->
<element name="TTextLineRange.EndPos"> <element name="TTextLineRange.EndPos">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: default --> <!-- variable Visibility: default -->
<element name="TTextLineRange.Line"> <element name="TTextLineRange.Line">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: default --> <!-- variable Visibility: default -->
<element name="TTextLineRange.TheObject"> <element name="TTextLineRange.TheObject">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TTextStrings"> <element name="TTextStrings">
<short></short> <short>
<descr> <var>TTextStrings</var> a TStrings descendant that is optimized for handling the complete text as whole (instead of line by line as in <var>TStringList</var>)</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TTextStrings.FOnChange"> <element name="TTextStrings.FOnChange">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TTextStrings.FOnChanging"> <element name="TTextStrings.FOnChanging">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FArraysValid"> <element name="TTextStrings.FArraysValid">
<short></short> <short>
<descr> <var>FArraysValid</var> - local boolean flag to indicate whether arrays are valid</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FLineCount"> <element name="TTextStrings.FLineCount">
<short></short> <short>
<descr> <var>FLineCount</var> - local variable with number of lines</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FLineCapacity"> <element name="TTextStrings.FLineCapacity">
<short></short> <short>
<descr> <var>FLineCapacity</var> - local variable with capacity of lines</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FLineRanges"> <element name="TTextStrings.FLineRanges">
<short></short> <short>
<descr> <var>FLineRanges</var> - local variable, a pointer to an array of <var>TTextLineRange</var>
</descr> </short>
<seealso> <descr/>
</seealso> <seealso/>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FText"> <element name="TTextStrings.FText">
<short></short> <short>
<descr> <var>FText</var> - local variable holding the test string under consideration</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FUpdateCount"> <element name="TTextStrings.FUpdateCount">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- variable Visibility: protected --> <!-- variable Visibility: protected -->
<element name="TTextStrings.FChangedWhileUpdate"> <element name="TTextStrings.FChangedWhileUpdate">
<short></short> <short>
<descr> <var>FChangedWhileUpdate</var> - local flag to indicate whether there were changes during the update</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TTextStrings.GetTextStr"> <element name="TTextStrings.GetTextStr" link="#rtl.Classes.TStrings.GetTextStr">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.GetTextStr.Result"> <element name="TTextStrings.GetTextStr.Result">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.SetTextStr"> <element name="TTextStrings.SetTextStr" link="#rtl.Classes.TStrings.SetTextStr">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.SetTextStr.AValue"> <element name="TTextStrings.SetTextStr.AValue">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.BuildArrays"> <element name="TTextStrings.BuildArrays">
<short></short> <short>
<descr> <var>BuildArrays</var> - method for building arrays</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TTextStrings.GetCount"> <element name="TTextStrings.GetCount" link="#rtl.Classes.TStrings.GetCount">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.GetCount.Result"> <element name="TTextStrings.GetCount.Result">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.Changed"> <element name="TTextStrings.Changed">
<short></short> <short>
<descr> <var>Changed</var> - software emulation of <var>OnChange</var> event</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.Changing"> <element name="TTextStrings.Changing">
<short></short> <short>
<descr> <var>Changing</var> - software emulation of <var>OnChanging</var> event</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TTextStrings.Get"> <element name="TTextStrings.Get" link="#rtl.Classes.TStrings.Get">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.Get.Result"> <element name="TTextStrings.Get.Result">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Get.Index"> <element name="TTextStrings.Get.Index">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.ClearArrays"> <element name="TTextStrings.ClearArrays">
<short></short> <short>
<descr> <var>ClearArrays</var> - method for clearing arrays</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TTextStrings.GetObject"> <element name="TTextStrings.GetObject" link="#rtl.Classes.TStrings.GetObject">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.GetObject.Result"> <element name="TTextStrings.GetObject.Result">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.GetObject.Index"> <element name="TTextStrings.GetObject.Index">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.Put"> <element name="TTextStrings.Put" link="#rtl.Classes.TStrings.Put">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Put.Index"> <element name="TTextStrings.Put.Index">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Put.S"> <element name="TTextStrings.Put.S">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: protected --> <!-- procedure Visibility: protected -->
<element name="TTextStrings.PutObject"> <element name="TTextStrings.PutObject" link="#rtl.Classes.TStrings.PutObject">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.PutObject.Index"> <element name="TTextStrings.PutObject.Index">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.PutObject.AnObject"> <element name="TTextStrings.PutObject.AnObject">
<short></short> <short/>
</element> </element>
<!-- function Visibility: protected --> <!-- function Visibility: protected -->
<element name="TTextStrings.GetLineLen"> <element name="TTextStrings.GetLineLen">
<short></short> <short>
<descr> <var>GetLineLen</var> - returns length of indexed line (including new characters if boolean flag set True)</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.GetLineLen.Result"> <element name="TTextStrings.GetLineLen.Result">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.GetLineLen.Index"> <element name="TTextStrings.GetLineLen.Index">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.GetLineLen.IncludeNewLineChars"> <element name="TTextStrings.GetLineLen.IncludeNewLineChars">
<short></short> <short/>
</element> </element>
<!-- destructor Visibility: public --> <!-- destructor Visibility: public -->
<element name="TTextStrings.Destroy"> <element name="TTextStrings.Destroy" link="#rtl.Classes.TStrings.Destroy">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.Clear"> <element name="TTextStrings.Clear" link="#rtl.Classes.TStrings.Clear">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.SetText"> <element name="TTextStrings.SetText" link="#rtl.Classes.TStrings.SetText">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.SetText.TheText"> <element name="TTextStrings.SetText.TheText">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.Insert"> <element name="TTextStrings.Insert" link="#rtl.Classes.TStrings.Insert">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Insert.Index"> <element name="TTextStrings.Insert.Index">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Insert.S"> <element name="TTextStrings.Insert.S">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.Delete"> <element name="TTextStrings.Delete" link="#rtl.Classes.TStrings.Delete">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Delete.Index"> <element name="TTextStrings.Delete.Index">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.Exchange"> <element name="TTextStrings.Exchange" link="#rtl.Classes.TStrings.Exchange">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Exchange.Index1"> <element name="TTextStrings.Exchange.Index1">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Exchange.Index2"> <element name="TTextStrings.Exchange.Index2">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.Move"> <element name="TTextStrings.Move" link="#rtl.Classes.TStrings.Move">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Move.CurIndex"> <element name="TTextStrings.Move.CurIndex">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Move.NewIndex"> <element name="TTextStrings.Move.NewIndex">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.MakeTextBufferUnique"> <element name="TTextStrings.MakeTextBufferUnique">
<short></short> <short>
<descr> <var>MakeTextBufferUnique</var> - makes the current text buffer unique</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.BeginUpdate"> <element name="TTextStrings.BeginUpdate" link="#rtl.Classes.TStrings.BeginUpdate">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.EndUpdate"> <element name="TTextStrings.EndUpdate" link="#rtl.Classes.TStrings.EndUpdate">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TTextStrings.GetText"> <element name="TTextStrings.GetText" link="#rtl.Classes.TStrings.GetText">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.GetText.Result"> <element name="TTextStrings.GetText.Result">
<short></short> <short/>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TTextStrings.IndexOf"> <element name="TTextStrings.IndexOf" link="#rtl.Classes.TStrings.IndexOf">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.IndexOf.Result"> <element name="TTextStrings.IndexOf.Result">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.IndexOf.S"> <element name="TTextStrings.IndexOf.S">
<short></short> <short/>
</element> </element>
<!-- function Visibility: public --> <!-- function Visibility: public -->
<element name="TTextStrings.Add"> <element name="TTextStrings.Add" link="#rtl.Classes.TStrings.Add">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- function result Visibility: default --> <!-- function result Visibility: default -->
<element name="TTextStrings.Add.Result"> <element name="TTextStrings.Add.Result">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.Add.S"> <element name="TTextStrings.Add.S">
<short></short> <short/>
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TTextStrings.AddStrings"> <element name="TTextStrings.AddStrings" link="#rtl.Classes.TStrings.AddStrings">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors>
<seealso>
</seealso>
</element> </element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TTextStrings.AddStrings.TheStrings"> <element name="TTextStrings.AddStrings.TheStrings">
<short></short> <short/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TTextStrings.Text"> <element name="TTextStrings.Text" link="#rtl.Classes.TStrings.Text">
<short></short> <short/>
<descr> <descr/>
</descr> <seealso/>
<seealso>
</seealso>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TTextStrings.OnChange"> <element name="TTextStrings.OnChange">
<short></short> <short>
<descr> <var>OnChange</var> - event handler for a change in the data or text</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TTextStrings.OnChanging"> <element name="TTextStrings.OnChanging">
<short></short> <short>
<descr> <var>OnChanging</var> - event handler for use while the data or text are changing</short>
</descr> <descr/>
<seealso> <seealso/>
</seealso>
</element> </element>
</module> <!-- TextStrings --> </module>
<!-- TextStrings -->
</package> </package>
</fpdoc-descriptions> </fpdoc-descriptions>

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

@ -9,7 +9,7 @@
--> -->
<module name="Themes"> <module name="Themes">
<short></short> <short>For manipulation of display Themes, mostly in a Windows XP (and later) environment</short>
<descr> <descr>
</descr> </descr>