paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-09 14:16:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

LazDoc - removed several descriptions form TButton in StdCtrls because they are defined in ancestor classes. Some consequential changes in Graphics and Controls

Browse Source 
git-svn-id: trunk@13149 -
This commit is contained in:
kirkpatc 2007-12-04 23:47:43 +00:00
parent 1c17f82235
commit 0ba21c80a8
3 changed files with 40 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8560,15 +8560,11 @@ Reads or writes a flag to find or store the identity of the parent for this cont
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TWinControl.OnEnter"> <element name="TWinControl.OnEnter">
<short/> <short><i>OnEnter</i> - event handler for when the mouse enters the control, and the control receives focus</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TWinControl.OnExit"> <element name="TWinControl.OnExit">
<short/> <short><i>OnExit</i> - event handler for when the mouse leaves the control and it loses focus</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TWinControl.OnKeyDown"> <element name="TWinControl.OnKeyDown">

41
docs/xml/lcl/graphics.xml
View File

@ -234,12 +234,13 @@
</element> </element>
<!-- constant Visibility: default --> <!-- constant Visibility: default -->
<element name="DefFontData"> <element name="DefFontData">
<short><i>Data</i> about the <i>Default Font</i> in the current context</short> <short><i>Default Data</i> for any new <i>Font</i></short>
<descr>New TFont instances are initialized with the values in this structure.<br/> <descr>
About font default values: The default font is chosen by the interfaces depending on the context. <br/> <p>New <i>TFont</i> instances are initialized with the values in this structure.</p>
For example, there can be a different default font for a button and a groupbox.</descr> <p>About font default values: The default font is chosen by the interfaces depending on the context. </p>
<seealso><link id="TFontData">TFontData </link> <p>For example, there can be a different default font for a button and a groupbox.</p>
</seealso> </descr>
<seealso><link id="TFontData"/></seealso>
</element> </element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TTextLayout"> <element name="TTextLayout">
@ -1543,9 +1544,11 @@ Since FPC 2.0 the LCL uses TFPCanvasHelper as ancestor.</descr>
<element name="TFontHandleCache.Add.LongFontName"><short/></element> <element name="TFontHandleCache.Add.LongFontName"><short/></element>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TFont"> <element name="TFont">
<short>The <i>Font</i> to be used for drawing <i>Text</i></short> <short>The <i>Font</i> to be used for drawing <i>Text</i></short>
<descr>Most of the data about the font are dealt with by the protected procedures GetData and SetData which operate on TFontData<br/> <descr>
Individual properties such as Character Set, colour and size can be accessed in the public area</descr> <p>Most of the data about the font are dealt with by the protected procedures GetData and SetData which operate on TFontData</p>
<p>Individual properties such as Character Set, colour and size can be accessed in the public area</p>
</descr>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TFont.FCanUTF8"> <element name="TFont.FCanUTF8">
@ -1812,12 +1815,9 @@ Individual properties such as Character Set, colour and size can be accessed in
</element> </element>
<!-- procedure Visibility: public --> <!-- procedure Visibility: public -->
<element name="TFont.Assign"> <element name="TFont.Assign">
<short><i>Assign</i> - copies the <i>LogFont</i> or <i>Source</i> settings to itself</short> <short><i>Assign</i> - copies the <i>LogFont</i> or <i>Source</i> settings to itself</short>
<descr>Method: TFont.Assign<br/> <descr><p>Method: <i>TFont.Assign</i></p><p>Params: <i>ALogFont</i>: TLogFont or</p><p><i>Source</i>: another font</p><p>Returns: nothing</p>
Params: <i>ALogFont</i>: TLogFont or <i>Source</i>: another font<br/>
Returns: nothing<br/>
Copies the logfont or source settings to itself</descr> Copies the logfont or source settings to itself</descr>
</element> </element>
@ -1893,9 +1893,7 @@ Copies the logfont or source settings to itself</descr>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TFont.Height"> <element name="TFont.Height">
<short/> <short>The <i>Height</i> of the current Font</short>
<descr/>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TFont.Name"> <element name="TFont.Name">
@ -2326,8 +2324,9 @@ Default is psSolid</descr>
<!-- object Visibility: default --> <!-- object Visibility: default -->
<element name="TRegion"> <element name="TRegion">
<short>A defined <i>Region</i> on the screen, in which text is written</short> <short>A defined <i>Region</i> on the screen, in which text is written</short>
<seealso><link id="TRegionData">TRegionData (in same Unit)</link> <seealso>
</seealso> <link id="TRegionData">TRegionData (in same Unit)</link>
</seealso>
</element> </element>
<!-- variable Visibility: private --> <!-- variable Visibility: private -->
<element name="TRegion.FRegionData"> <element name="TRegion.FRegionData">
@ -2395,11 +2394,9 @@ Default is psSolid</descr>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TRegion.Handle"> <element name="TRegion.Handle">
<short>Operating System <i>Handle</i> for this <i>Region</i></short> <short>Operating System <i>Handle</i> for this <i>Region</i></short>
<seealso> <seealso>
<link id="#lcl.lcltype.HRGN">HRGN </link> <link id="#lcl.lcltype.HRGN">HRGN </link>
<link id="#rtl.sysutils.thandle">THandle </link> <link id="#rtl.sysutils.thandle">THandle </link>
</seealso> </seealso>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->

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

@ -5827,8 +5827,9 @@ False is set when the edit or combobox control looses focus.
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomButton.Default"> <element name="TCustomButton.Default">
<short>Is this the Default button? (default setting is False)</short> <short>Is this the Default button? (default setting is False)</short>
<descr/> <descr>
<seealso/> <p>Defines if a button is the <i>Default</i> on a form. That is, pressing ENTER will execute its onClick method, whether the control has focus or not!</p>
</descr>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomButton.ModalResult"> <element name="TCustomButton.ModalResult">
@ -5839,8 +5840,9 @@ False is set when the edit or combobox control looses focus.
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomButton.Cancel"> <element name="TCustomButton.Cancel">
<short>Is this the Cancel button? (default setting is False)</short> <short>Is this the Cancel button? (default setting is False)</short>
<descr/> <descr>
<seealso/> <p>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked, even if the button does not have focus. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</p>
</descr>
</element> </element>
<!-- property Visibility: public --> <!-- property Visibility: public -->
<element name="TCustomButton.Color"> <element name="TCustomButton.Color">
@ -5869,29 +5871,13 @@ False is set when the edit or combobox control looses focus.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Action"> <element name="TButton.Action"/>
<short>The action executed when the user clicks the button.</short>
<descr>If you assign an action from an ActionList to a TButton.Action the corresponding execute-method is assigned to the OnClick event of the button. </descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Align"> <element name="TButton.Align"/>
<short/>
<descr><br/></descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Anchors"> <element name="TButton.Anchors"/>
<short>Anchors are used to keep a button on a defined distance to certain borders of the parent control.</short>
<descr>Anchors can be used to keep control at a certain distance from a side of its parent control, when the parent control is resized.</descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.AutoSize"> <element name="TButton.AutoSize"/>
<short>Autosize in </short>
<descr>If this property is set to true, the control will automatically adapt its size to be able to accomodate its content. </descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.BidiMode"> <element name="TButton.BidiMode">
<short/> <short/>
@ -5899,17 +5885,9 @@ False is set when the edit or combobox control looses focus.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.BorderSpacing"> <element name="TButton.BorderSpacing"/>
<short>The fixed spacing around the border of the Button</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Cancel"> <element name="TButton.Cancel"/>
<short>Setting this property will make the OnClick event executed when the user hits ESC.</short>
<descr>Setting this property to true, will have the effect that when the user hits ESC this button is Clicked. Usually the Button which reacts to ESC sets the ModalResult of the form to mrCancel.</descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Caption"> <element name="TButton.Caption">
<short>Sets the text displayed on the button.</short> <short>Sets the text displayed on the button.</short>
@ -5930,11 +5908,7 @@ False is set when the edit or combobox control looses focus.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Default"> <element name="TButton.Default"/>
<short>Setting this property will make the OnClick event executed when the user hits ENTER</short>
<descr>Defines if a button is the default on a form. That is, pressing enter will execute its onClick wether the control has focus or not!</descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.DragCursor"> <element name="TButton.DragCursor">
<short/> <short/>
@ -5948,11 +5922,7 @@ False is set when the edit or combobox control looses focus.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Enabled"> <element name="TButton.Enabled"/>
<short>Determines if the button reacts to a click.</short>
<descr>Setting this property determines if the control can be used. </descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Font"> <element name="TButton.Font">
<short>Font is used to set the font of the caption of the Button.</short> <short>Font is used to set the font of the caption of the Button.</short>
@ -5979,9 +5949,7 @@ False is set when the edit or combobox control looses focus.
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.OnClick"> <element name="TButton.OnClick">
<short>The OnClick event is triggered when a user clicks on the button</short>
<descr>The OnClick event is triggered when a user clicks on the button. It can also be invoked by calling the Click method.</descr> <descr>The OnClick event is triggered when a user clicks on the button. It can also be invoked by calling the Click method.</descr>
<seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.OnDragDrop"> <element name="TButton.OnDragDrop">
@ -6002,19 +5970,9 @@ False is set when the edit or combobox control looses focus.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.OnEnter"> <element name="TButton.OnEnter"/>
<short>The OnEnter event is triggered when the button gets focus.</short>
<descr>The OnEnter event is triggered when the button gets focus.
</descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.OnExit"> <element name="TButton.OnExit"/>
<short>The OnExit event is triggered when the button loses focus.</short>
<descr>The OnExit event is triggered when the button loses focus.
</descr>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.OnKeyDown"> <element name="TButton.OnKeyDown">
<short/> <short/>
@ -6100,23 +6058,11 @@ False is set when the edit or combobox control looses focus.
<seealso/> <seealso/>
</element> </element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.TabOrder"> <element name="TButton.TabOrder"/>
<short>TabOrder - an integer value to show where the button lies in the Tab Order for this Form</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.TabStop"> <element name="TButton.TabStop"/>
<short>Boolean to determine whether the Button is associated with a Tab Stop in the Tab Order for the form</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published --> <!-- property Visibility: published -->
<element name="TButton.Visible"> <element name="TButton.Visible"/>
<short>Determines whether the Button is visible.</short>
<descr/>
<seealso/>
</element>
<!-- enumeration type Visibility: default --> <!-- enumeration type Visibility: default -->
<element name="TCheckBoxState"> <element name="TCheckBoxState">
<short>Check Box State</short> <short>Check Box State</short>