From 2fd686685e7f920bbd2abbd5e875e054a81c9efb Mon Sep 17 00:00:00 2001 From: dodi Date: Sun, 18 Apr 2010 15:07:55 +0000 Subject: [PATCH] docs: some control updates git-svn-id: trunk@24695 - --- docs/xml/lcl/controls.xml | 39 ++++++++++++++++++++++++++++++++------- docs/xml/lcl/forms.xml | 2 +- docs/xml/lcl/lclproc.xml | 6 ------ docs/xml/lcl/stdctrls.xml | 21 +-------------------- 4 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index fdc5a3ea6c..c6366ac767 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -296,7 +296,31 @@ - TAlign - enumerated type listing the available options for aligning a Control + Alignment options for a control, within its parent control. + +

+

+
alNone
+
fixed position and extent
+
alTop
+
stacked at top, full width
+
alBottom
+
stacked at bottom, full width
+
alLeft
+
stacked at left, full height
+
alRight
+
stacked at right, full height
+
alClient
+
filling entire remaining client area
+
alCustom
+
other alignment, in drag-dock: notebook
+
+

+

At most one control can have alClient alignment.

+

The order of multiple controls of the same (stackable) alignment is determined by their Left or Top coordinate.

+

The precedence of conflicting alignment requests (e.g. one at top, one at right) is resolved [how???]

+

[which provisions exist for alCustom implementation?]

+ @@ -1445,7 +1469,7 @@ dmFindTarget: find child control under the mouse - Base class for managing drag operations and feedback + Base class for managing drag operations and feedback.

Every dragging operation has an associated DragObject, holding references to the source and target controls, and other parameters for the customization of the visual user feedback.

A default DragObject is created automatically when a dragging operation starts, and is destroyed when the operation has ended, so that you must not take special care on it. But an application can provide a customized DragObject in the or handlers of the source control (being dragged).

@@ -2252,6 +2276,7 @@ dmFindTarget: find child control under the mouse + @@ -2345,6 +2370,7 @@ dmFindTarget: find child control under the mouse

This method updates DockRect for the visual feedback, when a control is dragged over the docksite.

The Delphi compatible version only can use the parameters determined by the default processing in the docksite.

The Lazarus specific version can update the DockObject with better suited parameters. A DockManager here can implement any algorithm for the placement of a dropped control. The default implementation calls the Delphi compatible version.

+

The DragDockObject.DockRect spans the entire DockSite.

@@ -5205,9 +5231,8 @@ dmFindTarget: find child control under the mouse - Returns the screen coordinates of the control's client origin + Returns the screen coordinates of the control's origin. -

Returns the screen coordinates of the client area origin.

Note that this value is the position as stored in the interface and is not always in sync with the LCL. When a control is moved, the LCL sets the bounds to the wanted position and sends a move message to the interface. It is up to the interface to handle moves instantly or queued.

@@ -7854,7 +7879,7 @@ Does nothing but call ChangeBounds. - Determines the rectangle bounding this control (read/write) + The TopLeft and BottomRight of the control in client coordinates.

The BoundsRect rectangle describes the TopLeft and BottomRight coordinates of the control, relative to its parent. The values are based on the Top, Left, Width and Height of the control.

Set BoundsRect to move the control.

@@ -17005,9 +17030,9 @@ bounds to the wanted position and sends a move message to the interface. It is u Determine the DropAlign. -

ADockObject contains valid DragTarget, DragPos and DragTargetPos relative dock site.

+

ADockObject contains valid DragTarget, DragPos and DragTargetPos relative dock site. DockRect is undetermined.

DropOnControl may be Nil if nothing has been docked yet, or no target control exists at the mouse coordinates. -DockRect may be unusable in this case (not yet determined).

+

Returns True if ADockObject.DropAlign has been determined. If False, the DropAlign has to be determined by default procedures.

 diff --git a/docs/xml/lcl/forms.xml b/docs/xml/lcl/forms.xml index 9ab0781830..7003605b7c 100644 --- a/docs/xml/lcl/forms.xml +++ b/docs/xml/lcl/forms.xml @@ -4260,7 +4260,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi - + diff --git a/docs/xml/lcl/lclproc.xml b/docs/xml/lcl/lclproc.xml index 937d5b4000..99fabece78 100644 --- a/docs/xml/lcl/lclproc.xml +++ b/docs/xml/lcl/lclproc.xml @@ -689,12 +689,6 @@ - Writes a line to the debug output. - Various overloaded versions of this procedure allow for formatted output etc. - -The default debug output is the console. - -This can be overriden by passing the --debug-log=<myfile.txt> parameter on the command line of the application. Then the output is written to <myfile.txt> diff --git a/docs/xml/lcl/stdctrls.xml b/docs/xml/lcl/stdctrls.xml index 8d8b89b630..ac87acaac9 100644 --- a/docs/xml/lcl/stdctrls.xml +++ b/docs/xml/lcl/stdctrls.xml @@ -7509,26 +7509,7 @@ is done automatically by the streaming system. - - - TButton: - - - - Base type for all Buttons. A push button control - -

- TButton: - - - - Base type for all Buttons. A push button control.

-

The user pushes a button (eg selects it with the mouse cursor and clicks the mouse) to start an action.

- - - - - + If you want to programmatically Click on a button you can call its Click method. This will have the same effect as a user clicking on the button.