From e358f1d96e605376aff0f8ee85b1dfba290307f0 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Wed, 5 Dec 2007 11:11:35 +0000 Subject: [PATCH] LazDoc - corrections to Controls and ComCtrls git-svn-id: trunk@13162 - --- docs/xml/lcl/comctrls.xml | 2 +- docs/xml/lcl/controls.xml | 32 ++++++++++++++++++-------------- 2 files changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 43177ba880..80047da062 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -6888,7 +6888,7 @@ To add, change or delete a column use the Columns property. -

ImageIndex

- the index value of the image from the imagelist to be used with this button + ImageIndex - the index value of the image from the imagelist to be used with this button diff --git a/docs/xml/lcl/controls.xml b/docs/xml/lcl/controls.xml index 01562927bc..0b6f75fe19 100644 --- a/docs/xml/lcl/controls.xml +++ b/docs/xml/lcl/controls.xml @@ -4040,14 +4040,16 @@ mrLast=mrYesToAll=10 CalculatePreferredSize - find default/preferred height and width -

CalculatePreferredSize - find default/preferred height and width

procedure TControl.CalculatePreferredSize 
-        (var PreferredWidth, PreferredHeight: integer; 
-          WithThemeSpace: Boolean);

Calculates the default/preferred width and height for a control, which is used +

CalculatePreferredSize - find default/preferred height and width

procedure TControl.CalculatePreferredSize

+

(var PreferredWidth, PreferredHeight: integer; WithThemeSpace: Boolean);

+

Calculates the default/preferred width and height for a control, which is used by the LCL autosizing algorithms as default size. Only positive values are valid. Negative or 0 are treated as undefined and the LCL uses other sizes - instead.

TWinControl overrides this and asks the interface for theme dependent values. - See TWinControl.CalculatePreferredSize for more information.

WithThemeSpace: If true, adds space for stacking.

For example: TRadioButton has a minimum size. But for stacking multiple TRadioButtons there should be - some space around. This space is theme dependent, so the parameter is passes to the widgetset

+ instead.

+

TWinControl overrides this and asks the interface for theme dependent values. + See TWinControl.CalculatePreferredSize for more information.

+

WithThemeSpace: If true, adds space for stacking.

For example: TRadioButton has a minimum size. But for stacking multiple TRadioButtons there should be + some space around. This space is theme dependent, so the parameter is passed to the widgetset

. @@ -5182,7 +5184,7 @@ mrLast=mrYesToAll=10 -

ParentShowHint

- does the control adopt the same hinting behaviour as its parent? Default is true + ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true @@ -5406,7 +5408,7 @@ mrLast=mrYesToAll=10

TControl.AdjustSize calls DoAutoSize in a smart fashion.

During loading and handle creation the calls are delayed.

-

This method initially does the same as TWinControl.DoAutoSize. But since DoAutoSize is commonly overriden by descendant components, it is not useful to perform all tests, which can result in too much overhead. To reduce this the LCL calls

AdjustSize

instead.

+

This method initially does the same as TWinControl.DoAutoSize. But since DoAutoSize is commonly overriden by descendant components, it is not useful to perform all tests, which can result in too much overhead. To reduce this the LCL calls AdjustSize instead.

 @@ -5594,11 +5596,13 @@ mrLast=mrYesToAll=10 EditingDone - what to do when you have finished editing -

TControl.EditingDone -

Called when user has finished editing. This procedure can be used by data links to commit the changes

. -

For example:

  • When focus switches to another control (default)
    • +

    TControl.EditingDone

    +

    Called when user has finished editing. This procedure can be used by data links to commit the changes

    . +

    For example:

    +
    • When focus switches to another control (default)
    • When user selected another item
      • -

    It's totally up to the control, what events will commit.

     +
+

It's totally up to the control, what events will commit.

 @@ -6061,8 +6065,8 @@ introduced. These functions interface with the LCLInterface.

To keep things optimal, LCL implementations should always override RealGet/SetText. Get/SetTextBuf is only kept for compatibility.

- - + +