diff --git a/.gitattributes b/.gitattributes index 8ec392af8e..9dadd05a09 100644 --- a/.gitattributes +++ b/.gitattributes @@ -6215,6 +6215,7 @@ docs/xml/StyleGuide.txt svneol=native#text/plain docs/xml/ide/aboutfrm.xml svneol=native#text/plain docs/xml/ide/environmentopts.xml svneol=native#text/xml docs/xml/lazutils/avglvltree.xml svneol=native#text/plain +docs/xml/lazutils/compwriterpas.xml -text svneol=native#text/plain docs/xml/lazutils/dynamicarray.xml svneol=native#text/plain docs/xml/lazutils/dynhasharray.xml svneol=native#text/plain docs/xml/lazutils/dynqueue.xml svneol=native#text/plain @@ -6225,6 +6226,7 @@ docs/xml/lazutils/fpcadds.xml svneol=LF#text/xml eol=lf docs/xml/lazutils/fpmake.xml svneol=native#text/plain docs/xml/lazutils/graphtype.xml svneol=LF#text/xml eol=lf docs/xml/lazutils/html2textrender.xml svneol=native#text/plain +docs/xml/lazutils/integerlist.xml -text svneol=native#text/plain docs/xml/lazutils/laz2_dom.xml svneol=native#text/plain docs/xml/lazutils/laz2_xmlcfg.xml svneol=native#text/plain docs/xml/lazutils/laz2_xmlread.xml svneol=native#text/plain @@ -6264,6 +6266,7 @@ docs/xml/lazutils/lazutf8sysutils.xml svneol=native#text/plain docs/xml/lazutils/lazutilities.xml svneol=native#text/plain docs/xml/lazutils/lazutils.xml svneol=native#text/plain docs/xml/lazutils/lazutilsstrconsts.xml svneol=native#text/plain +docs/xml/lazutils/lazversion.xml -text svneol=native#text/plain docs/xml/lazutils/lconvencoding.xml svneol=native#text/plain docs/xml/lazutils/lcsvutils.xml svneol=native#text/plain docs/xml/lazutils/lookupstringlist.xml svneol=native#text/plain diff --git a/docs/xml/lazutils/compwriterpas.xml b/docs/xml/lazutils/compwriterpas.xml new file mode 100644 index 0000000000..dc9b796012 --- /dev/null +++ b/docs/xml/lazutils/compwriterpas.xml @@ -0,0 +1,892 @@ + + + + + + + Contains types, classes, and rotuinees used to serialize components into Pascal code + + +

+ The following features and functionality are currently implemented: +

+
    +
  • signature begin, end, versionli
    • +
  • boolean, set of boolean
    • +
  • char, widechar, custom char, set of custom char
    • +
  • integers, custom int, set of custom int
    • +
  • strings, codepage system and UTF8
    • +
  • float, currency
    • +
  • enum, custom enum range
    • +
  • set of enum, set of custom enum range
    • +
  • variant: integers, boolean, string, floats, currency
    • +
  • method
    • +
  • persistent
    • +
  • component children, use SetParentComponent or optional Parent
    • +
  • collection
    • +
  • IInterfaceComponentReference
    • +
  • with ancestor
    • +
  • ancestor: change ComponentIndex -> call SetChildPos
    • +
  • reference foreign root, reference foreign component
    • +
  • + create components before setting properties to avoid having to set references + later +
    • +
  • + inline component, csInline, call SetInline, inherited inline, inline on inherited +
    • +
  • TComponent.Left/Right via DesignInfo
    • +
  • DefineProperties
    • +
  • RegisterDefinePropertiesPas
    • +
+

+ TCompWriterPas is used in the implementation of the TCustomFormEditor class in the Lazarus IDE. +

+

+ Author: Mattias Gaertner +

+ + + + + + + + + + + + + + Component Serialization to Pascal version + + + + + + Default signature written before serialized component data + + + + + + Default begin signature written before a serialized component + + + + + + Default end signature written after a serialized component + + + + + + Default class name used to access protected TComponent members + + + + + + Default value for the ExecCustomProc property in TCompWriterPas + + + + + + Default value for the ExecCustomProcUnit property in TCompWriterPas + + + + + + Default value for the MaxColumn property in TCompWriterPas + + + + + + Default value for the AssignOp property in TCompWriterPas + + + + + + Parent property name to skip when writing component data + + + + + + Specifies an event handler used to find ancestor class in TCompWriterPas + + + + + + + + + + + + + + + + + + + + + + Specifies an event handler used to get property information and an identifer name for a property + + + + + + + + + + + + + + + + + + + + Specifies an event handler used to get a parent property name for a component instance + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Enumeration which defines options available in TCompWriterPas + + + + + Do not write Begin, End signatures + + + Enclose in "with LookupRootname do begin" + + + Add "SetParentComponent" before setting properties, default: after + + + + Target unit uses $codepage utf-8, aka do not convert UTF-8 string literals + + + + Do not use with ... do + + + + Do not include a final line break at the end of the serialized component data + + + + + Set type used to stores values from the TCWPOption enumeration + + + + + + + + + + + + + + + + + + Serializes a component to Pascal code + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/xml/lazutils/integerlist.xml b/docs/xml/lazutils/integerlist.xml new file mode 100644 index 0000000000..4eae41b8af --- /dev/null +++ b/docs/xml/lazutils/integerlist.xml @@ -0,0 +1,148 @@ + + + + + + + Provides lists for Integer data types implemented using generics + + +

+ The classes provide the same methods and properties for Integer types as provided for Strings in TStringList. They provide an overloaded Sort method to ensure that the specialization types are handled in the methods. +

+ + + + Implements a specialization of TFPGList for Byte data types + +

+ TByteList provides an overloaded Sort method to ensure that values in the list are handled using a compare function that operates on Byte values. +

+ + + + + + + + Sorts the Byte values stored in the list + +

+ Sort is an overloaded method in TByteList which calls the inherited method using the CompareByte function in the implementation section. +

+ + + + + + + + Implements a specialization of TFPGList for Word data types + +

+ TWordList provides an overloaded Sort method to ensure that values in the list are handled using a compare function that operates on Word values. +

+ + + + + + + + Sorts the Word values stored in the list + +

+ Sort is an overloaded method in TWordList which calls the inherited method using the CompareWord function in the implementation section. +

+ + + + + + + + Implements a specialization of TFPGList for Cardinal data types + +

+ TCardinalList provides an overloaded Sort method to ensure that values in the list are handled using a compare function that operates on Cardinal values. +

+ + + + + + + + + + Sorts the Word values stored in the list + +

+ Sort is an overloaded method in TCardinalList which calls the inherited method using the CompareCardinal function in the implementation section. +

+ + + + + + + + Implements a specialization of TFPGList for Integer data types + +

+ TIntegerList provides an overloaded Sort method to ensure that values in the list are handled using a compare function that operates on Integer values. +

+ + + + + + + + + + Sorts the Integer values stored in the list + +

+ Sort is an overloaded method in TIntegerList which calls the inherited method using the CompareInteger function in the implementation section. +

+ + + + + + + + Implements a specialization of TFPGList for Int64 data types + +

+ TInt64List provides an overloaded Sort method to ensure that values in the list are handled using a compare function that operates on Int64 values. +

+ + + + + + + + + Sorts the Int64 values stored in the list + +

+ Sort is an overloaded method in TInt64List which calls the inherited method using the CompareInt64 function in the implementation section. +

+ + + + + + + + + + + diff --git a/docs/xml/lazutils/lazversion.xml b/docs/xml/lazutils/lazversion.xml new file mode 100644 index 0000000000..62f7389270 --- /dev/null +++ b/docs/xml/lazutils/lazversion.xml @@ -0,0 +1,100 @@ + + + + + + + Contains constants which identify the version numbers for the Lazarus IDE installed on the local system + + +

+ Values in the unit are used as the basis for corresponding LCL version numbers in the lclversion.pas unit. +

+ + + + Major version number for the Lazarus IDE + + For the Lazarus version number 2.1.0.42, the value in laz_major is 2. + + + + + + Added in revision 57504, and available since Lazarus 1.8.4.0. + + + + + Minor version number for the Lazarus IDE + + For the Lazarus version number 2.1.0.42, the value in laz_minor is 1. + + + + + + Added in revision 57504, and available since Lazarus 1.8.4.0. + + + + + Release number for the Lazarus IDE + + For the Lazarus version number 2.1.0.42, the value in laz_release is 0. + + + + + + Added in revision 57504, and available since Lazarus 1.8.4.0. + + + + + Patch level for the Lazarus IDE + + For the Lazarus version number 2.1.0.42, the value in laz_patch is 42. + + + + + + Added in revision 57504, and available since Lazarus 1.8.4.0. + + + + + Numeric version number for the Lazarus IDE + + For the Lazarus version number 2.1.0.42, the value in laz_fullversion is 2010042. + + + + + + Added in revision 57504, and available since Lazarus 1.8.4.0. + + + + + String with the full version number for the Lazarus IDE + + For the Lazarus version number 2.1.0.42, the value in laz_version is '2.1.0.42'. + + + + + + Added in revision 57504, and available since Lazarus 1.8.4.0. + + + + + + +