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

added dynamicarray documentation from Marton Papp

Browse Source 
git-svn-id: trunk@8940 -
This commit is contained in:
vincents 2006-03-15 20:55:53 +00:00
parent cc3cbbe033
commit 0ee592fa18
3 changed files with 384 additions and 421 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitattributes vendored
View File

@ -745,6 +745,7 @@ docs/xml/lcl/spin.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/stdactns.xml svneol=LF#text/xml eol=lf docs/xml/lcl/stdactns.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/stdctrls.xml svneol=LF#text/xml eol=lf docs/xml/lcl/stdctrls.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/stringhashlist.xml svneol=LF#text/xml eol=lf docs/xml/lcl/stringhashlist.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/tarrayexample.pas svneol=native#text/plain
docs/xml/lcl/textstrings.xml svneol=LF#text/xml eol=lf docs/xml/lcl/textstrings.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/toolwin.xml svneol=LF#text/xml eol=lf docs/xml/lcl/toolwin.xml svneol=LF#text/xml eol=lf
docs/xml/lcl/translations.xml svneol=LF#text/xml eol=lf docs/xml/lcl/translations.xml svneol=LF#text/xml eol=lf

731
docs/xml/lcl/dynamicarray.xml
View File

@ -1,426 +1,315 @@
<?xml version="1.0" encoding="ISO8859-1"?> <?xml version="1.0"?>
<fpdoc-descriptions> <fpdoc-descriptions>
<package name="lcl"> <package name="lcl">
<!--
<!--
==================================================================== ====================================================================
DynamicArray DynamicArray
==================================================================== ====================================================================
--> -->
<module name="DynamicArray">
<module name="DynamicArray"> <short>It implements a resizable 2d array containing pointers.</short>
<short></short> <descr></descr>
<descr> <!-- unresolved type reference Visibility: default -->
</descr> <element name="Classes">
<short/>
<!-- unresolved type reference Visibility: default --> <descr/>
<element name="Classes"> <seealso/>
<short></short> </element>
<descr> <!-- unresolved type reference Visibility: default -->
</descr> <element name="SysUtils">
<seealso> <short/>
</seealso> <descr/>
</element> <seealso/>
</element>
<!-- unresolved type reference Visibility: default --> <!-- object Visibility: default -->
<element name="SysUtils"> <element name="EArray">
<short></short> <short/>
<descr> <descr/>
</descr> <errors/>
<seealso> <seealso/>
</seealso> </element>
</element> <!-- procedure type Visibility: default -->
<element name="TOnNotifyItem">
<!-- object Visibility: default --> <short>Type for event handling</short>
<element name="EArray"> <descr/>
<short></short> <seealso/>
<descr> </element>
</descr> <!-- argument Visibility: default -->
<errors> <element name="TOnNotifyItem.Sender">
</errors> <short>instance of the TArray that causes the event</short>
<seealso> </element>
</seealso> <!-- argument Visibility: default -->
</element> <element name="TOnNotifyItem.Col">
<short>The related Col of the event</short>
<!-- procedure type Visibility: default --> </element>
<element name="TOnNotifyItem"> <!-- argument Visibility: default -->
<short></short> <element name="TOnNotifyItem.Row">
<descr> <short>The related Row of the event</short>
</descr> </element>
<seealso> <!-- argument Visibility: default -->
</seealso> <element name="TOnNotifyItem.Item">
</element> <short>The related Item of the event</short>
</element>
<!-- argument Visibility: default --> <!-- procedure type Visibility: default -->
<element name="TOnNotifyItem.Sender"> <element name="TOnExchangeItem">
<short></short> <short></short>
</element> <descr/>
<seealso/>
<!-- argument Visibility: default --> </element>
<element name="TOnNotifyItem.Col"> <!-- argument Visibility: default -->
<short></short> <element name="TOnExchangeItem.Sender">
</element> <short>The instance of the TArray that causes the Exchange event</short>
</element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TOnNotifyItem.Row"> <element name="TOnExchangeItem.Index">
<short></short> <short/>
</element> </element>
<!-- argument Visibility: default -->
<!-- argument Visibility: default --> <element name="TOnExchangeItem.WithIndex">
<element name="TOnNotifyItem.Item"> <short/>
<short></short> </element>
</element> <!-- object Visibility: default -->
<element name="TArray">
<!-- procedure type Visibility: default --> <short>It implements a resizable 2d array.</short>
<element name="TOnExchangeItem"> <descr/>
<short></short> <errors/>
<descr> <seealso/>
</descr> </element>
<seealso> <!-- variable Visibility: private -->
</seealso> <element name="TArray.FCols">
</element> <short>It contains the first dimension of the array.</short>
<descr/>
<!-- argument Visibility: default --> <seealso/>
<element name="TOnExchangeItem.Sender"> </element>
<short></short> <!-- variable Visibility: private -->
</element> <element name="TArray.FOnDestroyItem">
<short>A user-defined function to be called when an item is destroyed.</short>
<!-- argument Visibility: default --> <descr>This can happen in ClearCol,Clear,SetLength</descr>
<element name="TOnExchangeItem.Index"> <seealso/>
<short></short> </element>
</element> <!-- variable Visibility: private -->
<element name="TArray.FOnNewItem">
<!-- argument Visibility: default --> <short>A user-defined function to be called when a new item is created.</short>
<element name="TOnExchangeItem.WithIndex"> <descr/>
<short></short> <seealso/>
</element> </element>
<!-- function Visibility: private -->
<!-- object Visibility: default --> <element name="TArray.Getarr">
<element name="TArray"> <short>Returns the stored item(actually pointer) in array</short>
<short></short> <descr/>
<descr> <errors/>
</descr> <seealso/>
<errors> </element>
</errors> <!-- function result Visibility: default -->
<seealso> <element name="TArray.Getarr.Result">
</seealso> <short>the stored item,pointer.</short>
</element> </element>
<!-- argument Visibility: default -->
<!-- variable Visibility: private --> <element name="TArray.Getarr.Col">
<element name="TArray.FCols"> <short>the first dimension of the array.</short>
<short></short> </element>
<descr> <!-- argument Visibility: default -->
</descr> <element name="TArray.Getarr.Row">
<seealso> <short>the second dimension of the array.</short>
</seealso> </element>
</element> <!-- procedure Visibility: private -->
<element name="TArray.Setarr">
<!-- variable Visibility: private --> <short>Sets an item in the array [col][row].</short>
<element name="TArray.FOnDestroyItem"> <descr/>
<short></short> <errors/>
<descr> <seealso/>
</descr> </element>
<seealso> <!-- argument Visibility: default -->
</seealso> <element name="TArray.Setarr.Col">
</element> <short>the first dimension of the array.</short>
</element>
<!-- variable Visibility: private --> <!-- argument Visibility: default -->
<element name="TArray.FOnNewItem"> <element name="TArray.Setarr.Row">
<short></short> <short>the second dimension of the array.</short>
<descr> </element>
</descr> <!-- argument Visibility: default -->
<seealso> <element name="TArray.Setarr.Avalue">
</seealso> <short>the value to be stored.</short>
</element> </element>
<!-- procedure Visibility: private -->
<!-- function Visibility: private --> <element name="TArray.ClearCol">
<element name="TArray.Getarr"> <short>Clears the given TList</short>
<short></short> <descr>The given TList is assumed to be the COL of the array.</descr>
<descr> <errors/>
</descr> <seealso/>
<errors> </element>
</errors> <!-- argument Visibility: default -->
<seealso> <element name="TArray.ClearCol.L">
</seealso> <short>Tlist to be cleared.</short>
</element> </element>
<!-- argument Visibility: default -->
<!-- function result Visibility: default --> <element name="TArray.ClearCol.Col">
<element name="TArray.Getarr.Result"> <short>the first dimension of the array.</short>
<short></short> </element>
</element> <!-- procedure Visibility: private -->
<element name="TArray.Aumentar_Rows">
<!-- argument Visibility: default --> <short>Extends a row to its new size(Rows)</short>
<element name="TArray.Getarr.Col"> <descr/>
<short></short> <errors/>
</element> <seealso/>
</element>
<!-- argument Visibility: default --> <!-- argument Visibility: default -->
<element name="TArray.Getarr.Row"> <element name="TArray.Aumentar_Rows.col">
<short></short> <short>current column</short>
</element> </element>
<!-- argument Visibility: default -->
<!-- procedure Visibility: private --> <element name="TArray.Aumentar_Rows.Rows">
<element name="TArray.Setarr"> <short>new row size</short>
<short></short> </element>
<descr> <!-- argument Visibility: default -->
</descr> <element name="TArray.Aumentar_Rows.L">
<errors> <short>The row to be operated on.</short>
</errors> </element>
<seealso> <!-- procedure Visibility: private -->
</seealso> <element name="TArray.DestroyItem">
</element> <short>event handler called when an item is destroyed.</short>
<descr/>
<!-- argument Visibility: default --> <errors/>
<element name="TArray.Setarr.Col"> <seealso/>
<short></short> </element>
</element> <!-- argument Visibility: default -->
<element name="TArray.DestroyItem.Col">
<!-- argument Visibility: default --> <short>the column of the destroyed item.</short>
<element name="TArray.Setarr.Row"> </element>
<short></short> <!-- argument Visibility: default -->
</element> <element name="TArray.DestroyItem.Row">
<short>the row of the destroyed item.</short>
<!-- argument Visibility: default --> </element>
<element name="TArray.Setarr.Avalue"> <!-- argument Visibility: default -->
<short></short> <element name="TArray.DestroyItem.P">
</element> <short>the item itself before it is unlinked.</short>
</element>
<!-- procedure Visibility: private --> <!-- constructor Visibility: public -->
<element name="TArray.ClearCol"> <element name="TArray.Create">
<short></short> <short></short>
<descr> <descr/>
</descr> <errors/>
<errors> <seealso/>
</errors> <example file="tarrayexample.pas" />
<seealso> </element>
</seealso> <!-- destructor Visibility: public -->
</element> <element name="TArray.Destroy">
<short></short>
<!-- argument Visibility: default --> <descr/>
<element name="TArray.ClearCol.L"> <errors/>
<short></short> <seealso/>
</element> <example file="tarrayexample.pas" />
</element>
<!-- argument Visibility: default --> <!-- procedure Visibility: public -->
<element name="TArray.ClearCol.Col"> <element name="TArray.SetLength">
<short></short> <short>Resizes the array.</short>
</element> <descr/>
<errors/>
<!-- procedure Visibility: private --> <seealso/>
<element name="TArray.Aumentar_Rows"> <example file="tarrayexample.pas" />
<short></short> </element>
<descr> <!-- argument Visibility: default -->
</descr> <element name="TArray.SetLength.Cols">
<errors> <short>new column size</short>
</errors> </element>
<seealso> <!-- argument Visibility: default -->
</seealso> <element name="TArray.SetLength.Rows">
</element> <short>new row size</short>
</element>
<!-- argument Visibility: default --> <!-- procedure Visibility: public -->
<element name="TArray.Aumentar_Rows.col"> <element name="TArray.DeleteColRow">
<short></short> <short>Deletes a column or a row of an array.</short>
</element> <descr/>
<errors/>
<!-- argument Visibility: default --> <seealso/>
<element name="TArray.Aumentar_Rows.Rows"> <example file="tarrayexample.pas" />
<short></short> </element>
</element> <!-- argument Visibility: default -->
<element name="TArray.DeleteColRow.IsColumn">
<!-- argument Visibility: default --> <short>Do you want to delete a column?</short>
<element name="TArray.Aumentar_Rows.L"> </element>
<short></short> <!-- argument Visibility: default -->
</element> <element name="TArray.DeleteColRow.Index">
<short>index of a row or a column</short>
<!-- procedure Visibility: private --> </element>
<element name="TArray.DestroyItem"> <!-- procedure Visibility: public -->
<short></short> <element name="TArray.MoveColRow">
<descr> <short>Moves a column to another column or a row to another row.</short>
</descr> <descr/>
<errors> <errors/>
</errors> <seealso/>
<seealso> <example file="tarrayexample.pas" />
</seealso> </element>
</element> <!-- argument Visibility: default -->
<element name="TArray.MoveColRow.IsColumn">
<!-- argument Visibility: default --> <short>Do you want to move a column?</short>
<element name="TArray.DestroyItem.Col"> </element>
<short></short> <!-- argument Visibility: default -->
</element> <element name="TArray.MoveColRow.FromIndex">
<short>source</short>
<!-- argument Visibility: default --> </element>
<element name="TArray.DestroyItem.Row"> <!-- argument Visibility: default -->
<short></short> <element name="TArray.MoveColRow.ToIndex">
</element> <short>destination</short>
</element>
<!-- argument Visibility: default --> <!-- procedure Visibility: public -->
<element name="TArray.DestroyItem.P"> <element name="TArray.ExchangeColRow">
<short></short> <short>Swaps two rows or two columns.</short>
</element> <descr/>
<errors/>
<!-- constructor Visibility: public --> <seealso/>
<element name="TArray.Create"> <example file="tarrayexample.pas" />
<short></short> </element>
<descr> <!-- argument Visibility: default -->
</descr> <element name="TArray.ExchangeColRow.IsColumn">
<errors> <short>Do you want to move a column?</short>
</errors> </element>
<seealso> <!-- argument Visibility: default -->
</seealso> <element name="TArray.ExchangeColRow.Index">
</element> <short>index of row or column</short>
</element>
<!-- destructor Visibility: public --> <!-- argument Visibility: default -->
<element name="TArray.Destroy"> <element name="TArray.ExchangeColRow.WithIndex">
<short></short> <short>index of row or column</short>
<descr> </element>
</descr> <!-- procedure Visibility: public -->
<errors> <element name="TArray.Clear">
</errors> <short>Removes all elements from the array.</short>
<seealso> <descr/>
</seealso> <errors/>
</element> <example file="tarrayexample.pas" />
<seealso/>
<!-- procedure Visibility: public --> </element>
<element name="TArray.SetLength"> <!-- property Visibility: public -->
<short></short> <element name="TArray.Arr">
<descr> <short>Reads/Writes an element from the array.</short>
</descr> <descr/>
<errors> <seealso/>
</errors> <example file="tarrayexample.pas" />
<seealso> </element>
</seealso> <!-- argument Visibility: default -->
</element> <element name="TArray.Arr.Col">
<short/>
<!-- argument Visibility: default --> </element>
<element name="TArray.SetLength.Cols"> <!-- argument Visibility: default -->
<short></short> <element name="TArray.Arr.Row">
</element> <short/>
</element>
<!-- argument Visibility: default --> <!-- property Visibility: public -->
<element name="TArray.SetLength.Rows"> <element name="TArray.OnDestroyItem">
<short></short> <short>User-defined function which is called when an item is destroyed.</short>
</element> <descr/>
<seealso/>
<!-- procedure Visibility: public --> </element>
<element name="TArray.DeleteColRow"> <!-- property Visibility: public -->
<short></short> <element name="TArray.OnNewItem">
<descr> <short>User-defined function which is called when an item is created.</short>
</descr> <descr/>
<errors> <descr/>
</errors> <seealso/>
<seealso> </element>
</seealso> </module>
</element> <!-- DynamicArray -->
</package>
<!-- argument Visibility: default -->
<element name="TArray.DeleteColRow.IsColumn">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TArray.DeleteColRow.Index">
<short></short>
</element>
<!-- procedure Visibility: public -->
<element name="TArray.MoveColRow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArray.MoveColRow.IsColumn">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TArray.MoveColRow.FromIndex">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TArray.MoveColRow.ToIndex">
<short></short>
</element>
<!-- procedure Visibility: public -->
<element name="TArray.ExchangeColRow">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArray.ExchangeColRow.IsColumn">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TArray.ExchangeColRow.Index">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TArray.ExchangeColRow.WithIndex">
<short></short>
</element>
<!-- procedure Visibility: public -->
<element name="TArray.Clear">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TArray.Arr">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TArray.Arr.Col">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TArray.Arr.Row">
<short></short>
</element>
<!-- property Visibility: public -->
<element name="TArray.OnDestroyItem">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TArray.OnNewItem">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module> <!-- DynamicArray -->
</package>
</fpdoc-descriptions> </fpdoc-descriptions>

73
docs/xml/lcl/tarrayexample.pas Normal file
View File

@ -0,0 +1,73 @@
program tarrayexample;
{$mode objfpc}{$H+}
uses
{$IFDEF UNIX}{$IFDEF UseCThreads}
cthreads,
{$ENDIF}{$ENDIF}
Classes
{ add your units here },strings,DynamicArray;
type
Tarrayexampleclass=class
private
procedure doDestroyItem(Sender: Tobject; Col,Row: Integer;var Item: Pointer);
end;
procedure Tarrayexampleclass.doDestroyItem(Sender: Tobject; Col,Row: Integer;
var Item: Pointer);
begin
strdispose(Item);
end;
var FCols: Tarray;
var ex:Tarrayexampleclass;
begin
FCols:= TArray.Create;
ex:= Tarrayexampleclass.Create;
FCols.OnDestroyItem:=@ex.doDestroyItem;
FCols.SetLength(8,8);
//FCols.OnNewItem:=@doNewItem;
FCols.arr[0,0]:=StrNew('string1');
FCols.arr[4,7]:=StrNew('string2');
FCols.arr[4,3]:=StrNew('string3');
writeln('0,0:'+Pchar(FCols.arr[0,0]));
writeln('4,7:'+Pchar(FCols.arr[4,7]));
FCols.MoveColRow(true,4,5);
writeln('after moving column 4 to 5');
writeln('5,7:'+Pchar(FCols.arr[5,7]));
writeln('before exchanging row 7 and 3:');
writeln('5,3:'+Pchar(FCols.arr[5,3]));
writeln('5,7:'+Pchar(FCols.arr[5,7]));
FCols.ExchangeColRow(false,7,3);
writeln('after exchanging row 7 and 3:');
writeln('5,3:'+Pchar(FCols.arr[5,3]));
writeln('5,7:'+Pchar(FCols.arr[5,7]));
FCols.DeleteColRow(true,5);
writeln('after deleting column 5:');
try
writeln('5,3:'+Pchar(FCols.arr[5,3])); //this raises an exception
except
writeln ('An exception has taken place be because 5,3 does not exist.');
end;
try
writeln('5,7:'+Pchar(FCols.arr[5,7])); //this raises an exception
except
writeln ('An exception has taken place be because 5,7 does not exist.');
end;
FCols.Clear; writeln('after clear:');
try
writeln('4,7:'+Pchar(FCols.arr[4,7])); //this raises an exception
except
writeln ('An exception has taken place be because 4,7 does not exist.');
end;
FCols.Destroy;
ex.Destroy;
readln;
end.