Update of /cvsroot/jvcl/dev/help In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv13800 Modified Files: JvAnimatedImage.dtx JvAppStorage.dtx JvChart.dtx JvComCtrls.dtx JvDBGrid.dtx JvEDIDBBuffering.dtx JvExControls.dtx JvgXMLSerializer.dtx JvLabel.dtx JvNetscapeSplitter.dtx JvPageList.dtx JvRadioGroup.dtx JvScheduledEvents.dtx JvSimpleXml.dtx JvStatusBar.dtx JvTFDays.dtx JvTFManager.dtx Log Message: Updates Index: JvDBGrid.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvDBGrid.dtx,v retrieving revision 1.12 retrieving revision 1.13 diff -C2 -d -r1.12 -r1.13 *** JvDBGrid.dtx 4 Aug 2004 00:09:16 -0000 1.12 --- JvDBGrid.dtx 28 Aug 2004 11:02:10 -0000 1.13 *************** *** 7,11 **** ##Skip: TJvDBGrid.MouseToCell ##Skip: TJvDBGrid.MultiSelect - ##Skip: TJvDBGrid.OnKeyPress ##Skip: TJvDBGrid.OnTopLeftChanged ##Skip: TJvDBGrid.Options --- 7,10 ---- *************** *** 27,30 **** --- 26,41 ---- Write here a description ---------------------------------------------------------------------------------------------------- + @@TCharList + <TITLE TCharList type> + Summary + Write here a summary (1 line) + Description + You don't have to document already described items such as sets, + pointers to records etc. + (Value = set of Char; - for reference) + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TCheckTitleBtnEvent <TITLE TCheckTitleBtnEvent type> *************** *** 143,146 **** --- 154,166 ---- beeps on errors. Set BeepOnError to false to suppress this behavior. ---------------------------------------------------------------------------------------------------- + @@TJvDBGrid.CharList + Summary + Write here a summary (1 line) + Description + Write here a description + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TJvDBGrid.ClearSelection Summary *************** *** 153,156 **** --- 173,185 ---- MultiSelect ---------------------------------------------------------------------------------------------------- + @@TJvDBGrid.CloseControl + Summary + Write here a summary (1 line) + Description + Write here a description + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TJvDBGrid.EditControls Summary *************** *** 195,198 **** --- 224,241 ---- Load, LoadFromAppStore, Save, SaveToAppStore ---------------------------------------------------------------------------------------------------- + @@TJvDBGrid.InitializeColumnsWidth + Summary + Write here a summary (1 line) + Description + Write here a description + Parameters + MinWidth - Description for this parameter + MaxWidth - Description for this parameter + DisplayWholeTitle - Description for this parameter + FixedWidths - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TJvDBGrid.Load Summary *************** *** 252,256 **** ACanvas - The canvas to draw on. ARect - The rect area to draw in. ! Field - The field of the cell. ## AFont - The cell's font. ## Background - The cell's background color. --- 295,300 ---- ACanvas - The canvas to draw on. ARect - The rect area to draw in. ! AColumn - Description for this parameter ! ## Field - The field of the cell. ## AFont - The cell's font. ## Background - The cell's background color. *************** *** 541,544 **** --- 585,597 ---- PopupMenu ---------------------------------------------------------------------------------------------------- + @@TJvDBGrid.TitleRowHeight + Summary + Write here a summary (1 line) + Description + Write here a description + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TJvDBGrid.ToggleRowSelection Summary *************** *** 648,651 **** --- 701,713 ---- The caption to use on the OK button on the select columns dialog. ---------------------------------------------------------------------------------------------------- + @@TJvSelectDialogColumnStrings.RealNamesOption + Summary + Write here a summary (1 line) + Description + Write here a description + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TJvTitleHintEvent <TITLE TJvTitleHintEvent type> Index: JvEDIDBBuffering.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvEDIDBBuffering.dtx,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** JvEDIDBBuffering.dtx 4 Aug 2004 00:09:16 -0000 1.3 --- JvEDIDBBuffering.dtx 28 Aug 2004 11:02:11 -0000 1.4 *************** *** 555,559 **** ---------------------------------------------------------------------------------------------------- @@TJvResolveFieldDefTypeEvent ! <TITLE TJvOnResolveFieldDefTypeEvent type> <COMBINE TJvEDIDBBuffer.OnResolveFieldDefType> Summary --- 555,559 ---- ---------------------------------------------------------------------------------------------------- @@TJvResolveFieldDefTypeEvent ! <TITLE TJvResolveFieldDefTypeEvent type> <COMBINE TJvEDIDBBuffer.OnResolveFieldDefType> Summary *************** *** 569,573 **** ---------------------------------------------------------------------------------------------------- @@TJvTableProfileEvent ! <TITLE TJvOnTableProfileEvent type> Summary A TJvEDIDBBuffer event. --- 569,573 ---- ---------------------------------------------------------------------------------------------------- @@TJvTableProfileEvent ! <TITLE TJvTableProfileEvent type> Summary A TJvEDIDBBuffer event. Index: JvSimpleXml.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvSimpleXml.dtx,v retrieving revision 1.13 retrieving revision 1.14 diff -C2 -d -r1.13 -r1.14 *** JvSimpleXml.dtx 15 Apr 2004 07:49:03 -0000 1.13 --- JvSimpleXml.dtx 28 Aug 2004 11:02:11 -0000 1.14 *************** *** 1,4 **** --- 1,25 ---- ##Package: System ##Status: Needs review + ##Skip: TJvSimpleXMLElemCData.LoadFromStream + ##Skip: TJvSimpleXMLElemCData.SaveToStream + ##Skip: TJvSimpleXMLElemClassic.LoadFromStream + ##Skip: TJvSimpleXMLElemClassic.SaveToStream + ##Skip: TJvSimpleXMLElemComment.LoadFromStream + ##Skip: TJvSimpleXMLElemComment.SaveToStream + ##Skip: TJvSimpleXMLElemDocType.LoadFromStream + ##Skip: TJvSimpleXMLElemDocType.SaveToStream + ##Skip: TJvSimpleXMLElemHeader.LoadFromStream + ##Skip: TJvSimpleXMLElemHeader.SaveToStream + ##Skip: TJvSimpleXMLElemSheet.LoadFromStream + ##Skip: TJvSimpleXMLElemSheet.SaveToStream + ##Skip: TJvSimpleXMLElemText.LoadFromStream + ##Skip: TJvSimpleXMLElemText.SaveToStream + ##Skip: TXMLVariant.CastTo + ##Skip: TXMLVariant.Clear + ##Skip: TXMLVariant.Copy + ##Skip: TXMLVariant.DoFunction + ##Skip: TXMLVariant.GetProperty + ##Skip: TXMLVariant.IsClear + ##Skip: TXMLVariant.SetProperty ---------------------------------------------------------------------------------------------------- @@JvSimpleXml.pas *************** *** 11,14 **** --- 32,59 ---- ---------------------------------------------------------------------------------------------------- + @@EntityDecode + <TITLE EntityDecode function> + Summary + Write here a summary (1 line) + Description + Write here a description + Parameters + S - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- + @@EntityEncode + <TITLE EntityEncode function> + Summary + Write here a summary (1 line) + Description + Write here a description + Parameters + S - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@PJvHashElem <TITLE PJvHashElem type> *************** *** 50,55 **** ---------------------------------------------------------------------------------------------------- ! @@SimpleXmlEncode ! <TITLE SimpleXmlEncode function> Summary Encodes the special characters to their XML representation --- 95,100 ---- ---------------------------------------------------------------------------------------------------- ! @@SimpleXMLEncode ! <TITLE SimpleXMLEncode function> Summary Encodes the special characters to their XML representation *************** *** 69,84 **** Summary This is not being used at the moment - - - ---------------------------------------------------------------------------------------------------- @@TJvHashElem.Next ! Next HashElem ! ! ! ---------------------------------------------------------------------------------------------------- @@TJvHashElem.Obj ! Associated object ! ! ---------------------------------------------------------------------------------------------------- @@TJvHashKind --- 114,121 ---- Summary This is not being used at the moment @@TJvHashElem.Next ! Next HashElem @@TJvHashElem.Obj ! Associated object ---------------------------------------------------------------------------------------------------- @@TJvHashKind *************** *** 86,101 **** Summary This is not being used at the moment - - - ---------------------------------------------------------------------------------------------------- @@TJvHashKind.hkList ! List hash ! ! ! ---------------------------------------------------------------------------------------------------- @@TJvHashKind.hkDirect ! Direct hash ! ! ---------------------------------------------------------------------------------------------------- @@TJvHashList --- 123,130 ---- Summary This is not being used at the moment @@TJvHashKind.hkList ! List hash @@TJvHashKind.hkDirect ! Direct hash ---------------------------------------------------------------------------------------------------- @@TJvHashList *************** *** 110,130 **** Summary This is not being used at the moment - - - ---------------------------------------------------------------------------------------------------- @@TJvHashRecord.Count ! Count ! ! ! ---------------------------------------------------------------------------------------------------- @@TJvHashRecord.List ! The List ! ! ! ---------------------------------------------------------------------------------------------------- @@TJvHashRecord.FirstElem ! The First Element ! ! ---------------------------------------------------------------------------------------------------- @@TJvOnSimpleProgress --- 139,148 ---- Summary This is not being used at the moment @@TJvHashRecord.Count ! Count @@TJvHashRecord.List ! The List @@TJvHashRecord.FirstElem ! The First Element ---------------------------------------------------------------------------------------------------- @@TJvOnSimpleProgress *************** *** 141,146 **** ---------------------------------------------------------------------------------------------------- ! @@TJvOnSimpleXmlParsed ! <TITLE TJvOnSimpleXmlParsed type> <COMBINE TJvSimpleXML.OnTagParsed> --- 159,164 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvOnSimpleXMLParsed ! <TITLE TJvOnSimpleXMLParsed type> <COMBINE TJvSimpleXML.OnTagParsed> *************** *** 246,262 **** Value - The string to load the value from ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXML.OnEncodeValue Summary ! Occurs when a value is to be encoded. Description ! Write a handler for this event to do special processing to the XML data of tag and attribute values. ! The normal processing of JvSimpleXML (if sxoAutoEncodeValue is set in Options) is to encode all ! tag and attribute value susing the SimpleXMLEnocde function but you can handle all encoding/decoding ! yourself using any of the events OnEncodeValue, OnDecodeValue, OnEncodeStream and OnDecodeStream. ! Note that if you assign a handler to this event, the default decoding is not performed, regardless of ! the value of sxoAutoEncodeValue. See Also ! OnDecodeValue, OnEncodeStream, OnDecodeStream ---------------------------------------------------------------------------------------------------- @@TJvSimpleXML.OnDecodeValue --- 264,278 ---- Value - The string to load the value from ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXML.OnDecodeStream Summary ! Occurs when the XML data is read from string, stream or file. Description ! Write a handler for this event to do special processing of the XML stream before reading it into ! the component. For example, use this event to convert an encoded XML file to an internal format. ! Note that if you assign a handler to this event, you should set sxoAutoEncodeValue to false in Options ! to prevent the default encoding of tag and attribute values. See Also ! OnEncodeStream ---------------------------------------------------------------------------------------------------- @@TJvSimpleXML.OnDecodeValue *************** *** 286,300 **** OnDecodeStream ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXML.OnDecodeStream Summary ! Occurs when the XML data is read from string, stream or file. Description ! Write a handler for this event to do special processing of the XML stream before reading it into ! the component. For example, use this event to convert an encoded XML file to an internal format. ! Note that if you assign a handler to this event, you should set sxoAutoEncodeValue to false in Options ! to prevent the default encoding of tag and attribute values. See Also ! OnEncodeStream ---------------------------------------------------------------------------------------------------- @@TJvSimpleXML.OnLoadProgress --- 302,318 ---- OnDecodeStream ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXML.OnEncodeValue Summary ! Occurs when a value is to be encoded. Description ! Write a handler for this event to do special processing to the XML data of tag and attribute values. ! The normal processing of JvSimpleXML (if sxoAutoEncodeValue is set in Options) is to encode all ! tag and attribute value susing the SimpleXMLEnocde function but you can handle all encoding/decoding ! yourself using any of the events OnEncodeValue, OnDecodeValue, OnEncodeStream and OnDecodeStream. ! Note that if you assign a handler to this event, the default decoding is not performed, regardless of ! the value of sxoAutoEncodeValue. See Also ! OnDecodeValue, OnEncodeStream, OnDecodeStream ---------------------------------------------------------------------------------------------------- @@TJvSimpleXML.OnLoadProgress *************** *** 343,350 **** Description Usually indicates the DTD to be used with the XML file. For instance: <?xml version="1.0"?> <!DOCTYPE greeting SYSTEM "hello.dtd"> ! ! ---------------------------------------------------------------------------------------------------- @@TJvSimpleXML.Root --- 361,370 ---- Description Usually indicates the DTD to be used with the XML file. For instance: + <AUTOLINK OFF> + <CODE> <?xml version="1.0"?> <!DOCTYPE greeting SYSTEM "hello.dtd"> ! </CODE> ! <AUTOLINK ON> ---------------------------------------------------------------------------------------------------- @@TJvSimpleXML.Root *************** *** 427,432 **** Summary Deletes all childs and properties from the element ! ! ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLElem.Data --- 447,459 ---- Summary Deletes all childs and properties from the element ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElem.Container ! Summary ! Write here a summary (1 line) ! Description ! Write here a description ! See Also ! List here other properties, methods (comma seperated) ! Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLElem.Data *************** *** 553,557 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElem.SimpleXml Summary The TJvSimpleXml component containing this element --- 580,584 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElem.SimpleXML Summary The TJvSimpleXml component containing this element *************** *** 574,591 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXmlElemCData Summary A CDATA XML element Description Example: <![CDATA[value]]> ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXmlElemCData.LoadFromStream ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXmlElemCData.SaveToStream --- 601,614 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemCData Summary A CDATA XML element Description Example: + <AUTOLINK OFF> + <CODE> <![CDATA[value]]> ! </CODE> ! <AUTOLINK ON> *************** *** 600,611 **** ---------------------------------------------------------------------------------------------------- - @@TJvSimpleXMLElemClassic.LoadFromStream - - - ---------------------------------------------------------------------------------------------------- - @@TJvSimpleXMLElemClassic.SaveToStream - - - ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLElemComment Summary --- 623,626 ---- *************** *** 613,625 **** Description Example: <!-- This is a comment --> ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemComment.LoadFromStream ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemComment.SaveToStream --- 628,636 ---- Description Example: + <AUTOLINK OFF> + <CODE> <!-- This is a comment --> ! </CODE> ! <AUTOLINK ON> *************** *** 638,655 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXmlElemDocType Summary A DOCTYPE XML element Description Example: <!DOCTYPE Value> ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXmlElemDocType.LoadFromStream ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXmlElemDocType.SaveToStream --- 649,662 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemDocType Summary A DOCTYPE XML element Description Example: + <AUTOLINK OFF> + <CODE> <!DOCTYPE Value> ! </CODE> ! <AUTOLINK ON> *************** *** 660,664 **** --- 667,675 ---- Description Example: + <AUTOLINK OFF> + <CODE> <?xml version="Version" standalone="yes" encoding="Encoding"?> + </CODE> + <AUTOLINK ON> *************** *** 672,684 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemHeader.LoadFromStream ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemHeader.SaveToStream ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemHeader.Standalone Summary True if the XML document is to be standalone --- 683,687 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemHeader.StandAlone Summary True if the XML document is to be standalone *************** *** 712,716 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElems.Add@string@boolean Summary Adds a new element with the given name and value in the collection --- 715,719 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElems.Add@string@Boolean Summary Adds a new element with the given name and value in the collection *************** *** 869,873 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElems.Delete@integer Summary Deletes the indicated element from the list --- 872,876 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElems.Delete@Integer Summary Deletes the indicated element from the list *************** *** 933,938 **** See Also SaveToStream ! ! ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLElems.Parent --- 936,951 ---- See Also SaveToStream ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElems.Notify ! Summary ! Write here a summary (1 line) ! Description ! Write here a description ! Parameters ! Value - Description for this parameter ! Operation - Description for this parameter ! See Also ! List here other properties, methods (comma seperated) ! Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLElems.Parent *************** *** 978,990 **** Description Example: <?xml-stylesheet href="styles.css" type="text/css"?> ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemSheet.LoadFromStream ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemSheet.SaveToStream --- 991,999 ---- Description Example: + <AUTOLINK OFF> + <CODE> <?xml-stylesheet href="styles.css" type="text/css"?> ! </CODE> ! <AUTOLINK ON> *************** *** 1031,1035 **** Parameters Stream - The stream to load the list from ! AParent - The TJvSimpleXML parent component, if any Return value Returns the portion of the stream that was read --- 1040,1044 ---- Parameters Stream - The stream to load the list from ! Parent - The TJvSimpleXML parent component, if any Return value Returns the portion of the stream that was read *************** *** 1072,1083 **** Example: This is some text - - ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemText.LoadFromStream ! ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLElemText.SaveToStream --- 1081,1102 ---- Example: This is some text ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLEncodeEvent ! <TITLE TJvSimpleXMLEncodeEvent type> ! Summary ! Event type used by OnEncode and OnDecode events of TJvSimpleXML. ! Parameters ! Sender - the component that triggered the event. ! Value - the value to encode. ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLEncodeStreamEvent ! <TITLE TJvSimpleXMLEncodeStreamEvent type> ! Summary ! Event type used by OnEncodeStream and OnDecodeStream of TJvSimpleXML. ! Parameters ! Sender - the component that triggered the event. ! InStream - the stream to encode/decode. ! OutStream - the result of encoding/decoding InStream. ! *************** *** 1121,1126 **** Summary The internal Data of the property ! ! ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLProp.IntValue --- 1140,1154 ---- Summary The internal Data of the property ! ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLProp.GetSimpleXML ! Summary ! Write here a summary (1 line) ! Description ! Write here a description ! Return value ! Describe here what the function returns ! See Also ! List here other properties, methods (comma seperated) ! Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- @@TJvSimpleXMLProp.IntValue *************** *** 1176,1180 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLProps.Add@string@boolean Summary Adds a new property with the given name and value in the collection --- 1204,1208 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLProps.Add@string@Boolean Summary Adds a new property with the given name and value in the collection *************** *** 1234,1238 **** ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLProps.Delete@integer Summary Deletes the indicated property from the list --- 1262,1266 ---- ---------------------------------------------------------------------------------------------------- ! @@TJvSimpleXMLProps.Delete@Integer Summary Deletes the indicated property from the list *************** *** 1321,1397 **** ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData ! <TITLE TXmlVarData type> Summary A record to hold Variant data information ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData.vType ! Type of variant ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData.Reserved1 ! Reserved1 ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData.Reserved2 ! Reserved2 ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData.Reserved3 ! Reserved3 ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData.Xml ! An TJvSimpleXMLElem object ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVarData.Reserved4 ! Reserved4 ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant Summary An XML Variant - - ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.CastTo ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.Clear ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.Copy ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.DoFunction ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.GetProperty ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.IsClear ! ! ! ---------------------------------------------------------------------------------------------------- ! @@TXmlVariant.SetProperty ! ! ! ---------------------------------------------------------------------------------------------------- ! @@VarXml ! <TITLE VarXml function> Summary Returns the type of variant used for XML variants --- 1349,1375 ---- ---------------------------------------------------------------------------------------------------- ! @@TXMLVarData ! <TITLE TXMLVarData type> Summary A record to hold Variant data information ! @@TXMLVarData.vType ! Type of variant ! @@TXMLVarData.Reserved1 ! Reserved1 ! @@TXMLVarData.Reserved2 ! Reserved2 ! @@TXMLVarData.Reserved3 ! Reserved3 ! @@TXMLVarData.XML ! An TJvSimpleXMLElem object ! @@TXMLVarData.Reserved4 ! Reserved4 ---------------------------------------------------------------------------------------------------- ! @@TXMLVariant Summary An XML Variant ---------------------------------------------------------------------------------------------------- ! @@VarXML ! <TITLE VarXML function> Summary Returns the type of variant used for XML variants *************** *** 1399,1404 **** ---------------------------------------------------------------------------------------------------- ! @@XmlCreate ! <TITLE XmlCreate function> Summary Creates a TJvSimpleXmlElemClassic and returns it as a variant --- 1377,1382 ---- ---------------------------------------------------------------------------------------------------- ! @@XMLCreate ! <TITLE XMLCreate function> Summary Creates a TJvSimpleXmlElemClassic and returns it as a variant *************** *** 1408,1417 **** ---------------------------------------------------------------------------------------------------- ! @@XmlCreate@TJvSimpleXMLElem ! <TITLE XmlCreate function> Summary ! Teturns a variant containing the given XML element Parameters ! AXml - The XML element to put in the variant See Also XmlCreateInto --- 1386,1395 ---- ---------------------------------------------------------------------------------------------------- ! @@XMLCreate@TJvSimpleXMLElem ! <TITLE XMLCreate function> Summary ! Returns a variant containing the given XML element Parameters ! AXML - The XML element to put in the variant See Also XmlCreateInto *************** *** 1419,1429 **** ---------------------------------------------------------------------------------------------------- ! @@XmlCreateInto ! <TITLE XmlCreateInto procedure> Summary Puts the given XML element in the given variant Parameters ADest - The destination variant ! AXml - The XML element to put in the variant See Also XmlCreate --- 1397,1407 ---- ---------------------------------------------------------------------------------------------------- ! @@XMLCreateInto ! <TITLE XMLCreateInto procedure> Summary Puts the given XML element in the given variant Parameters ADest - The destination variant ! AXML - The XML element to put in the variant See Also XmlCreate *************** *** 1446,1465 **** See Also SimpleXmlEncode - ---------------------------------------------------------------------------------------------------- - @@TJvSimpleXMLEncodeEvent - <TITLE @@TJvSimpleXMLEncodeEvent type> - Summary - Event type used by OnEncode and OnDecode events of TJvSimpleXML. - Parameters - Sender - the component that triggered the event. - Value - the value to encode. - ---------------------------------------------------------------------------------------------------- - @@TJvSimpleXMLEncodeStreamEvent - <TITLE @@TJvSimpleXMLEncodeEvent type> - Summary - Event type used by OnEncodeStream and OnDecodeStream of TJvSimpleXML. - Parameters - Sender - the component that triggered the event. - InStream - the stream to encode/decode. - OutStream - the result of encoding/decoding InStream. - --- 1424,1425 ---- Index: JvTFDays.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvTFDays.dtx,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** JvTFDays.dtx 20 Feb 2004 12:50:45 -0000 1.8 --- JvTFDays.dtx 28 Aug 2004 11:02:11 -0000 1.9 *************** *** 141,145 **** Parameters ! aTime - The time to adjust Return value The adjusted time. --- 141,145 ---- Parameters ! ATime - The time to adjust Return value The adjusted time. *************** *** 169,173 **** Use this property to specify the margin (or gap) (in pixels) from the right side of one appointment to another (or the right side of the column). The default is 5. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.ApptInView --- 169,172 ---- *************** *** 194,198 **** If BorderStyle is set to the default bsSingle, the control has a single-line border. If BorderStyle is set to bsNone, no border appears around the control. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.BottomRow --- 193,196 ---- *************** *** 270,274 **** Description CanEdit will return True if grid conditions permit the in-place editing of appointment text. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.CellIsSelected --- 268,271 ---- *************** *** 281,285 **** Return value True if aCell is selected, false otherwise. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.CellRect --- 278,281 ---- *************** *** 316,320 **** \Read ColHdrHeight to get the height of the column headers in pixels. Set ColHdrHeight to change the height of the column headers. The default height is 25 pixels. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.ColInView --- 312,315 ---- *************** *** 325,329 **** Parameters aCol - The column to make visible. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.ColIsSelected --- 320,323 ---- *************** *** 336,340 **** Return value True if aCol is selected, false otherwise. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.Cols --- 330,333 ---- *************** *** 822,826 **** Appt - The appointment that is about to be edited. AllowEdit - Change to false to prevent the editing of the appointment. - See Also ---------------------------------------------------------------------------------------------------- @@TJvTFDays.OnCreateQuickEntry --- 815,818 ---- *************** *** 932,937 **** Parameters Sender - Description for this parameter ! aCanvas - Description for this parameter ! aRect - Description for this parameter Appt - Description for this parameter TopHandle - Description for this parameter --- 924,929 ---- Parameters Sender - Description for this parameter ! ACanvas - Description for this parameter ! ARect - Description for this parameter Appt - Description for this parameter TopHandle - Description for this parameter *************** *** 1648,1652 **** Write here a description Parameters ! aTime - Description for this parameter Return value Describe here what the function returns --- 1640,1644 ---- Write here a description Parameters ! ATime - Description for this parameter Return value Describe here what the function returns *************** *** 1661,1665 **** Write here a description Parameters ! aTime - Description for this parameter See Also List here other properties, methods (comma seperated) --- 1653,1657 ---- Write here a description Parameters ! ATime - Description for this parameter See Also List here other properties, methods (comma seperated) *************** *** 2767,2771 **** Write here a description Parameters ! aTime - Description for this parameter Return value Describe here what the function returns --- 2759,2763 ---- Write here a description Parameters ! ATime - Description for this parameter Return value Describe here what the function returns *************** *** 3403,3407 **** Write here a description Parameters ! aTime - Description for this parameter Return value Describe here what the function returns --- 3395,3399 ---- Write here a description Parameters ! ATime - Description for this parameter Return value Describe here what the function returns *************** *** 3805,3809 **** Parameters Sender - Description for this parameter ! aCanvas - Description for this parameter Appt - Description for this parameter Col - Description for this parameter --- 3797,3801 ---- Parameters Sender - Description for this parameter ! ACanvas - Description for this parameter Appt - Description for this parameter Col - Description for this parameter *************** *** 3824,3829 **** Parameters Sender - Description for this parameter ! aCanvas - Description for this parameter ! aRect - Description for this parameter Appt - Description for this parameter Selected - Description for this parameter --- 3816,3821 ---- Parameters Sender - Description for this parameter ! ACanvas - Description for this parameter ! ARect - Description for this parameter Appt - Description for this parameter Selected - Description for this parameter *************** *** 3842,3847 **** Parameters Sender - Description for this parameter ! aCanvas - Description for this parameter ! aRect - Description for this parameter Corner - Description for this parameter See Also --- 3834,3839 ---- Parameters Sender - Description for this parameter ! ACanvas - Description for this parameter ! ARect - Description for this parameter Corner - Description for this parameter See Also *************** *** 3859,3864 **** Parameters Sender - Description for this parameter ! aCanvas - Description for this parameter ! aRect - Description for this parameter Col - Description for this parameter Row - Description for this parameter --- 3851,3856 ---- Parameters Sender - Description for this parameter ! ACanvas - Description for this parameter ! ARect - Description for this parameter Col - Description for this parameter Row - Description for this parameter *************** *** 3889,3894 **** Parameters Sender - Description for this parameter ! aCanvas - Description for this parameter ! aRect - Description for this parameter Index - Description for this parameter Selected - Description for this parameter --- 3881,3886 ---- Parameters Sender - Description for this parameter ! ACanvas - Description for this parameter ! ARect - Description for this parameter Index - Description for this parameter Selected - Description for this parameter Index: JvTFManager.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvTFManager.dtx,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** JvTFManager.dtx 4 Aug 2004 00:09:17 -0000 1.16 --- JvTFManager.dtx 28 Aug 2004 11:02:11 -0000 1.17 *************** *** 2362,2366 **** Call GetScheduleID to construct an ID from the \SchedName and \SchedDate parameters. Currently, this method is implemented as: ! AUTOLINK OFF> <CODE> Result := \SchedName + IntToStr(trunc(\SchedDate)); --- 2362,2366 ---- Call GetScheduleID to construct an ID from the \SchedName and \SchedDate parameters. Currently, this method is implemented as: ! <AUTOLINK OFF> <CODE> Result := \SchedName + IntToStr(trunc(\SchedDate)); Index: JvNetscapeSplitter.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvNetscapeSplitter.dtx,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** JvNetscapeSplitter.dtx 4 Aug 2004 00:09:16 -0000 1.3 --- JvNetscapeSplitter.dtx 28 Aug 2004 11:02:11 -0000 1.4 *************** *** 138,142 **** @@TJvCustomNetscapeSplitter.HintColor Summary ! Determines the color of the hint boxes for the Help Hints for the <xxx>. Description Use HintColor to specify the hint box color. A default color value of clInfoBk is set for the --- 138,142 ---- @@TJvCustomNetscapeSplitter.HintColor Summary ! Determines the color of the hint boxes for the Help Hints for the splitter. Description Use HintColor to specify the hint box color. A default color value of clInfoBk is set for the Index: JvgXMLSerializer.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvgXMLSerializer.dtx,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** JvgXMLSerializer.dtx 22 Mar 2004 10:55:51 -0000 1.8 --- JvgXMLSerializer.dtx 28 Aug 2004 11:02:11 -0000 1.9 *************** *** 184,187 **** --- 184,196 ---- ---------------------------------------------------------------------------------------------------- + @@TJvgXMLSerializer.tickCount + Summary + Write here a summary (1 line) + Description + Write here a description + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@TJvgXMLSerializer.tickCounter Summary Index: JvExControls.dtx =================================================================== RCS file: /cvsroot/jvcl/dev/help/JvExControls.dtx,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** JvExControls.dtx 18 Feb 2004 21:37:41 -0000 1.5 --- JvExControls.dtx 28 Aug 2004 11:02:11 -0000 1.6 *************** *** 42,45 **** --- 42,92 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- + @@Control_MouseEnter + <TITLE Control_MouseEnter procedure> + Summary + Write here a summary (1 line) + Description + Write here a description + Parameters + Instance - Description for this parameter + Control - Description for this parameter + FMouseOver - Description for this parameter + FSavedHintColor - Description for this parameter + FHintColor - Description for this parameter + Event - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- + @@Control_MouseLeave + <TITLE Control_MouseLeave procedure> + Summary + Write here a summary (1 line) + Description + Write here a description + Parameters + Instance - Description for this parameter + Control - Description for this parameter + FMouseOver - Description for this parameter + FSavedHintColor - Description for this parameter + Event - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- + @@DefaultDoPaintBackground + <TITLE DefaultDoPaintBackground function> + Summary + Write here a summary (1 line) + Description + Write here a description + Parameters + Instance - Description for this parameter + Canvas - Description for this parameter + Param - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@DispatchMsg <TITLE DispatchMsg procedure> *************** *** 282,292 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents Summary ! Interface to the events of TWinControl descendants. Description Write here a description ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.ControlsListChanged Summary Write here a summary (1 line) --- 329,339 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents Summary ! Write here a summary (1 line) Description Write here a description ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.ControlsListChanged Summary Write here a summary (1 line) *************** *** 300,304 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.ControlsListChanging Summary Write here a summary (1 line) --- 347,351 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.ControlsListChanging Summary Write here a summary (1 line) *************** *** 312,318 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.CursorChanged Summary ! Responds to changes in the Cursor property. Description Write here a description --- 359,365 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.CursorChanged Summary ! Write here a summary (1 line) Description Write here a description *************** *** 321,327 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.DoBoundsChanged Summary ! Responds to changes in the control's size. Description Write here a description --- 368,374 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.DoBoundsChanged Summary ! Write here a summary (1 line) Description Write here a description *************** *** 330,334 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.DoGetDlgCode Summary Write here a summary (1 line) --- 377,381 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.DoGetDlgCode Summary Write here a summary (1 line) *************** *** 341,347 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.DoKillFocus Summary ! Responds when the control loses the keyboard focus. Description Write here a description --- 388,394 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.DoKillFocus Summary ! Write here a summary (1 line) Description Write here a description *************** *** 352,356 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.DoPaintBackground Summary Write here a summary (1 line) --- 399,403 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.DoPaintBackground Summary Write here a summary (1 line) *************** *** 366,372 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.DoSetFocus Summary ! Responds when the control receives the keyboard focus. Description Write here a description --- 413,419 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.DoSetFocus Summary ! Write here a summary (1 line) Description Write here a description *************** *** 377,383 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.ShowHintChanged Summary ! Responds to changes of the ShowHint property. Description Write here a description --- 424,430 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.ShowHintChanged Summary ! Write here a summary (1 line) Description Write here a description *************** *** 386,390 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvWinControlEvents.ShowingChanged Summary Write here a summary (1 line) --- 433,437 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@IJvStdControlEvents.ShowingChanged Summary Write here a summary (1 line) *************** *** 395,398 **** --- 442,467 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- + @@IJvWinControlEvents + Summary + Interface to the events of TWinControl descendants. + Description + Write here a description + ---------------------------------------------------------------------------------------------------- + @@InheritMessage@TControl@TMessage + <TITLE InheritMessage procedure> + Summary + Write here a summary (1 line) + Description + This is an overloaded function/procedure, if possible you may combine the description + of all these functions into 1 general description. If you do so, combine all "Parameter" + lists into 1 list, and leave the "Summary", "Description" etc. fields empty for all + other overloaded functions with the same name. + Parameters + Instance - Description for this parameter + Msg - Description for this parameter + See Also + List here other properties, methods (comma seperated) + Remove the 'See Also' section if there are no references + ---------------------------------------------------------------------------------------------------- @@InheritMsg@TControl@Integer <TITLE InheritMsg function> *************** *** 413,418 **** Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@InheritMsg@TControl@Integer@Integer@Integer ! <COMBINE InheritMsg@TControl@Integer> ---------------------------------------------------------------------------------------------------- @@ShiftStateToKeyData --- 482,523 ---- Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- ! @@InheritMsgEx@TControl@Integer@Integer@Integer ! <TITLE InheritMsgEx function> ! Summary ! Write here a summary (1 line) ! Description ! This is an overloaded function/procedure, if possible you may combine the description ! of all these functions into 1 general description. If you do so, combine all "Parameter" ! lists into 1 list, and leave the "Summary", "Description" etc. fields empty for all ! other overloaded functions with the same name. ! Parameters ! Instance - Description for this parameter ! Msg - Description for this parameter ! WParam - Description for this parameter ! LParam - Description for this parameter ! See Also ! List here other properties, methods (comma seperated) ! Remove the 'See Also' section if there are no references ! ---------------------------------------------------------------------------------------------------- ! @@IPerformControl ! Summary ! Write here a summary (1 line) ! Description ! Write here a description ! ---------------------------------------------------------------------------------------------------- ! @@IPerformControl.Perform ! Summary ! Write here a summary (1 line) ! Description ! Write here a description ! Parameters ! Msg - Description for this parameter ! WParam - Description for this parameter ! LParam - Description for this parameter ! Return value ! Describe here what the function returns ! See Also ! List here other properties, methods (comma seperated) ! Remove the 'See Also' section if there are no references ---------------------------------------------------------------------------------------------------- @@ShiftStateToKeyData *************** *** 512,516 **** ---------------------------------------------------------------------------------------------------- @@TJvExControl.AboutJVCL ! <INCLUDE JVCL.Main.AboutJVCL.dtx> ---------------------------------------------------------------------------------------------------- @@TJvExControl.OnMouseEnter --- 617,639 ---- ---------------------------------------------------------------------------------------------------- @@TJvExControl.AboutJVCL ! <INCLUDE JVCL.Main.AboutJVCL.dtx> ! ---------------------------------------------------------------------------------------------------- ! @@TJvExControl.HintColor ! Summary ! Determines the color of the hint boxes for the Help Hints for the <xxx>. ! Description ! Use HintColor to specify the hint box color. A default color value of clInfoBk is set for the ! HintColor property in the constructor when the application is created. To change the HintColor ! assign it a new TColor value. ! See Also ! HotTrack ! ---------------------------------------------------------------------------------------------------- ! @@TJvExControl.MouseOver ! Summary ! Indicates whether the mouse pointer is over the <xxx>. ! Description ! Read MouseOver to determine whether the mouse pointer is over the <xxx>. ! See Also ! OnMouseEnter, OnMouseLeave ---------------------------------------------------------------------------------------------------- @@TJvExControl.OnMouseEnter *************** *** 533,536 **** --- 656,665 ---- OnMouseEnter ---------------------------------------------------------------------------------------------------- + @@TJvExControl.OnParentColorChange + Summary + Occurs when the color property for the parent of the control changes. + Description + \Write an OnParentColorChange event to take specific action when the ParentColor property changes. + ---------------------------------------------------------------------------------------------------- @@TJvExCustomControl Summary *************** *** 543,547 **** ---------------------------------------------------------------------------------------------------- @@TJvExCustomControl.AboutJVCL ! <INCLUDE JVCL.Main.AboutJVCL.dtx> ---------------------------------------------------------------------------------------------------- @@TJvExCustomControl.OnMouseEnter --- 672,694 ---- ---------------------------------------------------------------------------------------------------- @@TJvExCustomControl.AboutJVCL ! <INCLUDE JVCL.Main.AboutJVCL.dtx> ! ---------------------------------------------------------------------------------------------------- ! @@TJvExCustomControl.HintColor ! Summary ! Determines the color of the hint boxes for the Help Hints for the <xxx>. ! Description ! Use HintColor to specify the hint box color. A default color value of clInfoBk is set for the ! HintColor property in the constructor when the application is created. To change the HintColor ! assign it a new TColor value. ! See Also ! HotTrack ! ---------------------------------------------------------------------------------------------------- ! @@TJvExCustomControl.MouseOver ! Summary ! Indicates whether the mouse pointer is over the <xxx>. ! Description ! Read MouseOver to determine whether the mouse pointer is over the <xxx>. ! See Also ! OnMouseEnter, OnMouseLeave ---------------------------------------------------------------------------------------------------- @@TJvExCustomControl.OnMouseEnter *************** *** 564,567 **** --- 711,720 ---- OnMouseEnter ---------------------------------------------------------------------------------------------------- + @@TJvExCustomControl.OnParentColorChange + Summary + Occurs when the color property for the parent of the control changes. + Description + \Write an OnParentColorChange event to take specific action when the ParentColor property changes. + ---------------------------------------------------------------------------------------------------- @@TJvExGraphicControl Summary *************** *** 574,578 **** ---------------------------------------------------------------------------------------------------- @@TJvExGraphicControl.AboutJVCL ! ... [truncated message content] |