Browse Source

+ More fixes

michael 20 years ago
parent
commit
71d0327405
6 changed files with 223 additions and 0 deletions
  1. 27 0
      docs/dos.xml
  2. 12 0
      docs/keyboard.xml
  3. 4 0
      docs/objpas.xml
  4. 134 0
      docs/sysutils.xml
  5. 32 0
      docs/typinfo.xml
  6. 14 0
      docs/video.xml

+ 27 - 0
docs/dos.xml

@@ -173,6 +173,33 @@ and time.
 </descr>
 </descr>
 </topic>
 </topic>
 
 
+<element name="TLineEndStr">
+<short>End-of-line string</short>
+<descr>
+<var>TLineEndStr</var> is used in the <link id="TextRec"/> record to
+indicate the end-of-line sequence for a text file.
+</descr>
+</element>
+
+<element name="GetMSCount">
+<short>Number of milliseconds since a starting point.</short>
+<descr>
+<p>
+<var>GetMSCount</var> returns a number of milliseconds elapsed since a
+certain moment in time. This moment in time is implementation dependent.
+This function is used for timing purposes: Substracting the results of 2
+subsequent calls to this function returns the number of milliseconds elapsed
+between the two calls.
+</p>
+<p>
+This call is not very reliable, it is recommended to use some system
+specific calls for timings.
+</p>
+</descr>
+<seealso>
+<link id="GetTime"/>
+</seealso>
+</element>
 
 
 <element name="fmclosed">
 <element name="fmclosed">
 <short>File is closed</short>
 <short>File is closed</short>

+ 12 - 0
docs/keyboard.xml

@@ -55,6 +55,18 @@ demonstrates how to make a keyboard driver.
 <short>Keyboard driver not implemented.</short>
 <short>Keyboard driver not implemented.</short>
 </element>
 </element>
 
 
+<element name="kbdApps">
+<short>Application key (popup-menu) pressed.</short>
+</element>
+
+<element name="kbdLWin">
+<short>Left windows key pressed.</short>
+</element>
+
+<element name="kbdRWin">
+<short>Right windows key pressed.</short>
+</element>
+
 <element name="kbdF1">
 <element name="kbdF1">
 <short>F1 function key pressed.</short>
 <short>F1 function key pressed.</short>
 </element>
 </element>

+ 4 - 0
docs/objpas.xml

@@ -561,6 +561,10 @@ integer is 16 bit.
 <short>Ansistring record in resource table (Delphi compatibility).</short>
 <short>Ansistring record in resource table (Delphi compatibility).</short>
 </element>
 </element>
 
 
+<element name="PInteger">
+<short>Pointer to <link id="#rtl.objpas.integer">Integer</link> type.</short>
+</element>
+
 <!-- function Visibility: default -->
 <!-- function Visibility: default -->
 <element name="LoadResString">
 <element name="LoadResString">
 <short>Load resource string</short>
 <short>Load resource string</short>

+ 134 - 0
docs/sysutils.xml

@@ -7251,6 +7251,140 @@ trailing directory delimiter character.
 <short>Function prototype for <link id="#rtl.sysutils.OnGetTempFile">OnGetTempFile</link> handler.</short>
 <short>Function prototype for <link id="#rtl.sysutils.OnGetTempFile">OnGetTempFile</link> handler.</short>
 </element>
 </element>
 
 
+<element name="TLineEndStr">
+<short>End-of-line string</short>
+<descr>
+<var>TLineEndStr</var> is used in the <link id="TextRec"/> record to
+indicate the end-of-line sequence for a text file.
+</descr>
+</element>
+
+</descr>
+</element>
+
+<element name="TSysLocale">
+<short>Type describing the current locale</short>
+<descr>
+<var>TSysLocale</var> describes the current locale. If <var>Fareast</var> or
+<var>MBCS</var> is <var>True</var>, then the current locale uses a
+Multi-Byte Character Set. If <var>MiddleEast</var> or <var>RightToLeft</var>
+is <var>True</var> then words and sentences are read from right to left.
+</descr>
+</element>
+
+<element name="TSysLocale.FarEast">
+<short>Multi-Byte Character Set used</short>
+</element>
+
+<element name="TSysLocale.MiddleEast">
+<short>Reading direction is Right-to-left</short>
+</element>
+
+<element name="TSysLocale.MBCS">
+<short>Multi-Byte Character Set used</short>
+</element>
+
+<element name="TSysLocale.RightToLeft">
+<short>Reading direction is Right-to-left</short>
+</element>
+
+<element name="SysLocale">
+<short>Variable with locale information</short>
+<descr>
+<var>SysLocale</var> is initialized by the initialization code of the
+<file>SysUtils</file> unit. For an explanation of the fields, see <link
+id="TSysLocale"/>
+</descr>
+<seealso>
+<link id="TSysLocale"/>
+</seealso>
+</element>
+
+<element name="ForceDirectories">
+<short>Create a chain of directories</short>
+<descr>
+<var>ForceDirectories</var> tries to create any missing directories in
+<var>Dir</var> till the whole path in <var>Dir</var> exists. It returns
+<var>True</var> if <var>Dir</var> already existed or was created
+succesfully. If it failed to create any of the parts, <var>False</var> is
+returned.
+</descr>
+</element>
+
+<element name="StrCharLength">
+<short>Return the length of a null-terminated string in characters.</short>
+<descr>
+<var>StrCharLength</var> returns the length of the null-terminated string
+<var>Str</var> (a widestring) in characters (not in bytes). It uses the
+widestringmanager to do this.
+</descr>
+</element>
+
+<element name="TryStrToFloat">
+<short>Try to convert a string to a float.</short>
+<descr>
+<var>TryStrToFloat</var> tries to convert the string <var>S</var> to a
+floating point value, and stores the result in <var>Value</var>. It returns
+<var>True</var> if the operation was succesful, and <var>False</var> if it
+failed. This operation takes into account the system settings for floating
+point representations.
+</descr>
+<errors>
+On error, -1 is returned.
+</errors>
+<seealso>
+<link id="StrToFloat"/>
+</seealso>
+</element>
+
+<element name="WideCompareStr">
+<short>Compare two widestrings (case sensitive)</short>
+<descr>
+</descr>
+</element>
+
+<element name="WideCompareText">
+<short>Compare two widestrings  (ignoring case).</short>
+<descr>
+</descr>
+</element>
+
+<element name="WideFormat">
+<short>Format a wide string.</short>
+<descr>
+</descr>
+</element>
+
+<element name="WideLowerCase">
+<short>Change a widestring to all-lowercase.</short>
+<descr>
+</descr>
+</element>
+
+<element name="WideSameStr">
+<short>Check whether two widestrings are the same (case sensitive)</short>
+<descr>
+</descr>
+</element>
+
+<element name="WideSameText">
+<short>Check whether two widestrings are the same (ignoring case)</short>
+<descr>
+</descr>
+</element>
+
+<element name="WideUpperCase">
+<short>Change a widestring to all-lowercase.</short>
+<descr>
+</descr>
+</element>
+
+<element name="WrapText">
+<short></short>
+<descr></descr>
+</element>
+
+
 </module>
 </module>
 </package>
 </package>
 </fpdoc-descriptions>
 </fpdoc-descriptions>

+ 32 - 0
docs/typinfo.xml

@@ -332,6 +332,38 @@ the size and sign of the ordinal type:
 <short>Unsigned longing (Cardinal)</short>
 <short>Unsigned longing (Cardinal)</short>
 </element>
 </element>
 
 
+<element name="TOrdType">
+<short>Alias for <link id="#rtl.typinfo.TTordType">TTordType</link>.</short>
+<descr>
+If the property is and ordinal type, then <var>TOrdType</var> determines
+the size and sign of the ordinal type:
+</descr>
+</element>
+
+<element name="TOrdType.otSByte">
+<short>Signed byte</short>
+</element>
+
+<element name="TOrdType.otUByte">
+<short>Unsigned byte</short>
+</element>
+
+<element name="TOrdType.otSWord">
+<short>Signed word</short>
+</element>
+
+<element name="TOrdType.otUWord">
+<short>Unsigned word</short>
+</element>
+
+<element name="TOrdType.otSLong">
+<short>Signed longint</short>
+</element>
+
+<element name="TOrdType.otULong">
+<short>Unsigned longing (Cardinal)</short>
+</element>
+
 <element name="TFloatType">
 <element name="TFloatType">
 <short>The size of a float type.</short>
 <short>The size of a float type.</short>
 </element>
 </element>

+ 14 - 0
docs/video.xml

@@ -995,6 +995,20 @@ screen at a given location. It looks as follows:
 <example file="videoex/vidutil"/>
 <example file="videoex/vidutil"/>
 </topic>
 </topic>
 
 
+<element name="CursorLines">
+<short>Currently visible scanlines of cursor.</short>
+<descr>
+<p>
+<var>CursorLines</var> is a bitmask which determines which cursor lines are
+visible and which are not. Each set bit corresponds to a cursorline being
+shown.
+</p>
+<p>
+This variable is not supported on all platforms, so it should be used
+sparingly.
+</p>
+</descr>
+</element>
 
 
 </module>
 </module>
 </package>
 </package>