paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-21 14:39:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: some control updates

Browse Source 
git-svn-id: trunk@24695 -
This commit is contained in:
dodi 2010-04-18 15:07:55 +00:00
parent 7295a7d531
commit 2fd686685e
4 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/xml/lcl/controls.xml
View File

@ -296,7 +296,31 @@
</element>
<!-- enumeration type Visibility: default -->
<element name="TAlign">
<short>TAlign - enumerated type listing the available options for aligning a Control</short>
<short>Alignment options for a control, within its parent control.</short>
<descr>
<p>
<dl>
<dt>alNone</dt>
<dd>fixed position and extent</dd>
<dt>alTop</dt>
<dd>stacked at top, full width</dd>
<dt>alBottom</dt>
<dd>stacked at bottom, full width</dd>
<dt>alLeft</dt>
<dd>stacked at left, full height</dd>
<dt>alRight</dt>
<dd>stacked at right, full height</dd>
<dt>alClient</dt>
<dd>filling entire remaining client area</dd>
<dt>alCustom</dt>
<dd>other alignment, in drag-dock: notebook</dd>
</dl>
</p>
<p>At most one control can have alClient alignment.</p>
<p>The order of multiple controls of the same (stackable) alignment is determined by their Left or Top coordinate.</p>
<p>The precedence of conflicting alignment requests (e.g. one at top, one at right) is resolved [how???]</p>
<p>[which provisions exist for alCustom implementation?]</p>
</descr>
</element>
<!-- enumeration value Visibility: default -->
<element name="TAlign.alNone">
@ -1445,7 +1469,7 @@ dmFindTarget: find child control under the mouse
</element>
<!-- object Visibility: default -->
<element name="TDragObject">
<short>Base class for managing drag operations and feedback</short>
<short>Base class for managing drag operations and feedback.</short>
<descr>
<p>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.</p>
<p>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 <link id="TControl.OnStartDrag"/> or <link id="TControl.OnStartDock"/> handlers of the source control (being dragged).</p>
@ -2252,6 +2276,7 @@ dmFindTarget: find child control under the mouse
</descr>
<seealso>
<link id="TDockTree"/>
<link id="TDockManager"/>
</seealso>
</element>
<!-- procedure Visibility: default -->
@ -2345,6 +2370,7 @@ dmFindTarget: find child control under the mouse
<p>This method updates DockRect for the visual feedback, when a control is dragged over the docksite.</p>
<p>The Delphi compatible version only can use the parameters determined by the default processing in the docksite.</p>
<p>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.</p>
<p>The DragDockObject.DockRect spans the entire DockSite.</p>
</descr>
<errors/>
<seealso>
@ -5205,9 +5231,8 @@ dmFindTarget: find child control under the mouse
</element>
<!-- function Visibility: protected -->
<element name="TControl.GetClientOrigin">
<short>Returns the screen coordinates of the control's client origin</short>
<short>Returns the screen coordinates of the control's origin.</short>
<descr>
<p>Returns the screen coordinates of the client area origin.</p>
<p>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.</p>
@ -7854,7 +7879,7 @@ Does nothing but call ChangeBounds.</descr>
</element>
<!-- property Visibility: public -->
<element name="TControl.BoundsRect">
<short>Determines the rectangle bounding this control (read/write)</short>
<short>The TopLeft and BottomRight of the control in client coordinates.</short>
<descr>
<p>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.</p>
<p>Set BoundsRect to move the control.</p>
@ -17005,9 +17030,9 @@ bounds to the wanted position and sends a move message to the interface. It is u
<element name="TDockManager.GetDockEdge">
<short>Determine the DropAlign.</short>
<descr>
<p>ADockObject contains valid DragTarget, DragPos and DragTargetPos relative dock site.</p>
<p>ADockObject contains valid DragTarget, DragPos and DragTargetPos relative dock site. DockRect is undetermined.</p>
<p>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).</p>
</p>
<p>Returns True if ADockObject.DropAlign has been determined. If False, the DropAlign has to be determined by default procedures.</p>
</descr>
</element>

2
docs/xml/lcl/forms.xml
View File

@ -4260,7 +4260,7 @@ biHelp - When you click this button a Question Cursor appears and the help routi
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TForm.Position" link="#LCL.Forms.TCustomForm.Position">
<element name="TForm.Position">
<short/>
<descr/>
<seealso/>

6
docs/xml/lcl/lclproc.xml
View File

@ -689,12 +689,6 @@
</element>
<!-- procedure Visibility: default -->
<element name="DebugLn">
<short>Writes a line to the debug output.</short>
<descr>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=&lt;myfile.txt&gt; parameter on the command line of the application. Then the output is written to &lt;myfile.txt&gt;</descr>
<errors/>
<seealso/>
</element>

21
docs/xml/lcl/stdctrls.xml
View File

@ -7509,26 +7509,7 @@ is done automatically by the streaming system.
<seealso/>
</element>
<!-- object Visibility: default -->
<element name="TButton">
<short>
<var>TButton:</var>
Base type for all Buttons. A push button control</short>
<descr>
<p>
<var>TButton:</var>
Base type for all Buttons. A push button control.</p>
<p>The user pushes a button (eg selects it with the mouse cursor and clicks the mouse) to start an action.</p>
</descr>
<seealso>
<link id="HowToUseStdCtrls"/>
</seealso>
</element>
<element name="TButton"/>
<!-- procedure Visibility: public -->
<element name="TButton.Click" link="#LCL.Controls.TControl.Click">
<descr>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.