[JVCL-Checkins] CVS: dev/help JvCaptionButton.dtx,NONE,1.1 JVCL.dox,1.16,1.17

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

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

Modified Files:
	JVCL.dox 
Added Files:
	JvCaptionButton.dtx 
Log Message:
* Added TJvCaptionButton documentation.

--- NEW FILE: JvCaptionButton.dtx ---
----------------------------------------------------------------------------------------------------
@@$TJvCaptionButton
<TITLE TJvCaptionButton overview>
<GROUP JVCL.Buttons>
  TJvCaptionButton encapsulates a button that is placed in the form's caption, muck like the
  standard minimize, maximize and close buttons.

  To use a caption button
  * drop a TJvCaptionButton on a form.
  * Specify if it is shown as a standard button.
  * If it's not a standard button, specify a caption and/or bitmap.
----------------------------------------------------------------------------------------------------
@@JvCaptionButton.pas
Summary
  Contains all code for TJvCaptionButton.
<INCLUDE JVCL.UnitText.dtx>
Author
  Peter Thörnqvist
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton
<GROUP TJvCaptionButton>
Summary
  Button that is added to the form caption.
Description
  TJvCaptionButton encapsulates a button that is placed in the form's caption, muck like the
  standard minimize, maximize and close buttons.
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Alignment
Summary
  Determines how the caption is aligned in the button.
Description
  Alignment indicates how the caption should be aligned in the button. It is only used for
  non-standard buttons (Standard = tsbNone).
See Also
  Caption, Standard, ButtonWidth
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.ButtonHeight
Summary
  Determines the height of the button.
Description
  ButtonHeight determines the height of the button.
See Also
  ButtonWidth
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.ButtonLeft
Summary
Description
See Also
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.ButtonTop
Summary
Description
See Also
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.ButtonWidth
Summary
  Determines the width of the button.
Description
  ButtonWidth determines the width of the button.
See Also
  ButtonHeight
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Caption
Summary
  The text to display in the button
Description
  Caption holds the text to display in the button. Only non-standard buttons (Standard = tsbNone)
  can have a custom caption.
See Also
  Alignment, Font, Glyph, Standard
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Down
Summary
  Determines the state of the button.
Description
  Down determines if the button is pressed (True) or not (False). Down is a read only property and
  can only be controlled through the UI.

  If Toggle is set to True, Down will toggle from False to True and vice versa each time it the
  button is clicked.

  If Toggle is set to False, Down will be True when the left mouse button is down and will revert
  to False when the left mouse button is released.
See Also
  Toggle, OnClick
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Font
Summary
  Determines the font in which the caption is written.
Description
  Font is the font used to write the caption. Only non-standard buttons (Standard = tsbNone) can
  have a custom caption.
See Also
  Caption, Standard
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Glyph
Summary
  Determines the bitmap to show.
Description
  Glyph is the image to render on the button's canvas. Glyph should contain a single image, and can
  not contain multiple glyphs as in TSpeedButton. Only non-standard buttons (Standard = tsbNone) can
  have a glyph.
See Also
  Standard
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.MouseDown
Summary
  Called when a mouse button is pressed.
Description
  MouseDown is called when a mouse button is pressed. If an OnMouseDown event handler has been
  assigned, it will be called.
Parameters
  Button - The mouse button pressed.
  Shift  - The shift state when the button was pressed.
  X      - The X position where the button was pressed, relative to upper left corner of the control.
  Y      - The Y position where the button was pressed, relative to upper left corner of the control.
See Also
  MouseUp, OnMouseDown
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.MouseUp
Summary
  Called when a mouse button is released.
Description
  MouseUp is called when a mouse button is released. If an OnMouseUp event handler has been
  assigned, it will be called.
Parameters
  Button - The mouse button released.
  Shift  - The shift state when the button was released.
  X      - The X position where the button was released, relative to upper left corner of the
           control.
  Y      - The Y position where the button was released, relative to upper left corner of the
           control.
See Also
  MouseDown, OnMouseUp
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.OnClick
Summary
Description
See Also
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.OnMouseDown
Summary
  Occurs when the user presses a mouse button.
Description
  Write an OnMouseDown event handler to respond to mouse button presses over the control.
See Also
  OnMouseUp
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.OnMouseUp
Summary
  Occurs when the user presses a mouse button.
Description
  Write an OnMouseDown event handler to respond to mouse button presses over the control.
See Also
  OnMouseUp
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.ResetButton
Summary
  Resets the button internals.
Description
  ResetButton removes and recreates the hooks into the windows message queue.

  Use this method to reinitialize the button messages.
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Standard
Summary
  Determines the type of caption button.
Description
  Standard determines the type of caption button to use. When set to tsbNone, it is a custom button
  with a custom Caption and Glyph. Otherwise it's a standard button, such as Minimize or Close in
  the way it is rendered. It will not have the standard behaviour of the button.
See Also
  TJvStandardButton
----------------------------------------------------------------------------------------------------
@@TJvCaptionButton.Toggle
Summary
  Determines if the button is a push button or a switch.
Description
  Toggle determines if the button functions as a normal push button or as a switch.

  If Toggle is set to True, Down will toggle between True and False every time the user clicks the
  button.

  If Toggle is set to False, Down will be set to True when the left mouse button is pressed and set
  to False when the mouse button is released.
See Also
  Down
----------------------------------------------------------------------------------------------------
@@TJvStandardButton
<GROUP TJvCaptionButton>
Summary
  Used to specify the kind of caption button.
Description
  The TJvStandardButton type is used to specify the type of caption button to draw.
See also
  TJvCaptionButton
@@TJvStandardButton.tsbNone
  The caption button is not a standard button.
@@TJvStandardButton.tsbClose
  The caption button is a close button.
@@TJvStandardButton.tsbHelp
  The caption button is a help button.
@@TJvStandardButton.tsbMax
  The caption button is a maximizing button.
@@TJvStandardButton.tsbMin
  The caption button is a minimizing button.
@@TJvStandardButton.tsbRestore
  The caption button is a restore button.
----------------------------------------------------------------------------------------------------
@@htCaptionButton
<GROUP TJvCaptionButton>
Summary
  WMNCHITTEST constant.
Description
  htCaptionButton is a WMNCHITTEST constant signaling the point lies in the caption button's client
  rectangle.
See also
  TJvCaptionButton
----------------------------------------------------------------------------------------------------


Index: JVCL.dox
===================================================================
RCS file: /cvsroot/jvcl/dev/help/JVCL.dox,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -d -r1.16 -r1.17
*** JVCL.dox	19 Jun 2002 17:17:53 -0000	1.16
--- JVCL.dox	19 Jun 2002 20:16:19 -0000	1.17
***************
*** 10,14 ****
  
  [Source Files]
! Count=26
  File0=..\..\jvcl\source\JvAlarms.pas
  File1=..\..\jvcl\source\JvAlignedEdit.pas
--- 10,14 ----
  
  [Source Files]
! Count=27
  File0=..\..\jvcl\source\JvAlarms.pas
  File1=..\..\jvcl\source\JvAlignedEdit.pas
***************
*** 26,40 ****
  File13=..\..\jvcl\source\JvCalculator.pas
  File14=..\..\jvcl\source\JvCalculatorBox.pas
! File15=..\..\jvcl\source\JvCaretEdit.pas
! File16=..\..\jvcl\source\JvComponent.pas
! File17=..\..\jvcl\source\JvCustomBox.pas
! File18=..\..\jvcl\source\JvSafeMode.pas
! File19=..\..\jvcl\source\JvScreenCanvas.pas
! File20=..\..\jvcl\source\JvScrollBar.pas
! File21=..\..\jvcl\source\JvScrollBox.pas
! File22=..\..\jvcl\source\JvScrollEvStringGrid.pas
! File23=..\..\jvcl\source\JvScrollingLabel.pas
! File24=..\..\jvcl\source\JvSearchFile.pas
! File25=..\..\jvcl\source\JvShape.pas
  
  [Source Include Directories]
--- 26,41 ----
  File13=..\..\jvcl\source\JvCalculator.pas
  File14=..\..\jvcl\source\JvCalculatorBox.pas
! File15=..\..\jvcl\source\JvCaptionButton.pas
! File16=..\..\jvcl\source\JvCaretEdit.pas
! File17=..\..\jvcl\source\JvComponent.pas
! File18=..\..\jvcl\source\JvCustomBox.pas
! File19=..\..\jvcl\source\JvSafeMode.pas
! File20=..\..\jvcl\source\JvScreenCanvas.pas
! File21=..\..\jvcl\source\JvScrollBar.pas
! File22=..\..\jvcl\source\JvScrollBox.pas
! File23=..\..\jvcl\source\JvScrollEvStringGrid.pas
! File24=..\..\jvcl\source\JvScrollingLabel.pas
! File25=..\..\jvcl\source\JvSearchFile.pas
! File26=..\..\jvcl\source\JvShape.pas
  
  [Source Include Directories]
***************
*** 42,46 ****
  
  [Description Files]
! Count=41
  File0=JvAlarms.dtx
  File1=JvAlignedEdit.dtx
--- 43,47 ----
  
  [Description Files]
! Count=42
  File0=JvAlarms.dtx
  File1=JvAlignedEdit.dtx
***************
*** 58,87 ****
  File13=JvCalculator.dtx
  File14=JvCalculatorBox.dtx
! File15=JvCaretEdit.dtx
! File16=JVCL.Acknowledge.dtx
! File17=JVCL.FileRef.dtx
! File18=JVCL.FuncRef.dtx
! File19=JVCL.Grp.AlarmsAndTimers.Alarms.dtx
! File20=JVCL.Grp.AlarmsAndTimers.dtx
! File21=JVCL.Grp.AlarmsAndTimers.Timers.dtx
! File22=JVCL.Grp.Buttons.dtx
! File23=JVCL.Grp.CommonDialogs.dtx
! File24=JVCL.Grp.Edits.dtx
! File25=JVCL.Grp.Graphics.Animation.dtx
! File26=JVCL.Grp.Graphics.dtx
! File27=JVCL.Grp.Labels.dtx
! File28=JVCL.Grp.Lists.dtx
! File29=JVCL.Grp.Miscel.dtx
! File30=JVCL.Main.dtx
! File31=JvComponent.dtx
! File32=JvCustomBox.dtx
! File33=JvSafeMode.dtx
! File34=JvScreenCanvas.dtx
! File35=JvScrollBar.dtx
! File36=JvScrollBox.dtx
! File37=JvScrollEvStringGrid.dtx
! File38=JvScrollingLabel.dtx
! File39=JvSearchFile.dtx
! File40=JvShape.dtx
  
  [Description Include Directories]
--- 59,89 ----
  File13=JvCalculator.dtx
  File14=JvCalculatorBox.dtx
! File15=JvCaptionButton.dtx
! File16=JvCaretEdit.dtx
! File17=JVCL.Acknowledge.dtx
! File18=JVCL.FileRef.dtx
! File19=JVCL.FuncRef.dtx
! File20=JVCL.Grp.AlarmsAndTimers.Alarms.dtx
! File21=JVCL.Grp.AlarmsAndTimers.dtx
! File22=JVCL.Grp.AlarmsAndTimers.Timers.dtx
! File23=JVCL.Grp.Buttons.dtx
! File24=JVCL.Grp.CommonDialogs.dtx
! File25=JVCL.Grp.Edits.dtx
! File26=JVCL.Grp.Graphics.Animation.dtx
! File27=JVCL.Grp.Graphics.dtx
! File28=JVCL.Grp.Labels.dtx
! File29=JVCL.Grp.Lists.dtx
! File30=JVCL.Grp.Miscel.dtx
! File31=JVCL.Main.dtx
! File32=JvComponent.dtx
! File33=JvCustomBox.dtx
! File34=JvSafeMode.dtx
! File35=JvScreenCanvas.dtx
! File36=JvScrollBar.dtx
! File37=JvScrollBox.dtx
! File38=JvScrollEvStringGrid.dtx
! File39=JvScrollingLabel.dtx
! File40=JvSearchFile.dtx
! File41=JvShape.dtx
  
  [Description Include Directories]
***************
*** 169,173 ****
  
  [Disabled Topics]
! Count=222
  ID0=TCustomArrow.Create@TComponent
  ID1=TCustomArrow.Destroy
--- 171,175 ----
  
  [Disabled Topics]
! Count=224
  ID0=TCustomArrow.Create@TComponent
  ID1=TCustomArrow.Destroy
***************
*** 316,395 ****
  ID144=TJvCalculator.Create@TComponent
  ID145=TJvCalculatorBox.Create@TComponent
! ID146=TJvCaret.Assign@TPersistent
! ID147=TJvCaret.Create@TCustomEdit
! ID148=TJvCaret.Destroy
! ID149=TJvCaretEdit.Create@TComponent
! ID150=TJvCaretEdit.Destroy
! ID151=TJvCaretMemo.Create@TComponent
! ID152=TJvCaretMemo.Destroy
! ID153=TJvCustomBox.Align
! ID154=TJvCustomBox.BevelEdges
! ID155=TJvCustomBox.BevelInner
! ID156=TJvCustomBox.BevelKind
! ID157=TJvCustomBox.BevelOuter
! ID158=TJvCustomBox.BevelWidth
! ID159=TJvCustomBox.BorderWidth
! ID160=TJvCustomBox.Color
! ID161=TJvCustomBox.Create@TComponent
! ID162=TJvCustomBox.Destroy
! ID163=TJvCustomBox.Enabled
! ID164=TJvCustomBox.OnDockDrop
! ID165=TJvCustomBox.OnDockOver
! ID166=TJvCustomBox.OnEnter
! ID167=TJvCustomBox.OnExit
! ID168=TJvCustomBox.OnGetSiteInfo
! ID169=TJvCustomBox.OnKeyDown
! ID170=TJvCustomBox.OnKeyPress
! ID171=TJvCustomBox.OnKeyUp
! ID172=TJvCustomBox.OnMouseDown
! ID173=TJvCustomBox.OnMouseMove
! ID174=TJvCustomBox.OnMouseUp
! ID175=TJvCustomBox.OnMouseWheel
! ID176=TJvCustomBox.OnMouseWheelDown
! ID177=TJvCustomBox.OnMouseWheelUp
! ID178=TJvCustomBox.OnUnDock
! ID179=TJvCustomBox.ParentShowHint
! ID180=TJvCustomBox.PopupMenu
! ID181=TJvCustomBox.ShowHint
! ID182=TJvCustomBox.TabOrder
! ID183=TJvCustomBox.TabStop
! ID184=TJvCustomBox.Visible
! ID185=TJvSafeMode.LowPower
! ID186=TJvScreenCanvas.Create@TComponent
! ID187=TJvScrollingLabel.Align
! ID188=TJvScrollingLabel.Alignment
! ID189=TJvScrollingLabel.AutoSize
! ID190=TJvScrollingLabel.Color
! ID191=TJvScrollingLabel.Cursor
! ID192=TJvScrollingLabel.DragCursor
! ID193=TJvScrollingLabel.DragMode
! ID194=TJvScrollingLabel.Enabled
! ID195=TJvScrollingLabel.FocusControl
! ID196=TJvScrollingLabel.Font
! ID197=TJvScrollingLabel.Height
! ID198=TJvScrollingLabel.Hint
! ID199=TJvScrollingLabel.Layout
! ID200=TJvScrollingLabel.Left
! ID201=TJvScrollingLabel.OnClick
! ID202=TJvScrollingLabel.OnDblClick
! ID203=TJvScrollingLabel.OnDragDrop
! ID204=TJvScrollingLabel.OnDragOver
! ID205=TJvScrollingLabel.OnEndDrag
! ID206=TJvScrollingLabel.OnMouseDown
! ID207=TJvScrollingLabel.OnMouseMove
! ID208=TJvScrollingLabel.OnMouseUp
! ID209=TJvScrollingLabel.OnStartDrag
! ID210=TJvScrollingLabel.ParentColor
! ID211=TJvScrollingLabel.ParentFont
! ID212=TJvScrollingLabel.ParentShowHint
! ID213=TJvScrollingLabel.PopupMenu
! ID214=TJvScrollingLabel.Resize
! ID215=TJvScrollingLabel.ShowAccelChar
! ID216=TJvScrollingLabel.ShowHint
! ID217=TJvScrollingLabel.Top
! ID218=TJvScrollingLabel.Transparent
! ID219=TJvScrollingLabel.Visible
! ID220=TJvScrollingLabel.Width
! ID221=TJvScrollingLabel.WordWrap
  
  [Manually created Topics]
--- 318,399 ----
  ID144=TJvCalculator.Create@TComponent
  ID145=TJvCalculatorBox.Create@TComponent
! ID146=TJvCaptionButton.Create@TComponent
! ID147=TJvCaptionButton.Destroy
! ID148=TJvCaret.Assign@TPersistent
! ID149=TJvCaret.Create@TCustomEdit
! ID150=TJvCaret.Destroy
! ID151=TJvCaretEdit.Create@TComponent
! ID152=TJvCaretEdit.Destroy
! ID153=TJvCaretMemo.Create@TComponent
! ID154=TJvCaretMemo.Destroy
! ID155=TJvCustomBox.Align
! ID156=TJvCustomBox.BevelEdges
! ID157=TJvCustomBox.BevelInner
! ID158=TJvCustomBox.BevelKind
! ID159=TJvCustomBox.BevelOuter
! ID160=TJvCustomBox.BevelWidth
! ID161=TJvCustomBox.BorderWidth
! ID162=TJvCustomBox.Color
! ID163=TJvCustomBox.Create@TComponent
! ID164=TJvCustomBox.Destroy
! ID165=TJvCustomBox.Enabled
! ID166=TJvCustomBox.OnDockDrop
! ID167=TJvCustomBox.OnDockOver
! ID168=TJvCustomBox.OnEnter
! ID169=TJvCustomBox.OnExit
! ID170=TJvCustomBox.OnGetSiteInfo
! ID171=TJvCustomBox.OnKeyDown
! ID172=TJvCustomBox.OnKeyPress
! ID173=TJvCustomBox.OnKeyUp
! ID174=TJvCustomBox.OnMouseDown
! ID175=TJvCustomBox.OnMouseMove
! ID176=TJvCustomBox.OnMouseUp
! ID177=TJvCustomBox.OnMouseWheel
! ID178=TJvCustomBox.OnMouseWheelDown
! ID179=TJvCustomBox.OnMouseWheelUp
! ID180=TJvCustomBox.OnUnDock
! ID181=TJvCustomBox.ParentShowHint
! ID182=TJvCustomBox.PopupMenu
! ID183=TJvCustomBox.ShowHint
! ID184=TJvCustomBox.TabOrder
! ID185=TJvCustomBox.TabStop
! ID186=TJvCustomBox.Visible
! ID187=TJvSafeMode.LowPower
! ID188=TJvScreenCanvas.Create@TComponent
! ID189=TJvScrollingLabel.Align
! ID190=TJvScrollingLabel.Alignment
! ID191=TJvScrollingLabel.AutoSize
! ID192=TJvScrollingLabel.Color
! ID193=TJvScrollingLabel.Cursor
! ID194=TJvScrollingLabel.DragCursor
! ID195=TJvScrollingLabel.DragMode
! ID196=TJvScrollingLabel.Enabled
! ID197=TJvScrollingLabel.FocusControl
! ID198=TJvScrollingLabel.Font
! ID199=TJvScrollingLabel.Height
! ID200=TJvScrollingLabel.Hint
! ID201=TJvScrollingLabel.Layout
! ID202=TJvScrollingLabel.Left
! ID203=TJvScrollingLabel.OnClick
! ID204=TJvScrollingLabel.OnDblClick
! ID205=TJvScrollingLabel.OnDragDrop
! ID206=TJvScrollingLabel.OnDragOver
! ID207=TJvScrollingLabel.OnEndDrag
! ID208=TJvScrollingLabel.OnMouseDown
! ID209=TJvScrollingLabel.OnMouseMove
! ID210=TJvScrollingLabel.OnMouseUp
! ID211=TJvScrollingLabel.OnStartDrag
! ID212=TJvScrollingLabel.ParentColor
! ID213=TJvScrollingLabel.ParentFont
! ID214=TJvScrollingLabel.ParentShowHint
! ID215=TJvScrollingLabel.PopupMenu
! ID216=TJvScrollingLabel.Resize
! ID217=TJvScrollingLabel.ShowAccelChar
! ID218=TJvScrollingLabel.ShowHint
! ID219=TJvScrollingLabel.Top
! ID220=TJvScrollingLabel.Transparent
! ID221=TJvScrollingLabel.Visible
! ID222=TJvScrollingLabel.Width
! ID223=TJvScrollingLabel.WordWrap
  
  [Manually created Topics]