mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-26 20:40:36 +02:00
LazControls: Docs. Added, updated topic content, fixed broken "see also" links. Patch by Don Siders, bug #39223.
git-svn-id: trunk@65450 -
This commit is contained in:
maxim
parent
e344dcb11e
commit
89e7021f92
@ -7,6 +7,9 @@
|
||||
<p>
|
||||
<file>checkboxthemed.pas</file> contains classes used to implements a custom-drawn check box control drawn using theme services.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
@ -45,20 +48,28 @@
|
||||
|
||||
<element name="TCheckBoxThemedActionLink.AssignClient">
|
||||
<short>Sets the control used as the client in the action link.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method, and stores the control as a TCustomCheckBoxThemed instance in the member variable used in the class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCheckBoxThemedActionLink.AssignClient.AClient">
|
||||
<short/>
|
||||
<short>The themed check box object that is the client for the action link.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCheckBoxThemedActionLink.SetChecked">
|
||||
<short>Sets the value in Checked for the client control when linked.</short>
|
||||
<short>
|
||||
Sets the value in the Checked property for the client control when linked to the action.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TCheckBoxThemedActionLink.IsCheckedLinked"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCheckBoxThemedActionLink.SetChecked.Value">
|
||||
<short/>
|
||||
<short>New value for the Checked property.</short>
|
||||
</element>
|
||||
|
||||
<!-- public methods -->
|
||||
@ -67,7 +78,9 @@
|
||||
Determines if an Action is linked to the client control and if the Checked values are in sync.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TCheckBoxThemedActionLink.SetChecked"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCheckBoxThemedActionLink.IsCheckedLinked.Result">
|
||||
<short>
|
||||
@ -177,7 +190,7 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.CheckBoxPressed">
|
||||
<short>Internal flag used to track key or mouse state in the control.</short>
|
||||
<short>Member used to track key or mouse state in the control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -206,13 +219,13 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.CalculatePreferredSize.PreferredWidth">
|
||||
<short/>
|
||||
<short>Preferred width calculated in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.CalculatePreferredSize.PreferredHeight">
|
||||
<short/>
|
||||
<short>Preferred height calculated in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.CalculatePreferredSize.WithThemeSpace">
|
||||
<short/>
|
||||
<short>True if additional space is reserved for theming element / details.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.CMBiDiModeChanged">
|
||||
@ -234,8 +247,14 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.InitCheckBoxSize">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Gets the size needed for the check box when drawn using ThemeServices.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>InitCheckBoxSize</var> is a class method used to initialize the member used to store the check box size when drawn using theme element details. Calls the GetDetailSize method in ThemeServices to store the value for the TPoint member.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -253,29 +272,69 @@
|
||||
|
||||
<element name="TCustomCheckBoxThemed.DoClick">
|
||||
<short>Performs actions needed when the control is clicked.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
DoClick ensures that the State or Checked property is updated when the control is clicked. When AllowGrayed is enabled, the value in State is updated to the next value for the tri-state check box control. Otherwise, the current value in Checked is toggled.
|
||||
</p>
|
||||
<p>
|
||||
DoClick is called from DialogChar when an accelerator key is handled for the control. It is called from KeyUp when the VK_RETURN or VK_SPACE key code is handled for the control. It is also called from MouseUp when a Left mouse button event occurs on the hovered control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomCheckBoxThemed.Checked"/>
|
||||
<link id="TCustomCheckBoxThemed.State"/>
|
||||
<link id="TCustomCheckBoxThemed.AllowGrayed"/>
|
||||
<link id="TCustomCheckBoxThemed.DialogChar"/>
|
||||
<link id="TCustomCheckBoxThemed.KeyUp"/>
|
||||
<link id="TCustomCheckBoxThemed.MouseUp"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.DoEnter">
|
||||
<short>Performs actions needed when the control is entered (receives input focus).</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Performs actions needed when the control is entered (receives input focus).
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>DoEnter</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method on entry to signal the <var>OnEnter</var> event handler (when assigned). It calls <var>Invalidate</var> to force the control to be redrawn.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TWinControl.DoEnter">TWinControl.DoEnter</link>
|
||||
<link id="#lcl.controls.TWinControl.OnEnter">TWinControl.OnEnter</link>
|
||||
<link id="#lcl.controls.TWinControl.Invalidate">TWinControl.Invalidate</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.DoExit">
|
||||
<short>Performs actions needed when the control is exited (loses input focus).</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>DoExit</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method on entry to signal the <var>OnExit</var> event handler (when assigned). It calls <var>Invalidate</var> to force the control to be redrawn.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TWinControl.DoExit">TWinControl.DoExit</link>
|
||||
<link id="#lcl.controls.TWinControl.OnExit">TWinControl.OnExit</link>
|
||||
<link id="#lcl.controls.TWinControl.Invalidate">TWinControl.Invalidate</link>
|
||||
</seealso>
|
||||
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.GetActionLinkClass">
|
||||
<short>Gets the class reference used to create the action link for the control.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetActionLinkClass</var> is an overridden method in <var>TCustomCheckBoxThemed</var> used to get the class reference needed to create a new action link for the control. The return value is the TCheckBoxThemedActionLink type.
|
||||
</p>
|
||||
<p>
|
||||
It re-implements the method introduced in the ancestor class. It does not call the inherited method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.GetActionLinkClass.Result">
|
||||
<short/>
|
||||
<short>Always returns the TCheckBoxThemedActionLink type.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.KeyDown">
|
||||
@ -308,53 +367,57 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseDown.Button">
|
||||
<short/>
|
||||
<short>Mouse button for the event.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseDown.Shift">
|
||||
<short/>
|
||||
<short>Shift, Alt, or Ctrl modifier for the mouse event.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseDown.X">
|
||||
<short/>
|
||||
<short>Horizontal coordinate for the mouse pointer.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseDown.Y">
|
||||
<short/>
|
||||
<short>Vertical coordinate for the mouse pointer.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.MouseEnter">
|
||||
<short>Handles hover state when the mouse cursor enters the control.</short>
|
||||
<short>Updates the hover state when the mouse pointer enters the control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.MouseLeave">
|
||||
<short>Handles hover state when the mouse cursor leaves the control.</short>
|
||||
<short>Updates the hover state when the mouse pointer leaves the control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.MouseUp">
|
||||
<short>Handles mouse up events for the control.</short>
|
||||
<descr/>
|
||||
<short>Handles a mouse up event for the control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>MouseUp</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method on entry to signal the <var>OnMouseUp</var> event handler (when assigned). It ensures that a Left mouse button click anywhere within the client rectangle for the control causes the DoClick method to be called to update values in the State and/or Checked property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseUp.Button">
|
||||
<short/>
|
||||
<short>Mouse button for the event.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseUp.Shift">
|
||||
<short/>
|
||||
<short>Shift, Ctrl, Alt modifier for the mouse event.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseUp.X">
|
||||
<short/>
|
||||
<short>Horizontal coordinate for the mouse pointer.</short>
|
||||
</element>
|
||||
<element name="TCustomCheckBoxThemed.MouseUp.Y">
|
||||
<short/>
|
||||
<short>Vertical coordinate for the mouse pointer.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.Paint">
|
||||
<short>Draws the control.</short>
|
||||
<short>Draws the themed check box control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Paint</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method to signal the default <var>OnPaint</var> event handler (when assigned). It calls <var>PaintSelf</var> which implements the custom drawing method used for the themed check box control.
|
||||
<var>Paint</var> is an overridden method in <var>TCustomCheckBoxThemed</var>. It calls the inherited method to signal the <var>OnPaint</var> event handler (when assigned). It calls <var>PaintSelf</var> which implements the custom drawing method used for the themed check box control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -364,17 +427,26 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.TextChanged">
|
||||
<short>Redraws the control when the caption has been changed.</short>
|
||||
<descr/>
|
||||
<short>
|
||||
Redraws the control when the caption text has been changed.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method on entry. Calls <var>Invalidate</var> to force the control to be redrawn.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCustomCheckBoxThemed.Invalidate"/>
|
||||
<link id="#lcl.controls.TControl.Invalidate">TControl.Invalidate</link>
|
||||
<link id="#lcl.controls.TWinControl.Invalidate">TWinControl.Invalidate</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.WMSize">
|
||||
<short>Handles the WM_SIZE message for the control and redraws the control.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method on entry to apply the message to the control. Calls Invalidate to force the control to be redrawn.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TWinControl.WMSize">TWinControl.WMSize</link>
|
||||
</seealso>
|
||||
@ -384,7 +456,7 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.CheckBoxHovered">
|
||||
<short>Protected property used to track mouse hover for the control.</short>
|
||||
<short>Indicates if the mouse pointer is hovered over the control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -398,7 +470,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomCheckBoxThemed.cFocusBorder">
|
||||
<short>Internal constant with the space reserved for the focus border in the control.</short>
|
||||
<short>
|
||||
Internal constant with the space reserved for the focus border in the control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -3,8 +3,14 @@
|
||||
<package name="LazControls">
|
||||
|
||||
<module name="DividerBevel">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Implements a bevel with additional drawing features used as a separator on forms, frames, and panels.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<file>DividerBevel.pas</file> contains the <var>TDividerBevel</var> control, a bevel with additional drawing features. This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
<element name="Classes"/>
|
||||
@ -22,10 +28,16 @@
|
||||
<short>Line with text in the middle, used as a divider or header.</short>
|
||||
<descr>
|
||||
<p>
|
||||
TDividerBevel is a TGraphicControl descendant which implements a component represented as a beveled line with a caption. It is used as a separator or header on forms, frames, and panels.
|
||||
TDividerBevel is a TGraphicControl descendant which implements a component represented as a beveled line with a caption. It is used as a separator or header on forms, frames, and panels. It is similar to TBevel, but provides additional drawing styles as well layout options for the control caption.
|
||||
</p>
|
||||
<p>
|
||||
TDividerBevel can be oriented either horizontally or vertically. The bevel can be drawn using a raised or lowered drawing style. The bevel can be rendered using a line drawing style or pattern defined in the TGrabStlye enumeration. The height of the bevel can be specified, or a height relative to the size of the Text on the control can be used. The caption drawn on the control can be surrounded by additional space, drawn at specific position, or centered in the orientation for the control. Transparency is also supported in the control.
|
||||
TDividerBevel can be oriented either horizontally or vertically. The bevel can be drawn using a raised or lowered drawing style. The bevel can be rendered using a line drawing shape or a pattern defined in the Style property. The height of the bevel can be specified, or it can resize to the Text on the control. The caption can be drawn at a specific position (LeftIndent) and surrounded by an unused space using the CaptionSpacing property. Transparency is also supported in the control.
|
||||
</p>
|
||||
<p>
|
||||
The BevelWidth property indicates the thickness for the bevel. It is set to -1 by default, and indicates that the size is Max(3, TextHeight div 5). A positive value means that pixel measurements are used in the property.
|
||||
</p>
|
||||
<p>
|
||||
The LeftIndent is set by default to 60. Any negative value in LeftIndent causes the text in Caption to be centered along the bevel orientation.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -46,57 +58,70 @@
|
||||
<element name="TDividerBevel.FTransparent"/>
|
||||
|
||||
<element name="TDividerBevel.SetBevelStyle">
|
||||
<short/>
|
||||
<short>Sets the value in the BevelStyle property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.BevelStyle"/>
|
||||
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetBevelStyle.AValue">
|
||||
<short/>
|
||||
<short>New value for the BevelStyle property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetBevelWidth">
|
||||
<short/>
|
||||
<short>Sets the value in the BevelWidth property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.SetBevelWidth"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetBevelWidth.AValue">
|
||||
<short/>
|
||||
<short>New value for the BevelWidth property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetCaptionSpacing">
|
||||
<short/>
|
||||
<short>Sets the value for the CaptionSpacing property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.CaptionSpacing"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetCaptionSpacing.AValue">
|
||||
<short/>
|
||||
<short>New value for the CaptionSpacing property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetLeftIndent">
|
||||
<short/>
|
||||
<short>Sets the value for the LeftIndent property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.LeftIndent"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetLeftIndent.AValue">
|
||||
<short/>
|
||||
<short>New value for the LeftIndent property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetOrientation">
|
||||
<short/>
|
||||
<short>Sets the value for the Orientation property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.Orientation"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetOrientation.AValue">
|
||||
<short/>
|
||||
<short>New value for the Orientation property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetStyle">
|
||||
<short/>
|
||||
<short>Sets the value for the Style property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.Style"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetStyle.AValue">
|
||||
<short/>
|
||||
<short>New value for the Style property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetTransparent">
|
||||
@ -116,81 +141,158 @@
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.FBevelTop">
|
||||
<short/>
|
||||
<short>Member with the height for the bevel.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.FNeedCalcSize">
|
||||
<short/>
|
||||
<short>
|
||||
Member with the flag set when the Font, Text, or preferred size is changed.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.FTextExtent">
|
||||
<short/>
|
||||
<short>Member with the text extent for the Caption property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.GetControlClassDefaultSize">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>The default size of new instance of the class.</short>
|
||||
<descr>
|
||||
<p>
|
||||
GetControlClassDefaultSize is an overridden TSize function used to get the default size for new instances of the TDividerBevel class. The width (CX) in the TSize instance is set to 240. The height (CY) in the TSize instance is set to 17.
|
||||
</p>
|
||||
<p>
|
||||
Used by the GetDefaultWidth and GetDefaultHeight methods.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TControl.GetControlClassDefaultSize">TControl.GetControlClassDefaultSize</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.GetControlClassDefaultSize.Result">
|
||||
<short/>
|
||||
<short>TSize instance with the width and height for the new class instance.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.CalcSize">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Calculates the height for the Caption text and the bevel on the control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
CalcSize is a method used to calculate the height for the Caption text and the bevel drawn on the control. An internal flag, set when the Text or Font for the control is changed, is used to determine when the calculation is needed. No actions are performed in the method if the flag has not been set.
|
||||
</p>
|
||||
<p>
|
||||
CalcSize calls the TextExtent method in the control Canvas to get the text extent for Caption.
|
||||
</p>
|
||||
<p>
|
||||
BevelWidth is used to set the height for the bevel in pixels when it has a positive or zero value. When BevelWidth has a negative value, the height for the bevel is set to the larger of 20% of the text height or 3 pixels. The bevel is centered in the text height.
|
||||
</p>
|
||||
<p>
|
||||
CalcSize is called from the CalculatePreferredSize and Paint methods.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.Paint">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Draws the control on its Canvas.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Paint</var> is an overridden method used to draw the control on its <var>Canvas</var>. It re-implements the method from the ancestor class, and does <b>not</b> call the inherited method.
|
||||
</p>
|
||||
<p>
|
||||
Paint calls CalcSize to ensure that the height for the Caption text and the bevel are updated before the control is drawn.
|
||||
</p>
|
||||
<p>
|
||||
If Transparent is set to False, the background for the control is filled using the value in Color.
|
||||
</p>
|
||||
<p>
|
||||
Values in BevelStyle, Style, Orientation, and Caption are used to determine the drawing area for the bevel on the control. The PaintBevel method is called to render the bevel to the control Canvas.
|
||||
</p>
|
||||
<p>
|
||||
When Caption has been assigned, it is positioned using the values in LeftIndent and CaptionSpacing. The TextOut method in Canvas is called to draw the Caption text using the Orientation for the control.
|
||||
</p>
|
||||
<p>
|
||||
Use the Font property to configure the font face, style, and size used for the Caption text.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.FontChanged">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Performs actions when the Font for the control has been changed.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>FontChanged</var> is an overridden method used to update the control when the value in <var>Font</var> has been changed. It calls the inherited method on entry to apply the new font to the control <var>Canvas</var>, and post a <var>CM_FONTCHANGED</var> control message to the widgetset class. The internal flag used to force text and bevel sizes to be recalculated is set. <var>Invalidate</var> is called to force the control to be redrawn.
|
||||
</p>
|
||||
<p>
|
||||
FontChanged is assigned as the OnChange event handler in the Font property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TGraphicControl.FontChanged">TGraphicControl.FontChanged</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.FontChanged.Sender">
|
||||
<short/>
|
||||
<short>Object instance for the event notification.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.SetAutoSize">
|
||||
<short/>
|
||||
<short>Sets the value for the AutoSize property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TControl.AutoSize">TControl.AutoSize</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.SetAutoSize.Value">
|
||||
<short/>
|
||||
<short>New value for the AutoSize property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.TextChanged">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Performs actions when the CM_TEXTCHANGED message is handled for the control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TextChanged</var> is an overridden method used to perform action needed when the value in the text property has been changed for the control. It re-implements the method from the ancestor class to set in the internal flag to recalculate text and bevel sizes in the control, and calls the <var>Invalidate</var> method to force the control to be redrawn.
|
||||
</p>
|
||||
<p>
|
||||
TextChanged is called from the <var>CMTextChanged</var> method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TControl.CMTextChanged">TControl.CMTextChanged</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.CalculatePreferredSize">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Calculates the preferred size for the control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
CalculatePreferredSize is an overridden method used to calculate the preferred width and height for the control. It re-implements the method from the ancestor class, and does not call the inherited method.
|
||||
</p>
|
||||
<p>
|
||||
CalculatePreferredSize sets the internal flag to recalculate the text and bevel height, and calls CalcSize to update the values.
|
||||
</p>
|
||||
<p>
|
||||
The value in Orientation is used to determine the value calculated in the method. When set to trHorizontal, PreferredHeight is set to the maximum of the text height or the bevel height (Caption is empty). When set to trVertical, the PreferredWidth is set to the maximum of the text height or the bevel height (Caption is empty).
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TDividerBevel.CalculatePreferredSize.PreferredWidth">
|
||||
<short/>
|
||||
<short>The preferred width for the control.</short>
|
||||
</element>
|
||||
<element name="TDividerBevel.CalculatePreferredSize.PreferredHeight">
|
||||
<short/>
|
||||
<short>The preferred height for the control.</short>
|
||||
</element>
|
||||
<element name="TDividerBevel.CalculatePreferredSize.WithThemeSpace">
|
||||
<short/>
|
||||
<short>
|
||||
True if additional space is reserved for theme elements. Not used in the method.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
<!-- public methods -->
|
||||
@ -198,7 +300,19 @@
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create is the overridden constructor for the class instance.
|
||||
Create is the overridden constructor for the class instance, and calls the inherited method on entry. It sets the default values for properties, including:
|
||||
</p>
|
||||
<ul>
|
||||
<li>BevelStyle (bsLowered)</li>
|
||||
<li>BevelWidth (-1 for relative bevel size)</li>
|
||||
<li>CaptionSpacing (10 pixels)</li>
|
||||
<li>LeftIndex (60 pixels)</li>
|
||||
<li>Orientation (trHorizontal)</li>
|
||||
<li>Transparent (True)</li>
|
||||
<li>AutoSize (True)</li>
|
||||
</ul>
|
||||
<p>
|
||||
An internal flag used to force the text and bevel height to be calculated is set. The GetControlClassDefaultSize method is called get and set the initial bounds for the class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -208,35 +322,53 @@
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.ShouldAutoAdjust">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Determine if the width and/or height can be adjusted by a layout policy.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Re-implements the method from the ancestor class, and does not call the inherited method. In <var>TDividerBevel</var>, a dimension can be auto-adjusted when <var>AutoSize</var> is not enabled, and the dimension is not the <var>Orientation</var> for the control. Called when an auto-adjust layout policy is applied to the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TControl.ShouldAutoAdjust">TControl.ShouldAutoAdjust</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDividerBevel.ShouldAutoAdjust.AWidth">
|
||||
<short/>
|
||||
<short>True if the width can be auto-adjusted by a layout policy.</short>
|
||||
</element>
|
||||
<element name="TDividerBevel.ShouldAutoAdjust.AHeight">
|
||||
<short/>
|
||||
<short>True if the height can be auto-adjusted by a layout policy.</short>
|
||||
</element>
|
||||
|
||||
<!-- published properties -->
|
||||
<element name="TDividerBevel.Caption"/>
|
||||
<element name="TDividerBevel.Align"/>
|
||||
<element name="TDividerBevel.AutoSize"/>
|
||||
<element name="TDividerBevel.Anchors"/>
|
||||
<element name="TDividerBevel.Caption" link="#lcl.controls.TControl.Caption"/>
|
||||
<element name="TDividerBevel.Align" link="#lcl.controls.TControl.Align"/>
|
||||
<element name="TDividerBevel.AutoSize" link="#lcl.controls.TControl.AutoSize"/>
|
||||
<element name="TDividerBevel.Anchors" link="#lcl.controls.TControl.Anchors"/>
|
||||
|
||||
<element name="TDividerBevel.BevelStyle">
|
||||
<short/>
|
||||
<short>
|
||||
Indicates whether the bevel is drawn using a raised or lowered drawing style.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
The default value for the property is <var>bsLowered</var>.
|
||||
<var>BevelStyle</var> is a <var>TBevelStyle</var> property which indicates if the bevel is drawn using a raised or lowered style. The default value for the property is <var>bsLowered</var>. Changing the value for the property causes the control to be redrawn.
|
||||
</p>
|
||||
<p>
|
||||
Use BevelWidth to set the bevel height in pixels, or relative to the text height for the control. Use Style to set the shape or pattern used to draw the bevel.
|
||||
</p>
|
||||
<p>
|
||||
BevelStyle is used in the Paint method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.BevelWidth"/>
|
||||
<link id="TDividerBevel.Style"/>
|
||||
<link id="TBevelStyle"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.BevelWidth">
|
||||
<short/>
|
||||
<short>Height for the bevel on its Orientation.</short>
|
||||
<descr>
|
||||
<p>
|
||||
The default value for the property is <b>-1</b>. Negative values in the property indicate that the bevel is drawn using 20% of the Text height for the control, with a minimum height of 3 pixels.
|
||||
@ -245,89 +377,154 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.BiDiMode"/>
|
||||
<element name="TDividerBevel.BorderSpacing"/>
|
||||
<element name="TDividerBevel.BiDiMode" link="#lcl.controls.TControl.BidiMode"/>
|
||||
<element name="TDividerBevel.BorderSpacing" link="#lcl.controls.TControl.BorderSpacing"/>
|
||||
|
||||
<element name="TDividerBevel.CaptionSpacing">
|
||||
<short/>
|
||||
<short>
|
||||
Number of pixels reserved as spacing in front of and following the Caption.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
The default value for the property is <b>10</b>.
|
||||
The default value for the property is <b>10</b>. Use <var>LeftIndent</var> to set the position (in pixels) where the Caption text starts. Any negative value in LeftIndent causes the caption to be centered along the bevel.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.LeftIndent"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.Color"/>
|
||||
<element name="TDividerBevel.Constraints"/>
|
||||
<element name="TDividerBevel.DragCursor"/>
|
||||
<element name="TDividerBevel.DragKind"/>
|
||||
<element name="TDividerBevel.DragMode"/>
|
||||
<element name="TDividerBevel.Font"/>
|
||||
<element name="TDividerBevel.Hint"/>
|
||||
<element name="TDividerBevel.Color" link="#lcl.controls.TControl.Color"/>
|
||||
<element name="TDividerBevel.Constraints" link="#lcl.controls.TControl.Constraints"/>
|
||||
|
||||
<element name="TDividerBevel.DragCursor" link="#lcl.controls.TControl.DragCursor"/>
|
||||
<element name="TDividerBevel.DragKind" link="#lcl.controls.TControl.DragKind"/>
|
||||
<element name="TDividerBevel.DragMode" link="#lcl.controls.TControl.DragMode"/>
|
||||
<element name="TDividerBevel.Font" link="#lcl.controls.TControl.Font"/>
|
||||
<element name="TDividerBevel.Hint" link="#lcl.controls.TControl.Hint"/>
|
||||
|
||||
<element name="TDividerBevel.LeftIndent">
|
||||
<short/>
|
||||
<short>
|
||||
Position relative to Left where the CaptionSpacing and Caption are displayed.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
The default value for the property is 60 pixels.
|
||||
<var>LeftIndent</var> is an <var>Integer</var> property which indicates the position relative to the <var>Left</var> property where the <var>CaptionSpacing</var> and <var>Caption</var> text are displayed on the control. The default value for the property is <b>60</b> pixels.
|
||||
</p>
|
||||
<p>
|
||||
Use <var>CaptionSpacing</var> to set the number of pixels reserved as undecorated blank space on each side of the Caption text.
|
||||
</p>
|
||||
<p>
|
||||
For example: If CaptionSpacing is set to 10, and LeftIndent is set to 60, the CaptionSpacing starts at 60 pixels and the text at 70 pixels.
|
||||
</p>
|
||||
<p>
|
||||
LeftIndent, when set to any negative value, causes the CaptionSpacing and Caption text to be centered along the Orientation for the divider bevel. When set to 0, no left indent or caption spacing is applied before the Caption text.
|
||||
</p>
|
||||
<p>
|
||||
Changing the value for the property causes the control to be redrawn.
|
||||
</p>
|
||||
<p>
|
||||
LeftIndent is used in the Paint method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.CaptionSpacing"/>
|
||||
<link id="TDividerBevel.Caption"/>
|
||||
<link id="TDividerBevel.Orientation"/>
|
||||
<link id="TDividerBevel.Paint"/>
|
||||
<link id="#lcl.controls.TControl.Left">TControl.Left</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.Orientation">
|
||||
<short/>
|
||||
<short>Direction that the bevel and caption are drawn.</short>
|
||||
<descr>
|
||||
<p>
|
||||
The default valule for the property is <var>trHorizontal</var>.
|
||||
<var>Orientation</var> is a <var>TTrackBarOrientation</var> property which indicates the direction that the bevel and caption are drawn on the control. The default value for the property is <var>trHorizontal</var>, and causes the bevel and caption to be draw from left to right horizontally. When set to trVertical, the <var>Font</var> on the control <var>Canvas</var> is rotated 90 degrees and the bevel and caption are drawn from top to bottom vertically.
|
||||
</p>
|
||||
<p>
|
||||
Changing the value for the property causes the size to be adjusted when <var>AutoSize</var> is set to <b>True</b>. The control is redrawn when the new property value is applied.
|
||||
</p>
|
||||
<p>
|
||||
Orientation is used in the <var>Paint</var> method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.Paint"/>
|
||||
<link id="#lcl.controls.TGraphicControl.Canvas">TGraphicControl.Canvas</link>
|
||||
<link id="#lcl.comctrls.TControl.AutoSize">TControl.AutoSize</link>
|
||||
<link id="#lcl.comctrls.TTrackBarOrientation">TTrackBarOrientation</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.ParentBiDiMode"/>
|
||||
<element name="TDividerBevel.ParentColor"/>
|
||||
<element name="TDividerBevel.ParentFont"/>
|
||||
<element name="TDividerBevel.ParentShowHint"/>
|
||||
<element name="TDividerBevel.PopupMenu"/>
|
||||
<element name="TDividerBevel.ShowHint"/>
|
||||
<element name="TDividerBevel.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
|
||||
<element name="TDividerBevel.ParentColor" link="#lcl.controls.TControl.ParentColor"/>
|
||||
<element name="TDividerBevel.ParentFont" link="#lcl.controls.TControl.ParentFont"/>
|
||||
<element name="TDividerBevel.ParentShowHint" link="#lcl.controls.TControl.ParentShowHint"/>
|
||||
<element name="TDividerBevel.PopupMenu" link="#lcl.controls.TControl.PopupMenu"/>
|
||||
<element name="TDividerBevel.ShowHint" link="#lcl.controls.TControl.ShowHint"/>
|
||||
|
||||
<element name="TDividerBevel.Style">
|
||||
<short/>
|
||||
<descr>
|
||||
<p>
|
||||
The default value for the property is <var>gsSimple</var>.
|
||||
<var>Style</var> is a <var>TGrabStyle</var> property with the shape or pattern used to draw the bevel on the control.
|
||||
</p>
|
||||
<p>
|
||||
The default value for the property is <var>gsSimple</var>, and causes a simple rectangle to be drawn with the appearance in the <var>BevelStyle</var> property. Contrasting colors on the borders are used to achieve the raised or lowered appearance. Other values include:
|
||||
</p>
|
||||
<dl>
|
||||
<dt>gsDouble</dt>
|
||||
<dd>Draws double lines using the appearance in BevelStyle.</dd>
|
||||
<dt>gsHorLines</dt>
|
||||
<dd>Draws a single line using the appearance in BevelStyle.</dd>
|
||||
<dt>gsVerLines</dt>
|
||||
<dd>Draws a vertical line using the appearance in BevelStyle.</dd>
|
||||
<dt>gsGripper</dt>
|
||||
<dd>
|
||||
Draws a row of raised dots on the bevel. BevelStyle is not used. Drawn using the trGripper theme element details in ThemeServices.
|
||||
</dd>
|
||||
<dt>gsButton</dt>
|
||||
<dd>
|
||||
Draws the bevel using a pseudo-button style. BevelStyle is not used. Drawn using the tbPushButtonNormal theme element details in ThemeServices.
|
||||
</dd>
|
||||
</dl>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TDividerBevel.BevelStyle"/>
|
||||
<link id="TDividerBevel.BevelWidth"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.Transparent">
|
||||
<short/>
|
||||
<short>
|
||||
Indicates if the parent control is visible beneath the drawing area for the divider bevel.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
The defauilt value for the property is <b>True</b>.
|
||||
<var>Transparent</var> is a Boolean property which indicates if the control is drawn with transparency. When set to <b>True</b>, the parent control is visible beneath the undecorated areas on the control. When set to <b>False</b>, the client area for the control is filled using the value in Color. The default value for the property is <b>True</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#lcl.controls.TControl.Color">TControl.Color</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TDividerBevel.Visible"/>
|
||||
<element name="TDividerBevel.OnChangeBounds"/>
|
||||
<element name="TDividerBevel.OnClick"/>
|
||||
<element name="TDividerBevel.OnContextPopup"/>
|
||||
<element name="TDividerBevel.OnDblClick"/>
|
||||
<element name="TDividerBevel.OnDragDrop"/>
|
||||
<element name="TDividerBevel.OnDragOver"/>
|
||||
<element name="TDividerBevel.OnEndDrag"/>
|
||||
<element name="TDividerBevel.OnMouseDown"/>
|
||||
<element name="TDividerBevel.OnMouseEnter"/>
|
||||
<element name="TDividerBevel.OnMouseLeave"/>
|
||||
<element name="TDividerBevel.OnMouseMove"/>
|
||||
<element name="TDividerBevel.OnMouseUp"/>
|
||||
<element name="TDividerBevel.OnResize"/>
|
||||
<element name="TDividerBevel.OnStartDrag"/>
|
||||
<element name="TDividerBevel.Visible" link="#lcl.controls.TControl.Visible"/>
|
||||
<element name="TDividerBevel.OnChangeBounds" link="#lcl.controls.TControl.OnChangeBounds"/>
|
||||
<element name="TDividerBevel.OnClick" link="#lcl.controls.TControl.OnClick"/>
|
||||
<element name="TDividerBevel.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
|
||||
<element name="TDividerBevel.OnDblClick" link="#lcl.controls.TControl.OnDblClick"/>
|
||||
<element name="TDividerBevel.OnDragDrop" link="#lcl.controls.TControl.OnDragDrop"/>
|
||||
<element name="TDividerBevel.OnDragOver" link="#lcl.controls.TControl.OnDragOver"/>
|
||||
<element name="TDividerBevel.OnEndDrag" link="#lcl.controls.TControl.OnEndDrag"/>
|
||||
<element name="TDividerBevel.OnMouseDown" link="#lcl.controls.TControl.OnMouseDown"/>
|
||||
<element name="TDividerBevel.OnMouseEnter" link="#lcl.controls.TControl.OnMouseEnter"/>
|
||||
<element name="TDividerBevel.OnMouseLeave" link="#lcl.controls.TControl.OnMouseLeave"/>
|
||||
<element name="TDividerBevel.OnMouseMove" link="#lcl.controls.TControl.OnMouseMove"/>
|
||||
<element name="TDividerBevel.OnMouseUp" link="#lcl.controls.TControl.OnMouseUp"/>
|
||||
<element name="TDividerBevel.OnResize" link="#lcl.controls.TControl.OnResize"/>
|
||||
<element name="TDividerBevel.OnStartDrag" link="#lcl.controls.TControl.OnStartDrag"/>
|
||||
|
||||
</module>
|
||||
|
||||
|
||||
@ -475,7 +475,7 @@
|
||||
</element>
|
||||
|
||||
<element name="TToolbarWrapper.EdgeInner">
|
||||
<short>Drawing styleused for the inner edge of the tool bar.</short>
|
||||
<short>Drawing style used for the inner edge of the tool bar.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>EdgeInner</var> is a <var>TEdgeStyle</var> property which indicates the drawing style used for the inner edge of the tool bar. The default value for the property is <var>esRaised</var>.
|
||||
|
||||
@ -4,7 +4,14 @@
|
||||
|
||||
<module name="ListFilterEdit">
|
||||
<short>Implements a control used to filter an associated list box.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<file>ListFilterEdit.pas</file> contains classes and types used to implement the <var>TListFilterEdit</var> control, and filtered edit control for values in an associated list box.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
<element name="Classes"/>
|
||||
@ -20,7 +27,7 @@
|
||||
<element name="AvgLvlTree"/>
|
||||
|
||||
<element name="TImageIndexEvent">
|
||||
<short/>
|
||||
<short>Not used in the current implementation.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -38,10 +45,10 @@
|
||||
</element>
|
||||
|
||||
<element name="TListFilterEdit">
|
||||
<short>Filter for an associated ListBox.</short>
|
||||
<short>Implements an edit control used to filter an associated ListBox.</short>
|
||||
<descr>
|
||||
<p>
|
||||
TListFilterEdit is a TCustomControlFilterEdit descendant which implements a filter for an associated ListBox.
|
||||
TListFilterEdit is a TCustomControlFilterEdit descendant which implements an edit control used to filter an associated TListBox control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -57,7 +64,7 @@
|
||||
</element>
|
||||
|
||||
<element name="TListFilterEdit.FOriginalData">
|
||||
<short>The orignal value supplied in the Data property.</short>
|
||||
<short>The original value supplied in the Data property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TListFilterEdit.FSortedData">
|
||||
@ -90,19 +97,29 @@
|
||||
|
||||
<!-- protected methods -->
|
||||
<element name="TListFilterEdit.Notification">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>
|
||||
Handles a notification when a component is added to or removed from the control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Notification</var> is an overridden method in <var>TListFilterEdit</var>, and calls the inherited method on entry. It ensures that the <var>FilteredListbox</var> property is set to <b>Nil</b> when the component is removed from the class instance. It also sets the value for <var>IdleConnected</var> to <b>False</b>, and resets the internal update flag for the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TListFilterEdit.FilteredListbox"/>
|
||||
<link id="#lcl.editbtn.TCustomControlFilterEdit.IdleConnected">TCustomControlFilterEdit.IdleConnected</link>
|
||||
<link id="#lcl.controls.TControl.Notification">TControl.Notification</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TListFilterEdit.Notification.AComponent">
|
||||
<short/>
|
||||
<short>Component for the notification.</short>
|
||||
</element>
|
||||
<element name="TListFilterEdit.Notification.Operation">
|
||||
<short/>
|
||||
<short>Operation performed for the component.</short>
|
||||
</element>
|
||||
|
||||
<element name="TListFilterEdit.MoveTo">
|
||||
<short/>
|
||||
<short>Changes the position in FilteredListbox and optionally selects the value.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -114,7 +131,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TListFilterEdit.MoveNext">
|
||||
<short/>
|
||||
<short>
|
||||
Moves to the next item in FilteredListbox and optionally selects the value.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -123,7 +142,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TListFilterEdit.MovePrev">
|
||||
<short/>
|
||||
<short>
|
||||
Moves to the previous item in FilteredListbox and optionally selects the value.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -3,8 +3,15 @@
|
||||
<package name="LazControls">
|
||||
|
||||
<module name="ListViewFilterEdit">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Implements a control used to filter an associated TListView control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<file>ListViewFilterEdit</file> contains classes and types used to implement the <var>TListViewFilterEdit</var> control. It is used to filter the items displayed for an associated <var>TListView</var> control.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
<element name="Classes"/>
|
||||
@ -24,19 +31,25 @@
|
||||
</element>
|
||||
|
||||
<element name="TListViewDataItem">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Record type with data and lines of text for an item in a list view control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
TListViewDataItem is the typed maintained in TListViewDataList.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TListViewDataItem.Data">
|
||||
<short/>
|
||||
<short>Pointer to the data for the list item.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TListViewDataItem.StringArray">
|
||||
<short/>
|
||||
<short>Array of String values with the text displayed for the list item.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -45,41 +58,50 @@
|
||||
<short>
|
||||
Implements the Equal (=) comparison operator for TListViewDataItem instances.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
The return value is <b>True</b> when both the <var>Data</var> and the <var>StringArray</var> for the compared <var>TListViewDataItem</var> instances are the same.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TListViewDataItem.OperatorEqual.Result">
|
||||
<short/>
|
||||
<short>True when the compared items have the same Data and StringArray values.</short>
|
||||
</element>
|
||||
<element name="TListViewDataItem.OperatorEqual.a">
|
||||
<short/>
|
||||
<short>TListViewDataItem instance for the comparison operator.</short>
|
||||
</element>
|
||||
<element name="TListViewDataItem.OperatorEqual.b">
|
||||
<short/>
|
||||
<short>TListViewDataItem instance for the comparison operator.</short>
|
||||
</element>
|
||||
|
||||
<element name="TListViewDataList">
|
||||
<short>List container for TListViewDataItem instances.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TListViewDataList</var> is a specialization of TFPGList to use TListViewDataItem instances in the container. TListViewDataList is the type used to implement the <var>Items</var> property in <var>TListViewFilterEdit</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#fcl.Fgl.TFPGList"/>
|
||||
<link id="TListViewDataItem"/>
|
||||
<link id="TListViewFilterEdit.Items"/>
|
||||
<link id="#fcl.Fgl.TFPGList">TFPGList</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TListViewFilterEdit">
|
||||
<short>Implements a control used to filter an associated ListView.</short>
|
||||
<short>Implements a control used to filter an associated TListView control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- private members and methods -->
|
||||
<element name="TListViewFilterEdit.FFilteredListview">
|
||||
<short>A control showing the (filtered) data.</short>
|
||||
<short>TListView control showing the filtered data.</short>
|
||||
</element>
|
||||
|
||||
<element name="TListViewFilterEdit.FByAllFields">
|
||||
<short></short>
|
||||
<short>Stores the value for the ByAllFields property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TListViewFilterEdit.FSelectionList">
|
||||
@ -215,18 +237,24 @@
|
||||
</element>
|
||||
|
||||
<element name="TListViewFilterEdit.ApplyFilterCore">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Implements the method used to apply filter data to the associated control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Called when the ApplyFilter method in the ancestor class is executed.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TListViewFilterEdit.GetDefaultGlyphName">
|
||||
<short/>
|
||||
<short>Gets the default resource name for the button glyph on the control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TListViewFilterEdit.GetDefaultGlyphName.Result">
|
||||
<short/>
|
||||
<short>Resource name for the button glyph.</short>
|
||||
</element>
|
||||
|
||||
<!-- public methods and properties -->
|
||||
@ -234,7 +262,7 @@
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Create is the overridden constructor for the class instance.
|
||||
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry. It allocates resources for the <var>SelectionList</var> and <var>Items</var> properties. It creates an internal <var>TListViewDataList</var> instance used to store the filtered data for the list view control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -247,7 +275,7 @@
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Destroy is the overridden destructor for the class instance.
|
||||
<var>Destroy</var> is the overridden destructor for the class instance. It frees resources allocated to <var>SelectionList</var>, <var>Items</var>, and the internal filtered data list. It calls the inherited method prior to exit.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -269,7 +297,7 @@
|
||||
<short>Selected items restored after filtering.</short>
|
||||
<descr>
|
||||
<p>
|
||||
The list of selected items. They are restored after filtering.
|
||||
The list of selected items in the list view control. They are restored after filtering is applied.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
@ -283,7 +311,7 @@
|
||||
|
||||
<!-- published properties -->
|
||||
<element name="TListViewFilterEdit.FilteredListview">
|
||||
<short>The associated ListView.</short>
|
||||
<short>The associated TListView control.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -292,7 +320,10 @@
|
||||
<short>Indicates if all fields are compared using the filter.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Use all ListView fields when searching filter matches. Otherwise just the first field (ListView caption) is used.
|
||||
When set to <b>True</b>, all fields in the list view data areused when searching for a value that matches the filter. Otherwise, only the first field is used. The default value for the property is <b>False</b>.
|
||||
</p>
|
||||
<p>
|
||||
<var>ByAllFields</var> is used when <var>SortAndFilter</var> is called to select and order the filtered data for the control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
|
||||
@ -4,7 +4,14 @@
|
||||
<!-- LvlGraphCtrl -->
|
||||
<module name="LvlGraphCtrl">
|
||||
<short>Implements a Level (or Layered) Graph control.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<file>LvlGraphCtrl.pas</file> contains classes, types, constants, and routines used to implement a Level (or Layered) Graph control.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
<element name="Classes"/>
|
||||
@ -1601,7 +1608,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
</element>
|
||||
<element name="TLvlGraphCtrlOption.lgoMinimizeEdgeLens">
|
||||
<short>
|
||||
If nodes are not fixed to a level by neighbours on both side, find the level which reduces total edge length the most.
|
||||
If nodes are not fixed to a level by neighbors on both side, find the level which reduces total edge length the most.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TLvlGraphCtrlOption.lgoStraightenGraph">
|
||||
@ -2447,10 +2454,10 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
<short>Ancestor for the TLvlGraphControl control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TCustomLvlGraphControl</var> is a <var>TCustomControl</var> descendant which impements the ancestor for <var>TLvlGraphControl</var>.
|
||||
<var>TCustomLvlGraphControl</var> is a <var>TCustomControl</var> descendant which implements the ancestor for <var>TLvlGraphControl</var>.
|
||||
</p>
|
||||
<p>
|
||||
It is used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing beteen related nodes.
|
||||
It is used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing between related nodes.
|
||||
</p>
|
||||
<p>
|
||||
TCustomLvlGraphControl and TLvlGraphControl provide the following features:
|
||||
@ -2487,7 +2494,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
You can highlight nodes or edges under the mouse.
|
||||
</li>
|
||||
<li>
|
||||
The control displays back edges in special colours, which facilitates quick visual identification of cycles (e.g. unit circles).
|
||||
The control displays back edges in special colors, which facilitates quick visual identification of cycles (e.g. unit circles).
|
||||
</li>
|
||||
<li>
|
||||
Edges can be drawn straight or as a curve (bezier).
|
||||
@ -3124,7 +3131,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
<short>Implements a control used to draw a level (or layered) graph.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TLvlGraphControl</var> is a <var>TCustomLvlGraphControl</var> descendant which implements a control used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing beteen related nodes.
|
||||
<var>TLvlGraphControl</var> is a <var>TCustomLvlGraphControl</var> descendant which implements a control used to render a level graph (also known as a edlayered graph). A level graph consists of nodes (or vertices) and edges with an equidistant spacing between related nodes.
|
||||
</p>
|
||||
<p>
|
||||
TLvlGraphControl provides the following features:
|
||||
@ -3161,7 +3168,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize);
|
||||
You can highlight nodes or edges under the mouse.
|
||||
</li>
|
||||
<li>
|
||||
The control displays back edges in special colours, which facilitates quick visual identification of cycles (e.g. unit circles).
|
||||
The control displays back edges in special colors, which facilitates quick visual identification of cycles (e.g. unit circles).
|
||||
</li>
|
||||
<li>
|
||||
Edges can be drawn straight or as a curve (bezier).
|
||||
|
||||
@ -4,7 +4,14 @@
|
||||
|
||||
<module name="ShortPathEdit">
|
||||
<short>Implements the TShortPathEdit control.</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<file>ShortPathEdit.pas</file> implements the TShortPathEdit control, a directory edit control with a directory selection dialog.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
<element name="Classes"/>
|
||||
|
||||
@ -11,6 +11,9 @@
|
||||
<p>
|
||||
Initial implementation: 2016 by Bart Broersma. Revised in August 2020.
|
||||
</p>
|
||||
<p>
|
||||
This file is part of the <file>LazControls</file> package.
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- unresolved external references -->
|
||||
@ -327,7 +330,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TSpinEditExBase.RealGetText" link="#lcl.groupededit.TCustomAbstractGroupedEdit.RealGetText">
|
||||
<element name="TSpinEditExBase.RealGetText">
|
||||
<short>Gets the text displayed for the control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
@ -338,7 +341,7 @@
|
||||
<link id="TSpinEditExBase.Value"/>
|
||||
<link id="TSpinEditExBase.ValueToStr"/>
|
||||
<link id="TSpinEditExBase.Edit"/>
|
||||
<link id="#lcl.groupededit.TCustomAbstractGroupedEdit.RealGetText"/>
|
||||
<link id="#lcl.groupededit.TCustomAbstractGroupedEdit.RealGetText">TCustomAbstractGroupedEdit.RealGetText</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TSpinEditExBase.RealGetText.Result">
|
||||
@ -486,7 +489,7 @@
|
||||
<var>AValue</var> contains the type with the numeric value to be decremented.
|
||||
</p>
|
||||
<p>
|
||||
The return value contains the numeric value for the type after the value in Increment has been subtracted. The return value is constrained when the incremented value is too large for the data type.
|
||||
The return value contains the numeric value for the type after the value in Increment has been subtracted. The return value is range limited when the incremented value is too large for the data type.
|
||||
</p>
|
||||
<p>
|
||||
SafeDec is used in the implementation of the <var>SpinUpDown</var> method.
|
||||
@ -498,10 +501,10 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TSpinEditExBase.SafeDec.Result">
|
||||
<short/>
|
||||
<short>Control value after the decrement operation.</short>
|
||||
</element>
|
||||
<element name="TSpinEditExBase.SafeDec.AValue">
|
||||
<short>The decremented (and possibly constrained) value.</short>
|
||||
<short>The decremented (and possibly range limited) value.</short>
|
||||
</element>
|
||||
|
||||
<element name="TSpinEditExBase.SetValue">
|
||||
@ -597,7 +600,7 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TSpinEditExBase.FinalizeWnd" link="#lcl.controls.TWinControl.FinalizeWnd">
|
||||
<element name="TSpinEditExBase.FinalizeWnd">
|
||||
<short>Performs actions prior to freeing the handle for the control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
@ -1287,7 +1290,7 @@
|
||||
|
||||
<element name="TCustomFloatSpinEditEx.ExponentialFormatLimitPos">
|
||||
<short>
|
||||
Maximum exponent allowed before exponential notation is required for a positive number.
|
||||
Maximum exponent digits allowed before exponential notation is required for a positive number.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
@ -1318,7 +1321,9 @@
|
||||
</element>
|
||||
|
||||
<element name="TCustomFloatSpinEditEx.ExponentialFormatLimitNeg">
|
||||
<short/>
|
||||
<short>
|
||||
Maximum exponent digits allowed before exponential notation is required for a negative number.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExponentialFormatLimitNeg</var> is an <var>Integer</var> property which contains the exponent value at which use of scientific notation is triggered for a negative <var>Value</var> in the control. The default value for the property is <b>-6</b>, and indicates that scientific notation is required when Value is smaller than 10^-6.
|
||||
|
||||
@ -3,17 +3,19 @@
|
||||
<package name="LazControls">
|
||||
|
||||
<module name="TreeFilterEdit">
|
||||
<short>Implements a control used to filter an associated TreeView.</short>
|
||||
<descr/>
|
||||
<short>Implements a control used to filter an associated TTreeView control.</short>
|
||||
<descr>
|
||||
<file>treefilteredit.pas</file> contains classes and other types used to implement a control used to filter an associated TTreeView control. This file is part of the <file>LazControls</file> package.
|
||||
</descr>
|
||||
|
||||
<element name="TTreeFilterEdit">
|
||||
<short>Filter for an associated TreeView.</short>
|
||||
<short>Filter for an associated TreeView control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
This control has 2 different operation modes. One mode maintains and filters sub-items of root-nodes in a tree, another mode filters a whole existing tree using TreeNode.Visible property.
|
||||
This control has 2 different operation modes. One mode maintains and filters sub-items of root-nodes in a tree. The other mode filters the whole tree using the TreeNode.Visible property for each of the nodes.
|
||||
</p>
|
||||
<p>
|
||||
<b>Mode 1</b>: Sub-branches under root nodes Items for each branch are maintained in TTreeFilterBranch class instance.
|
||||
<b>Mode 1</b>: Sub-branches under root nodes Items for each branch are maintained in a TTreeFilterBranch class instance.
|
||||
</p>
|
||||
<p>
|
||||
<b>Mode 2</b>: A whole tree When no branches are defined (no calls made to GetBranch), the TreeFilterEdit control filters the whole tree automatically. It uses each TreeNode's Visible property to show/hide it.
|
||||
@ -87,7 +89,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Text, a data reference, and an associated file name can be added.
|
||||
Text, a data reference, and an associated file name can be added for the node.
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user