[JVCL-Checkins] CVS: dev/help JvCalculatorBox.dtx,1.1,1.2

[Marcel B. <jed...@us...>]

Update of /cvsroot/jvcl/dev/help
In directory usw-pr-cvs1:/tmp/cvs-serv28543/dev/help

Modified Files:
	JvCalculatorBox.dtx 
Log Message:
* Added documentation for TJvCalculatorBox


Index: JvCalculatorBox.dtx
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JvCalculatorBox.dtx,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** JvCalculatorBox.dtx	24 May 2002 06:41:19 -0000	1.1
--- JvCalculatorBox.dtx	16 Jun 2002 11:20:55 -0000	1.2
***************
*** 1,45 ****
! ================================================================
  @@JvCalculatorBox.pas
! Note:
! <B>Delphi Versions:</B> <COLOR Brown>5, 6</COLOR> <B> 
! 
! C++ Builder Versions:</B> <COLOR Brown>none</COLOR>
! 
! Conditions:
! The contents of this file are subject to the Mozilla Public License Version 1.1 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/MPL-1.1.html
! 
! Author:
! Sebastien Buysse
! 
! Version:
! 1.20 Beta
! 
! ================================================================
  @@TJvCalculatorBox
! Description:
! This component is a small box that displays a calculator when you press the JvButton.
! 
! ================================================================
! @@TJvCalculatorBox.FLastValue
! 
! ================================================================
! @@TJvCalculatorBox.BtnClick@TObject
! 
! ================================================================
! @@TJvCalculatorBox.Create@TComponent
! 
! ================================================================
! @@TJvCalculatorBox.GetFileName
! 
! ================================================================
! @@TJvCalculatorBox.PostEdit@TObject
! 
! ================================================================
! @@TJvCalculatorBox.PreEdit@TObject
! 
! ================================================================
! @@TJvCalculatorBox.SetFileName@Extended
  
! ================================================================
  @@TJvCalculatorBox.Value
  
--- 1,66 ----
! ----------------------------------------------------------------------------------------------------
! @@$TJvCalculatorBox
! <TITLE TJvCalculatorBox overview>
! <GROUP JVCL.Edits>
!   TJvCalculatorBox encapsulates an edit and a button. When the button is clicked, a calculator
!   dialog is displayed to allow for calculated values to be entered.
! ----------------------------------------------------------------------------------------------------
  @@JvCalculatorBox.pas
! Summary
!   Contains all code for TJvCalculatorBox
! <INCLUDE JVCL.UnitText.dtx>
! Author
!   Sébastien Buysse
! ----------------------------------------------------------------------------------------------------
  @@TJvCalculatorBox
! <GROUP TJvCalculatorBox>
! Summary
!   Encapsulates and edit box with a calculator button.
! Description
!   TJvCalculatorBox encapsulates an edit and a button. When the button is clicked, a calculator
!   dialog is displayed to allow for calculated values to be entered.
! ----------------------------------------------------------------------------------------------------
! @@TJvCalculatorBox.BtnClick
! Summary
!   Responds to clicking the button.
! Description
!   BtnClick is called when the user clicks the button.
  
!   BtnClick is overriden to show the calculator common dialog.
! Parameters
!   Sender - Reference to the control generating the event. This can be either the internal button or
!            Self.
! See Also
!   Button, Execute
! ----------------------------------------------------------------------------------------------------
! @@TJvCalculatorBox.PostEdit
! Summary
!   Called when the edit control loses focus.
! Description
!   PostEdit is called when focus shifts from the edit control. PostEdit will check if the edit text
!   contains a valid floating point value. If this is not the case, the previous (valid) value is
!   displayed and a error beep is played. If the value is valid, it is stored in the Value property.
! Parameters
!   Sender - Reference to the edit control.
! See Also
!   PreEdit, Value
! ----------------------------------------------------------------------------------------------------
! @@TJvCalculatorBox.PreEdit
! Summary
!   Called when the edit control receives focus.
! Description
!   PreEdit is called when focus shifts to the edit control. Preedit will save the current value so it
!   can be restored when an invalid value is detected when focus shifts away from the edit control.
! Parameters
!   Sender - Reference to the edit control.
! See Also
!   PostEdit, Value
! ----------------------------------------------------------------------------------------------------
  @@TJvCalculatorBox.Value
+ Summary
+   The current value of the edit.
+ Description
+   Value holds the current floating point value of the control. Read Value to retrieve the current
+   value or set it to a new value.
+ ----------------------------------------------------------------------------------------------------