diff --git a/.gitattributes b/.gitattributes index 1e712529e5..019cdf0647 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4425,7 +4425,7 @@ components/rtticontrols/examples/exampleproject3.lpr svneol=native#text/pascal components/rtticontrols/examples/exampleprojectgrid1.lpi svneol=native#text/plain components/rtticontrols/examples/exampleprojectgrid1.lpr svneol=native#text/pascal components/rtticontrols/fpdoc/rttictrls.xml svneol=native#text/plain -components/rtticontrols/fpdoc/rttigrids.xml -text svneol=native#text/plain +components/rtticontrols/fpdoc/rttigrids.xml svneol=native#text/plain components/rtticontrols/images-copyright.txt svneol=native#text/plain components/rtticontrols/rttictrls.bat svneol=native#text/x-msdos-program components/rtticontrols/rttictrls.pas svneol=native#text/pascal diff --git a/components/lazcontrols/docs/checkboxthemed.xml b/components/lazcontrols/docs/checkboxthemed.xml index 300f0f2fa1..aa377d1679 100644 --- a/components/lazcontrols/docs/checkboxthemed.xml +++ b/components/lazcontrols/docs/checkboxthemed.xml @@ -2,7 +2,7 @@ - Implements a custom-drawn check box control drawn using theme services + Implements a custom-drawn check box control drawn using theme services.

checkboxthemed.pas contains classes used to implements a custom-drawn check box control drawn using theme services. @@ -27,7 +27,7 @@ - Provides a link between a themed check box control and its action + Provides a link between a themed check box control and its action.

TCheckBoxThemedActionLink is a TWinControlActionLink descendant which maintains a link between a TCustomCheckBoxThemed class instance and its Action. It provides overridden methods that use TCustomCheckBoxThemed as the internal client for the link, and maintains the checked state for the client control when the Action is linked and executed. @@ -44,7 +44,7 @@ - Sets the control used as the client in the action link + Sets the control used as the client in the action link. @@ -53,7 +53,7 @@ - Sets the value in Checked for the client control when linked + Sets the value in Checked for the client control when linked. @@ -64,19 +64,19 @@ - Determines if an Action is linked to the client control and if the Checked values are in sync + Determines if an Action is linked to the client control and if the Checked values are in sync. - True when an Action exists for the client control and they share the same Checked value - + True when an Action exists for the client control and they share the same Checked value. + - Class type used to create new instances of TCheckBoxThemedActionLink + Class type used to create new instances of TCheckBoxThemedActionLink.

TCheckBoxThemedActionLinkClass is a TCheckBoxThemedActionLink class type. @@ -88,7 +88,7 @@ - Implements the base class for a custom-drawn check box control + Implements the base class for a custom-drawn check box control.

TCustomCheckBoxThemed is a TCustomControl descendant which implements the base class for a custom-drawn check box control. @@ -112,50 +112,50 @@ - Gets the value for the Check property + Gets the value for the Check property. - Value for the property + Value for the property. - Sets the value for the Alignment property + Sets the value for the Alignment property. - New value for the property + New value for the property. - Sets an internal flag used to track mouse hover, and redraws the control + Sets an internal flag used to track mouse hover, and redraws the control. - New value for the internal flag + New value for the internal flag. - Sets the value for the Checked property + Sets the value for the Checked property. - New value for the property + New value for the property. - Sets the value for the State property + Sets the value for the State property. - New value for the property + New value for the property. @@ -164,44 +164,44 @@ - Gets the dimensions for the check box in the control scaled to the given display density + Gets the dimensions for the check box in the control scaled to the given display density. - TSize instance with the dimensions for the check box + TSize instance with the dimensions for the check box. - Design-time PPI setting used to scale to the PPI setting for the screen + Design-time PPI setting used to scale to the PPI setting for the screen. - Internal flag used to track key or mouse state in the control + Internal flag used to track key or mouse state in the control. - Not used in the current implementation + Not used in the current implementation. - Not used in the current implementation + Not used in the current implementation. - Not used in the current implementation + Not used in the current implementation. - Calculates the preferred height and width for the control + Calculates the preferred height and width for the control. @@ -216,21 +216,21 @@ - Handles the CM_BIDIMODECHANGED control message + Handles the CM_BIDIMODECHANGED control message. - Control message examined in the method + Control message examined in the method. - Handles the CM_ENABLEDCHANGED control message + Handles the CM_ENABLEDCHANGED control message. - Control message examined in the method + Control message examined in the method. @@ -240,37 +240,37 @@ - Handles a message with an accelerator key for the control + Handles a message with an accelerator key for the control. - True when the key is handled in the method + True when the key is handled in the method. - Message with the key event examined in the method + Message with the key event examined in the method. - Performs actions needed when the control is clicked + Performs actions needed when the control is clicked. - Performs actions needed when the control is entered (receives input focus) + Performs actions needed when the control is entered (receives input focus). - Performs actions needed when the control is exited (loses input focus) + Performs actions needed when the control is exited (loses input focus). - Gets the class reference used to create the action link for the control + Gets the class reference used to create the action link for the control. @@ -279,31 +279,31 @@ - Handles key down events for the control + Handles key down events for the control. - Key code examined in method + Key code examined in method. - Shift, Alt, or Ctrl modifier for the key + Shift, Alt, or Ctrl modifier for the key. - Handles key up events for the control + Handles key up events for the control. - Key code examined in method + Key code examined in method. - Shift, Alt, or Ctrl modifier for the key + Shift, Alt, or Ctrl modifier for the key. - Handles mouse down events for the control + Handles mouse down events for the control. @@ -321,19 +321,19 @@ - Handles hover state when the mouse cursor enters the control + Handles hover state when the mouse cursor enters the control. - Handles hover state when the mouse cursor leaves the control + Handles hover state when the mouse cursor leaves the control. - Handles mouse up events for the control + Handles mouse up events for the control. @@ -351,7 +351,7 @@ - Draws the control + Draws the control.

Paint is an overridden method in TCustomCheckBoxThemed. It calls the inherited method to signal the default OnPaint event handler (when assigned). It calls PaintSelf which implements the custom drawing method used for the themed check box control. @@ -364,7 +364,7 @@ - Redraws the control when the caption has been changed + Redraws the control when the caption has been changed. @@ -373,45 +373,45 @@ - Handles the WM_SIZE message for the control and redraws the control + Handles the WM_SIZE message for the control and redraws the control. TWinControl.WMSize - Window message examined in the method + Window message examined in the method. - Protected property used to track mouse hover for the control + Protected property used to track mouse hover for the control. - Protected property used to track the Checked state in the ActionLink/Action for the control + Protected property used to track the Checked state in the ActionLink/Action for the control. - Internal constant with the space reserved for the focus border in the control + Internal constant with the space reserved for the focus border in the control. - Internal constant with the space reserved for padding in the control + Internal constant with the space reserved for padding in the control. - Renders a check box control using the specified parameters + Renders a check box control using the specified parameters.

PaintSelf is a class method used to render a custom-drawn check box control using the parameters passed to the method. @@ -432,38 +432,38 @@ - Canvas for a check box control + Canvas for a check box control. - Caption text for a check box control + Caption text for a check box control. - Rectangle with the coordinates for a check box control + Rectangle with the coordinates for a check box control. - Checked state for a check box control + Checked state for a check box control. - Alignment for caption in the check box control + Alignment for caption in the check box control. - True if the mouse is hovered over the check box control + True if the mouse is hovered over the check box control. - True if the check box control is in the pressed state (mouse down) + True if the check box control is in the pressed state (mouse down). - True if the check box control has input focus + True if the check box control has input focus. - Left-to-Right alignment for the content in the check box control + Left-to-Right alignment for the content in the check box control. - True if the control is drawn in the enabled state + True if the control is drawn in the enabled state. - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create sets the accessibility role and control style flags needed for the control. Create also sets the default values for properties, including: @@ -483,7 +483,7 @@ - Horizontal alignment for the caption text in the control + Horizontal alignment for the caption text in the control.

Alignment is a TLeftRight property which contains the horizontal alignment used for the control. @@ -504,7 +504,7 @@ - Indicates if the control can use the "grayed" state + Indicates if the control can use the "grayed" state.

AllowGrayed is a Boolean property which indicates if the control can be displayed using its "grayed" state. This indicates that the control is disabled or has an undetermined state value. The default value for the property is False. @@ -522,7 +522,7 @@ - Provides access to the checked state for the control as a Boolean value + Provides access to the checked state for the control as a Boolean value.

Checked is a Boolean property used to read or write the checked or unchecked state for the control as a Boolean value. @@ -544,7 +544,9 @@ - Contains the checked, unchecked, or grayed state for the check box control + + Contains the checked, unchecked, or grayed state for the check box control. +

State is a TCheckBoxState property which contains the checked, unchecked, or grayed state for the check box control. The default value for the property is cbUnchecked. @@ -588,7 +590,7 @@ - Event handler signalled when the value for the control is changed + Event handler signalled when the value for the control is changed.

OnChange is a TNotifyEvent property with the event handler signalled when the value for the control is changed. @@ -612,7 +614,7 @@ - Implements a custom-drawn check box control + Implements a custom-drawn check box control.

TCheckBoxThemed is a TCustomCheckBoxThemed descendant which implements a custom-drawn check box control. It implements a custom paint method to render the control using theme services. TCheckBoxThemed is the type used to implement check box controls used in both the Object Inspector and Property editors in the Lazarus IDE. diff --git a/components/lazcontrols/docs/dividerbevel.xml b/components/lazcontrols/docs/dividerbevel.xml index 075afe8df2..7f2f34556d 100644 --- a/components/lazcontrols/docs/dividerbevel.xml +++ b/components/lazcontrols/docs/dividerbevel.xml @@ -195,7 +195,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance. @@ -204,7 +204,7 @@ - Owner of the class instance + Owner of the class instance. diff --git a/components/lazcontrols/docs/extendednotebook.xml b/components/lazcontrols/docs/extendednotebook.xml index 37432abb7b..56cccc0e27 100644 --- a/components/lazcontrols/docs/extendednotebook.xml +++ b/components/lazcontrols/docs/extendednotebook.xml @@ -329,7 +329,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance. diff --git a/components/lazcontrols/docs/extendedtabcontrols.xml b/components/lazcontrols/docs/extendedtabcontrols.xml index 8e5835528a..dc203eb25a 100644 --- a/components/lazcontrols/docs/extendedtabcontrols.xml +++ b/components/lazcontrols/docs/extendedtabcontrols.xml @@ -66,7 +66,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance. @@ -390,7 +390,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -412,7 +412,7 @@ - Number of tool buttons in the Buttons property + Number of tool buttons in the Buttons property.

ButtonCount is a read-only Integer property which contains the number of tool buttons available in the Buttons property. @@ -434,7 +434,7 @@ - Ordinal position for the requested tool button + Ordinal position for the requested tool button. @@ -475,7 +475,7 @@ - Drawing styleused for the inner edge of the tool bar + Drawing styleused for the inner edge of the tool bar.

EdgeInner is a TEdgeStyle property which indicates the drawing style used for the inner edge of the tool bar. The default value for the property is esRaised. @@ -612,7 +612,7 @@ - Internal TabControl used to display tabs + Internal TabControl used to display tabs.

TExtendedInternalTabControl is a TNoteBookStringsTabControl descendant. @@ -631,7 +631,7 @@ - List of tabs (and pages) used in TCustomExtendedTabControl + List of tabs (and pages) used in TCustomExtendedTabControl.

TExtendedTabControlNoteBookStrings is a TTabControlNoteBookStrings descendant. @@ -665,7 +665,7 @@ - Returns a TExtendedInternalTabControl type + Returns a TExtendedInternalTabControl type. @@ -797,7 +797,7 @@ - Class type used for Pages in TCustomExtendedTabControl + Class type used for Pages in TCustomExtendedTabControl.

Implements the class reference used for the PageClass and Pages properties in TCustomExtendedTabControl. diff --git a/components/lazcontrols/docs/listfilteredit.xml b/components/lazcontrols/docs/listfilteredit.xml index bd3c5c5475..6f981bf468 100644 --- a/components/lazcontrols/docs/listfilteredit.xml +++ b/components/lazcontrols/docs/listfilteredit.xml @@ -3,7 +3,7 @@ - Implements a control used to filter an associated list box + Implements a control used to filter an associated list box. @@ -38,7 +38,7 @@ - Filter for an associated ListBox + Filter for an associated ListBox.

TListFilterEdit is a TCustomControlFilterEdit descendant which implements a filter for an associated ListBox. @@ -49,23 +49,23 @@ - The control showing the filtered data + The control showing the filtered data. - Stores / restores the selections in the associated control + Stores / restores the selections in the associated control. - The orignal value supplied in the Data property + The orignal value supplied in the Data property. - Sorted values from the Data property + Sorted values from the Data property. - Contains the checked items for TCheckListBox + Contains the checked items for TCheckListBox. @@ -82,10 +82,10 @@ - Sets the value for the FilteredListbox property + Sets the value for the FilteredListbox property. - New value for the property + New value for the property. @@ -199,7 +199,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance. @@ -208,11 +208,11 @@ - Owner for the class instance + Owner for the class instance. - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -222,12 +222,12 @@ - Removes the specified item from the Items property + Removes the specified item from the Items property. - Item located and removed in the method + Item located and removed in the method. @@ -269,7 +269,7 @@ - The Listbox associated with the filter edit control + The Listbox associated with the filter edit control. diff --git a/components/lazcontrols/docs/listviewfilteredit.xml b/components/lazcontrols/docs/listviewfilteredit.xml index b71dfed923..6b22fc928c 100644 --- a/components/lazcontrols/docs/listviewfilteredit.xml +++ b/components/lazcontrols/docs/listviewfilteredit.xml @@ -42,7 +42,9 @@ - Implements the Equal (=) comparison operator for TListViewDataItem instances + + Implements the Equal (=) comparison operator for TListViewDataItem instances. + @@ -57,7 +59,7 @@ - List container for TListViewDataItem instances + List container for TListViewDataItem instances. @@ -66,14 +68,14 @@ - Implements a control used to filter an associated ListView + Implements a control used to filter an associated ListView. - A control showing the (filtered) data + A control showing the (filtered) data. @@ -81,15 +83,15 @@ - Stores / restores the previous selections in the associated control + Stores / restores the previous selections in the associated control. - Data supplied by the caller through the Items property + Data supplied by the caller through the Items property. - Data sorted for viewing + Data sorted for viewing. @@ -229,7 +231,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance. @@ -238,11 +240,11 @@ - Owner of the class instance + Owner of the class instance. - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -264,7 +266,7 @@ - Selected items restored after filtering + Selected items restored after filtering.

The list of selected items. They are restored after filtering. @@ -274,20 +276,20 @@ - Maintains the data which is filtered and shown in the ListView + Maintains the data which is filtered and shown in the ListView. - The associated ListView + The associated ListView. - Indicates if all fields are compared using the filter + Indicates if all fields are compared using the filter.

Use all ListView fields when searching filter matches. Otherwise just the first field (ListView caption) is used. diff --git a/components/lazcontrols/docs/lvlgraphctrl.xml b/components/lazcontrols/docs/lvlgraphctrl.xml index 53a7705108..de91b720e6 100644 --- a/components/lazcontrols/docs/lvlgraphctrl.xml +++ b/components/lazcontrols/docs/lvlgraphctrl.xml @@ -3,7 +3,7 @@ - Implements a Level (or Layered) Graph control + Implements a Level (or Layered) Graph control. @@ -223,7 +223,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -242,7 +242,7 @@ - Destructor for the class instance + Destructor for the class instance. @@ -484,7 +484,7 @@ - Drawing position for the node at the current Level + Drawing position for the node at the current Level. @@ -522,7 +522,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Last drawing position for the caption, with scrolling + Last drawing position for the caption, with scrolling.

DrawnCaptionRect is a read-only TRect property. @@ -532,7 +532,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Total weight for InEdges + Total weight for InEdges.

InWeight is a read-only Single property. @@ -542,7 +542,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Total weight for OutEdges + Total weight for OutEdges.

OutWeight is a read-only Single property. @@ -552,12 +552,12 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Class reference for the TLvlGrapNode type + Class reference for the TLvlGrapNode type. - Pointer to a TLvlGrapNode instance + Pointer to a TLvlGrapNode instance. @@ -573,7 +573,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - True when a circular reference exists between 2 nodes, with no levels between; i. e. both edges paint in the same location + True when a circular reference exists between 2 nodes, with no levels between; i. e. both edges paint in the same location. @@ -606,13 +606,13 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Pointer to the user data for the edge + Pointer to the user data for the edge. - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -628,7 +628,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -695,7 +695,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Last drawing rectangle, with scrolling + Last drawing rectangle, with scrolling. DrawnAt is a read-only TRect property. @@ -760,7 +760,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Pointer to a TLvlGraphEdge type + Pointer to a TLvlGraphEdge type. @@ -816,7 +816,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -832,7 +832,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -887,7 +887,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Sum of the maximum weights for each node: Max(InWeight,OutWeight) + Sum of the maximum weights for each node: Max(InWeight,OutWeight). @@ -940,7 +940,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -956,7 +956,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -1029,16 +1029,16 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Create separate hidden nodes for each edge; this creates a lot of hidden nodes + Create separate hidden nodes for each edge; this creates a lot of hidden nodes. - Combine hidden nodes at source (outgoing edge) + Combine hidden nodes at source (outgoing edge). - Combine hidden nodes at target (incoming edge) + Combine hidden nodes at target (incoming edge). - Combine hidden nodes at source or target, whichever has more edges + Combine hidden nodes at source or target, whichever has more edges. @@ -1167,7 +1167,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -1177,7 +1177,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -1432,7 +1432,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Creates levels using the edges for the Level Graph + Creates levels using the edges for the Level Graph. @@ -1469,7 +1469,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Splits long edges by adding hidden nodes + Splits long edges by adding hidden nodes. @@ -1523,13 +1523,13 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Permutates nodes to minimize crossings + Permutates nodes to minimize crossings. - Sets the position for all nodes to minimize overlappings + Sets the position for all nodes to minimize overlappings. @@ -1904,7 +1904,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -1913,11 +1913,11 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Level Graph control where values in the class instance are used + Level Graph control where values in the class instance are used. - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -2121,7 +2121,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -2134,7 +2134,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -2276,7 +2276,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the constructor for the class instance. @@ -2285,11 +2285,11 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Control where class instance is used + Control where class instance is used. - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -2331,7 +2331,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Maximum number of user-specified nodes for a level + Maximum number of user-specified nodes for a level.

MaxLevelHeightAbs is an Integer property with the maximum number of visible (user-specified) nodes in a level. 0 (zero) indicates that the maximum is ignored. The default value for the property is defined in the DefaultMaxLevelHeightAbs constant. @@ -2444,7 +2444,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Ancestor for the TLvlGraphControl control + Ancestor for the TLvlGraphControl control.

TCustomLvlGraphControl is a TCustomControl descendant which impements the ancestor for TLvlGraphControl. @@ -2758,7 +2758,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Draws a line for the specified Edge using the current Canvas color + Draws a line for the specified Edge using the current Canvas color. @@ -2843,7 +2843,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance. @@ -2852,11 +2852,11 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Owner of the class instance + Owner of the class instance. - Destructor for the class instance + Destructor for the class instance.

Destroy is the overridden destructor for the class instance. @@ -3059,13 +3059,13 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Event handler signalled to provide an alternative minimize crossing algorithm + Event handler signalled to provide an alternative minimize crossing algorithm. - Event handler signalled to provide an alternative minimize overlappings algorithm + Event handler signalled to provide an alternative minimize overlappings algorithm. @@ -3121,7 +3121,7 @@ DrawPositionEnd := DrawPosition + Max(InSize, OutSize); - Implements a control used to draw a level (or layered) graph + Implements a control used to draw a level (or layered) graph.

TLvlGraphControl is a TCustomLvlGraphControl 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. diff --git a/components/lazcontrols/docs/shortpathedit.xml b/components/lazcontrols/docs/shortpathedit.xml index ae03bade8e..40823c8721 100644 --- a/components/lazcontrols/docs/shortpathedit.xml +++ b/components/lazcontrols/docs/shortpathedit.xml @@ -3,7 +3,7 @@ - Implements the TShortPathEdit control + Implements the TShortPathEdit control. @@ -14,7 +14,7 @@ - Control used to select a directory on the local file system + Control used to select a directory on the local file system.

TShortPathEdit is a TDirectoryEdit descendant which allows selecting a directory on the local file system. @@ -40,7 +40,7 @@ - Creates and configures the dialog used to select a directory + Creates and configures the dialog used to select a directory.

CreateDialog is an overridden method in TShortPathEdit used to create and configure the directory selection dialog for the control. The return value contains the TCommonDialog descendant created and configured in the method. It is actually a TSelectDirectoryDialog instance. @@ -58,12 +58,12 @@ - Directory selection dialog created and configured in the method + Directory selection dialog created and configured in the method. - Executes the directory selection dialog for the control + Executes the directory selection dialog for the control.

RunDialog is an overridden method in TShortPathEdit. It is an alternate implementation, and does not call the inherited method. @@ -76,7 +76,7 @@ - Initial directory used in the directory selection dialog + Initial directory used in the directory selection dialog.

Directory is a String property used to specify the initial directory on the local file system used to select a directory in the control. It is used as the initial directory for the directory selection dialog executed in the RunDialog method. It is also used to store a valid path name returned from the directory selection dialog. @@ -89,7 +89,9 @@ - Event handler signalled when a directory is selected in the directory selection dialog + + Event handler signalled when a directory is selected in the directory selection dialog. +

OnAcceptDirectory is TAcceptFileNameEvent property with the event handler signalled when a directory path has been selected in the RunDialog method. Arguments to the event handler include the directory name selected in the dialog, or an empty string when the Cancel button is pressed in the dialog. diff --git a/components/lazcontrols/docs/spinex.xml b/components/lazcontrols/docs/spinex.xml index dc381f698e..00a0b75e51 100644 --- a/components/lazcontrols/docs/spinex.xml +++ b/components/lazcontrols/docs/spinex.xml @@ -3,7 +3,7 @@ - Provides extended TSpinEdit- and TFloatSpinEdit-like controls + Provides extended TSpinEdit- and TFloatSpinEdit-like controls.

Implements TSpinEditEx and TFloatSpinEditEx, which allow a NullValue and provide behaviors applied when the text for the control is not a valid number. @@ -26,7 +26,7 @@ - Specifies the behavior applied in a control when its text is not a valid number + Specifies the behavior applied in a control when its text is not a valid number.

@@ -58,7 +58,7 @@ - Specifies the base class for extended spin edit controls in the unit + Specifies the base class for extended spin edit controls in the unit.

TSpinEditExBase is a generic class type, and a descendant of TCustomAbstractGroupedEdit. TSpinEditExBase specifies the base class for the extended spin edit controls including TSpinEditEx and TFloatSpinEditEx. TSpinEditExBase must be specialized in a descendent class for a specific data type. The specialization type is used to implement properties including: Increment, MinValue, MaxValue, NullValue, and Value. @@ -76,16 +76,16 @@ - Default value for the Increment property + Default value for the Increment property. - Default value for the MaxValue property + Default value for the MaxValue property. - Default value for the MinValue property + Default value for the MinValue property. - Default value for the MinRepeatValue property + Default value for the MinRepeatValue property. @@ -103,29 +103,29 @@ - Gets the value for the Edit property + Gets the value for the Edit property. - Value for the property + Value for the property. - Sets the value for the MinRepeatValue property + Sets the value for the MinRepeatValue property. - New value for the property + New value for the property. - Called when one of the buttons in the TUpDown control has been clicked + Called when one of the buttons in the TUpDown control has been clicked. @@ -134,56 +134,56 @@ - True when the Up button in the TUpDown control has been clicked; False when the Down button has been clicked + True when the Up button in the TUpDown control has been clicked; False when the Down button has been clicked. - Gets the value for the NullValue property + Gets the value for the NullValue property. - Returns the generic type with the value for the NullValue property + Returns the generic type with the value for the NullValue property. - Gets the value for the UpDown property + Gets the value for the UpDown property. - Value for the property + Value for the property. - Gets the value for the Value property + Gets the value for the Value property. - Value for the property + Value for the property. - Gets the storage specifier for the Increment property + Gets the storage specifier for the Increment property. - True when a value other than DefIncrement has been assigned to the Increment property + True when a value other than DefIncrement has been assigned to the Increment property. - Indicates if valid values have been assigned to the MinValue and MaxValue properties + Indicates if valid values have been assigned to the MinValue and MaxValue properties.

The return value is True when MaxValue is larger than MinValue. IsLimited is used in the implementation of the IsOutOfLimits method. @@ -196,45 +196,45 @@ - True when the typed value in MaxValue is larger than the typed value in MinValue + True when the typed value in MaxValue is larger than the typed value in MinValue. - Determines if the specified value is not within the limits set in MinValue and MaxValue + Determines if the specified value is not within the limits set in MinValue and MaxValue. - True when the value is outside the limits specified in the MinValue and MaxValue properties + True when the value is outside the limits specified in the MinValue and MaxValue properties. - Value examined in the method + Value examined in the method. - Gets the storage specifier for the MaxValue property + Gets the storage specifier for the MaxValue property. - True when a value other than DefMaxValue has been assigned to the MaxValue property + True when a value other than DefMaxValue has been assigned to the MaxValue property. - Gets the storage specifier for the MaxValue property + Gets the storage specifier for the MaxValue property. - True when a value other than DefMaxValue has been assigned to the MinValue property + True when a value other than DefMaxValue has been assigned to the MinValue property. - Updates members in the control when editing is completed + Updates members in the control when editing is completed.

UpdateControl is a method used to update members in the class instance to reflect the state for the control. It is called when a new value is assigned to properties in the class instance. It is called when editing has been completed using the Edit for the grouped editing control. It is also called when the handle is allocated for the control in InitializeWnd. @@ -256,7 +256,7 @@ - Implements the OnChangingEx event handler assigned to UpDown + Implements the OnChangingEx event handler assigned to UpDown.

No actions are performed in the handler when ReadOnly is set to True. @@ -268,20 +268,20 @@ - Control for the event notification + Control for the event notification. - Not used in the method + Not used in the method. - Not used in the method + Not used in the method. - Indicates whether the up or down button was clicked in UpDown + Indicates whether the up or down button was clicked in UpDown. - Implements the OnClick event handler assigned to UpDown + Implements the OnClick event handler assigned to UpDown.

Calls the BuddyClick method for the grouped edit control. @@ -292,15 +292,15 @@ - Control for the event notification + Control for the event notification. - The button type for the TUpDown control + The button type for the TUpDown control. - Gets the class type used for Buddy in the grouped edit control + Gets the class type used for Buddy in the grouped edit control. @@ -308,11 +308,11 @@ - Returns a class reference to TUpDown + Returns a class reference to TUpDown. - Performs actions needed when the control is focused + Performs actions needed when the control is focused.

DoEnter is an overridden method in TSpinEditExBase, and calls the inherited method on entry. The inherited methods handle the change in control focus, and signal the OnEnter event handler (when assigned). DoEnter ensures that the initial Value for the control is stored internally for use with the NullValueBehaviour used for the control instance. @@ -328,7 +328,7 @@ - Gets the text displayed for the control + Gets the text displayed for the control.

RealGetText is an overridden TCaption function in TSpinEditExBase used to get the text displayed for the control. RealGetText checks whether a handle has been allocated for the control in the widget set class. When a handle is assigned, the inherited method is called to the Text for the Edit in the grouped edit control. Otherwise, ValueToStr is called to get the string representation for the control Value. @@ -342,12 +342,12 @@ - Contains the text with the value for the control + Contains the text with the value for the control. - Reverts changes made to the value for the control + Reverts changes made to the value for the control.

Reset is an overridden method in TSpinEditExBase used to revert changes made to the Value for the control. The IsMasked property is used to determine if an editing mask is in use in the Edit for the grouped edit control. When set to True, the inherited method is called to revert any changes made in Edit. When an editing mask is not in use, the initial value for the control (captured when it received focus) is restored in the Value property. @@ -366,7 +366,7 @@ - Signals the OnEditChange event handler for the Edit in the grouped edit control + Signals the OnEditChange event handler for the Edit in the grouped edit control.

Calls the inherited method and performs no additional actions. @@ -378,7 +378,7 @@ - Implements the KeyDown handler for the grouped edit control + Implements the KeyDown handler for the grouped edit control.

EditKeyDown is an overridden method in TSpinEditExBase which implements the KeyDown event handler for the Edit control. It calls the inherited method which signals the OnEditKeyDown event handler (when assigned). It also ensures that any keys explicitly handled in the grouped edit control are discarded by setting Key to 0 (zero). This includes the following virtual key codes and their associated actions: @@ -399,14 +399,14 @@ - Virtual key code examined in the handler + Virtual key code examined in the handler. - Shift, Ctrl, or Alt modifier for the key code + Shift, Ctrl, or Alt modifier for the key code. - Applies a Mouse Wheel Up message to the value for the control + Applies a Mouse Wheel Up message to the value for the control.

EditMouseWheelUp is the handler signalled when a Mouse Wheel Up message occurs in the Edit for the control. EditMouseWheelUp is overridden in TSpinEditExBase, and calls the inherited method. Handled is set to True if the mouse wheel message was handled in the ancestor class. When set to False, the SpinUpDown method is called to increment the value in the control. @@ -417,18 +417,18 @@ - Shift, Alt, or Ctrl modifier for the mouse wheel message + Shift, Alt, or Ctrl modifier for the mouse wheel message. - Coordinates for the Mouse pointer + Coordinates for the Mouse pointer. - True when the message is handled in the ancestor class + True when the message is handled in the ancestor class. - Handles mouse wheel down messages for the Edit in the control + Handles mouse wheel down messages for the Edit in the control.

EditMouseWheelDown is the handler signalled when a Mouse Wheel Down message occurs in the Edit for the control. EditMouseWheelDown is overridden in TSpinEditExBase, and calls the inherited method. Handled is set to True if the mouse wheel message was handled in the ancestor class. When set to False, the SpinUpDown method is called to decrement the value in the control. @@ -439,17 +439,17 @@ - Shift, Alt, or Ctrl modifier for the mouse message + Shift, Alt, or Ctrl modifier for the mouse message. - Coordinates for the mouse cursor + Coordinates for the mouse cursor. - True when the message was handled in the method + True when the message was handled in the method. - Ensures the incremented value is a valid number for the data type + Ensures the incremented value is a valid number for the data type.

SafeInc is a function used to increase the specified value by the Increment for the control. SafeInc ensures that the incremented value is valid for a given data type. It is an abstract virtual method, and must be implemented in a descendent class to use the specific data type for the specialization. @@ -470,14 +470,14 @@ - The incremented (and possibly constrained) value + The incremented (and possibly constrained) value. - Value incremented in the method + Value incremented in the method. - Ensures the decremented value is a valid number for the data type + Ensures the decremented value is a valid number for the data type.

SafeDec is a function used to decrease the specified value by the Increment for the control. SafeDec ensures that the decremented value is valid for a given data type. It is an abstract virtual method, and must be implemented in a descendent class to use the specific data type for the specialization. @@ -501,66 +501,66 @@ - The decremented (and possibly constrained) value + The decremented (and possibly constrained) value. - Sets the value for the Value property + Sets the value for the Value property. - New value for the property + New value for the property. - Sets the value for the NullValue property + Sets the value for the NullValue property. - New value for the property + New value for the property. - Sets the value for the MaxValue property + Sets the value for the MaxValue property. - New value for the property + New value for the property. - Sets the value for the MinValue property + Sets the value for the MinValue property. - New value for the property + New value for the property. - Sets the value for the Increment property + Sets the value for the Increment property. - New value for the property + New value for the property. - Indicates if the specified String contains a valid numeric value + Indicates if the specified String contains a valid numeric value.

TextIsNumber is an abstract virtual Boolean function which indicates the value specified in S represents a valid number. ANumber is an output parameter where the numeric value for the data type is stored. @@ -575,17 +575,17 @@ - True when S contains a value that can be converted to the data type for ANumber + True when S contains a value that can be converted to the data type for ANumber. - String converted to a numeric value in the method + String converted to a numeric value in the method. - Numeric value for the specified String + Numeric value for the specified String. - Performs actions needed when the handle is allocated for the control + Performs actions needed when the handle is allocated for the control.

InitializeWnd is an overridden method used to perform actions needed when the handle is allocated for the control, and before child controls are created. InitializeWnd calls the inherited method on entry. @@ -598,7 +598,7 @@ - Performs actions prior to freeing the handle for the control + Performs actions prior to freeing the handle for the control.

Ensures that the Value property is up-to-date before releasing the Handle for the control. @@ -611,7 +611,7 @@ - Performs action needed when the component has been loaded from the LCL streaming mechanism + Performs action needed when the component has been loaded from the LCL streaming mechanism.

@@ -650,7 +650,7 @@ - Text editor for the grouped edit control + Text editor for the grouped edit control.

Edit a read-only TGEEdit property which contains the editor for the grouped edit control. Edit is used to perform direct input of a new Value for the control. Edit allows use of the Up and Down cursor keys to increment or decrement the value when ArrowKeys is enabled. @@ -666,7 +666,7 @@ - Contains the TUpDown instance used in the grouped edit control + Contains the TUpDown instance used in the grouped edit control.

UpDown is a read-only property which contains the TUpDown instance used to increment or decrement the Value for the grouped edit control. Click on the buttons in UpDown to increase or decrease the Value for the control by the amount specified in the Increment property. @@ -683,7 +683,7 @@ - Indicates whether the TUpDown instance for the grouped edit control is visible + Indicates whether the TUpDown instance for the grouped edit control is visible.

UpDownVisible is a Boolean property which indicates if UpDown in the grouped edit control is visible. It is a convenience property; read and write access for the value are redirected to the Visible property in the TUpDown instance in UpDown. The default value for the property is True. @@ -697,7 +697,7 @@ - Contains the repeat interval for the TUpDown instance in the grouped edit control + Contains the repeat interval for the TUpDown instance in the grouped edit control.

MinRepeatValue contains the repeat interval used for the UpDown control in the grouped edit. The default value for the property is defined in the DefMinRepeatValue constant. @@ -714,7 +714,7 @@ - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create sets the default values for properties, including: @@ -742,11 +742,11 @@ - Owner of the class instance + Owner of the class instance. - Constrains the specified value to MinValue and MaxValue for the control + Constrains the specified value to MinValue and MaxValue for the control.

GetLimitedValue is used in the implementation of UpdateControl, SpinUpDown, and StrToValue methods. It is also called from the ValueToStr method in TCustomFloatSpinEditEx. @@ -764,14 +764,14 @@ - Value adjusted (when needed) to the MinValue and MaxValue constraints + Value adjusted (when needed) to the MinValue and MaxValue constraints. - Value examined (and adjusted when needed) in the method + Value examined (and adjusted when needed) in the method. - Converts the specified value to its representation as a String + Converts the specified value to its representation as a String.

ValueToStr is an abstract virtual String function used to convert the value specified in AValue to its representation as a String data type. ValueToStr must be implemented in a descendent class to use the data type and formatting needed for the specialization. @@ -783,14 +783,14 @@ - String representation for the specified data type + String representation for the specified data type. - Type with the numeric value converted in the method + Type with the numeric value converted in the method. - Converts the specified string to a numeric value for the generic data type + Converts the specified string to a numeric value for the generic data type.

StrToValue is a function which returns a generic type with the numeric value for the specified String. TextIsNumber is used to determine if S contains a valid numeric value. If S is not a valid number, the NullValueBehaviour property is used to determine the return value for the method. @@ -813,14 +813,14 @@ - Numeric value for the specified string + Numeric value for the specified string. - String representation converted in method + String representation converted in method. - Implements the EditingDone handler for the Edit in the grouped edit control + Implements the EditingDone handler for the Edit in the grouped edit control.

EditEditingDone is an overridden method in TSpinEditExBase. It calls the inherited method on entry to signal the OnEditingDone event handler (when assigned). @@ -835,7 +835,7 @@ - Value added to or subtracted from Value when the UpDown control is clicked + Value added to or subtracted from Value when the UpDown control is clicked.

Increment is a property which defines the value added to or subtracted from the control Value when the UpDown control is clicked. It is also used when ArrowKeys are enable in the Edit for the grouped edit control. @@ -855,7 +855,7 @@ - Minimum value allowed in the Value property + Minimum value allowed in the Value property.

MinValue is a property used to specify the minimum numeric value allowed in the Value property. MinValue uses the type specified for the generic class. Changing the property value causes UpdateControl to be called to range check and update members in the control. @@ -881,7 +881,7 @@ - Maximum value allowed in the Value property + Maximum value allowed in the Value property.

MaxValue is a property which contains the largest numeric value allowed in the Value property. MaxValue uses the type specified for the generic class. Changing the property value causes UpdateControl to be called to range check and update members in the control. @@ -907,7 +907,7 @@ - Value used when the text for the control is not a valid number + Value used when the text for the control is not a valid number.

NullValue contains the numeric value used when the text for the control does not represent a valid number. NullValue is assigned to Value when the NullValueBehaviour property is set to nvbLimitedNullValue or nvbShowTextHint. @@ -917,7 +917,7 @@ - Controls the logic applied when control text is not a valid number + Controls the logic applied when control text is not a valid number.

NullValueBehaviour is a TNullValueBehaviour property which contains the logic applied when the text for the control does not represent a valid numeric value. The default value for the property is nvbMinValue, and indicates that the value in MinValue is stored in the Value property when an invalid number is detected. @@ -933,7 +933,7 @@ - Numeric value for the control + Numeric value for the control.

Value is a property which contains the numeric value for the grouped edit control. Value used the data type specified for the generic class. @@ -965,12 +965,12 @@ - Indicates the display mode used for the floating point value in TFloatSpinEditEx + Indicates the display mode used for the floating point value in TFloatSpinEditEx. - Value is displayed with fixed precision and decimal places + Value is displayed with fixed precision and decimal places. @@ -979,7 +979,7 @@ - Value is automatically formatted using scientific notation when it exceeds the limits assigned in ExponentialFormatLimitPos or ExponentialFormatLimitNeg + Value is automatically formatted using scientific notation when it exceeds the limits assigned in ExponentialFormatLimitPos or ExponentialFormatLimitNeg. @@ -989,7 +989,7 @@ - A specialization of TSpinEditExBase for the Double data type + A specialization of TSpinEditExBase for the Double data type.

TCustomFloatSpinEditEx defines an extended spin edit control with an editor for the numeric value, and buttons to increment or decrement the control value.It is a TSpinEditExBase descendant which specializes the generic ancestor for the Double data type. Double is a real type which allows values in the range 5.0E-324 .. 1.7E+308 and uses 15-16 digits of precision. Double is used to implement properties including: Increment, MinValue, MaxValue, NullValue, and Value. @@ -1007,114 +1007,114 @@ - Default number of decimal places used to display the Value for the control + Default number of decimal places used to display the Value for the control. - Default decimal separator used in the floating point value + Default decimal separator used in the floating point value. - Number of decimal places used to display the Value for the control + Number of decimal places used to display the Value for the control. - Formatting used to edit and display the Value for the control + Formatting used to edit and display the Value for the control. - Number of digits displayed in an exponent using scientific notation + Number of digits displayed in an exponent using scientific notation. - Maximum exponent digits allowed before exponential notation is used for negative values + Maximum exponent digits allowed before exponential notation is used for negative values. - Maximum exponent digits allowed before exponential notation is used for positive values + Maximum exponent digits allowed before exponential notation is used for positive values. - Local format settings used in the control + Local format settings used in the control. - Number of digits of precision used to edit and display the Value for the control + Number of digits of precision used to edit and display the Value for the control. - Gets the value for the DecimalSeparator property + Gets the value for the DecimalSeparator property. - Value for the property + Value for the property. - Sets the value for the DecimalSeparator property + Sets the value for the DecimalSeparator property. - New value for the property + New value for the property. - Sets the value for the DisplayMode property + Sets the value for the DisplayMode property. - New value for the property + New value for the property. - Sets the value for the ExponentDigits property + Sets the value for the ExponentDigits property. - New value for the property + New value for the property. - Sets the value for the ExponentialFormatLimitNeg property + Sets the value for the ExponentialFormatLimitNeg property. - New value for the property + New value for the property. - Sets the value for the ExponentialFormatLimitPos property + Sets the value for the ExponentialFormatLimitPos property. - New value for the property + New value for the property. - Sets the value for the Precision property + Sets the value for the Precision property. - New value for the property + New value for the property. - Gets the local format settings for the control + Gets the local format settings for the control. - Local format settings used for the control + Local format settings used for the control. - Implements handler for KeyPress events in the Edit for the control + Implements handler for KeyPress events in the Edit for the control.

EditKeyPress is an overridden method in TCustomFloatSpinEditEx used to ensure that the specified character is valid for the Edit in the control. Key contains the character examined in the method. The allowed values in Key include the following characters: @@ -1151,11 +1151,11 @@ - Character examined in the method + Character examined in the method. - Determines if the specified string is a valid number for the numeric data type + Determines if the specified string is a valid number for the numeric data type.

TextIsNumber is an overridden Boolean function used to determine if the specified string contains a valid representation for the numeric data type in the control. TextIsNumber re-implements the inherited method to use the Double data type, and does not call the method in the ancestor class. @@ -1180,17 +1180,17 @@ - True if the specified string is a valid numeric value + True if the specified string is a valid numeric value. - String with the value examined in the method + String with the value examined in the method. - Stores the numeric value for the specified string; undefined when the result is False + Stores the numeric value for the specified string; undefined when the result is False. - Ensures the incremented value is a valid number for the Double data type + Ensures the incremented value is a valid number for the Double data type.

SafeInc is an overridden function in TCustomFloatSpinEditEx used to increase the specified value by the Increment for the control. SafeInc ensures that the incremented value is valid for the Double data type. SafeInc does not call the inherited method. @@ -1216,14 +1216,14 @@ - The numeric value after Increment has been added + The numeric value after Increment has been added. - Numeric value incremented in the method + Numeric value incremented in the method. - Ensures the decremented value is a valid number for the Double data type + Ensures the decremented value is a valid number for the Double data type.

SafeDec is an overridden function in TCustomFloatSpinEditEx used to decrease the specified value by the Increment for the control. SafeDec ensures that the decremented value is valid for the Double data type. SafeDec does not call the inherited method. @@ -1244,25 +1244,25 @@ - The numeric value after Increment has been subtracted + The numeric value after Increment has been subtracted. - Numeric value decremented in the method + Numeric value decremented in the method. - Sets the value for the DecimalPlaces property + Sets the value for the DecimalPlaces property. - New value for the property + New value for the property. - Specifies the formatting used to edit and display the Value for the control + Specifies the formatting used to edit and display the Value for the control.

DisplayMode is a TDisplayMode property which specifies the formatting used to edit and display the Value for the control. The default value for the property is dmFixed, and indicates that fixed precision and decimals are used when formatting the control value. @@ -1287,7 +1287,7 @@ - Maximum exponent allowed before exponential notation is required for a positive number + Maximum exponent allowed before exponential notation is required for a positive number.

@@ -1349,7 +1349,7 @@ - Number of digits of precision used after the decimal point in scientific notation + Number of digits of precision used after the decimal point in scientific notation.

Precision is an Integer property which specifies the number of digits of precision used after the decimal point for a floating point value in scientific notation. It is the value used as the precision argument for the FloatToStrF routine in RTL. The default value for the property is 6. The maximum precision for the data type is 15. @@ -1365,7 +1365,7 @@ - Number of digits prior to the decimal point used in scientific notation + Number of digits prior to the decimal point used in scientific notation.

ExponentDigits is an Integer property which contains the number of digits used before the decimal point when using scientific notation. The default value for the property is 2. @@ -1392,19 +1392,19 @@ - Gets the string representation for the numeric Value in the control + Gets the string representation for the numeric Value in the control. - String representation for the numeric Value + String representation for the numeric Value. - Numeric value examined and converted in the method + Numeric value examined and converted in the method. - Constructor for the class instance + Constructor for the class instance.

Create is the overridden constructor for the class instance, and calls the inherited constructor on entry. @@ -1436,7 +1436,7 @@ - Value used to represent a decimal point in the Edit control + Value used to represent a decimal point in the Edit control.

DecimalSeparator is a Char property which contains the character used as the decimal point in a floating point value. Read and write access for the property value are redirected to the local TFormatSetting stored in the class instance. This allows the control to set the decimal separator independent of the format settings for the platform or operating system. @@ -1459,7 +1459,7 @@ - Number of decimal places used to edit and display the Value for the control + Number of decimal places used to edit and display the Value for the control.

DecimalPlaces is an Integer property which indicates the number of decimal places used when formatting the Value for the control. It must contain a positive integer value or 0 (zero). The default value for the property is defined in the DefDecimals constant. Changing the value for the property causes the Value property to be updated, and calls UpdateControl to validate and update other members in the class instance. @@ -1481,7 +1481,7 @@ - Implement a spin edit control for a value using the Double data type + Implement a spin edit control for a value using the Double data type.

TFloatSpinEditEx is a TCustomFloatSpinEditEx descendant which implements a spin edit control for a value using the Double data type. TFloatSpinEditEx sets the visibility for properties defined in ancestor classes. @@ -1576,7 +1576,7 @@ - Defines the base class for a spin edit control for Int64 values + Defines the base class for a spin edit control for Int64 values.

TCustomSpinEditEx is a specialization of the generic TSpinEditExBase class for the Int64 data type. In addition to implementing the Int64 data type, it provides additional properties and methods used to validate, format, and display the numeric value. @@ -1607,22 +1607,22 @@ - Stores the thousands separator + Stores the thousands separator. - Sets the value for the ThousandSeparator property + Sets the value for the ThousandSeparator property. - New value for the property + New value for the property. - Implements the handler for KeyPress events in the Edit for the control + Implements the handler for KeyPress events in the Edit for the control.

EditKeyPress is an overridden method in TCustomSpinEditEx, and calls the inherited method on entry. The OnEditKeyPress event handler is signalled (when assigned) by the inherited method. @@ -1645,11 +1645,11 @@ - Character examined in the method + Character examined in the method. - Ensures the incremented value is valid for the data type + Ensures the incremented value is valid for the data type.

SafeInc is a function used to increase AValue by the amount specified in the Increment property. SafeInc is overridden in TCustomSpinEditEx to ensure that the incremented value is valid for the Int64 data type. @@ -1671,14 +1671,14 @@ - Numeric value after the increment has been added + Numeric value after the increment has been added. - Numeric value incremented in the method + Numeric value incremented in the method. - Ensures the decremented value is valid for the data type + Ensures the decremented value is valid for the data type.

SafeDec is a function used to decrease the specified value by the amount specified in the Increment property. SafeDec is overridden in TCustomSpinEditEx to ensure that the decremented value is valid for the Int64 data type. @@ -1700,14 +1700,14 @@ - Numeric value after the increment has been subtracted + Numeric value after the increment has been subtracted. - Numeric value decremented in the method + Numeric value decremented in the method. - Indicates if the specified String contains a valid Int64 data type + Indicates if the specified String contains a valid Int64 data type.

TextIsNumber is an overridden Boolean function which indicates if the value specified in S represents a valid number for the Int64 data type. @@ -1725,18 +1725,18 @@ - True when the text contains a valid Int64 value + True when the text contains a valid Int64 value. - Text converted to a numeric value in the method + Text converted to a numeric value in the method. - Contains the successfully converted numeric value for the string + Contains the successfully converted numeric value for the string. - Converts the specified numeric value to its String representation + Converts the specified numeric value to its String representation.

ValueToStr is an overridden String function used to convert the value specified in AValue to its representation as a String data type. AValue is an Int64 type. @@ -1755,14 +1755,14 @@ - String representation for the specified numeric value + String representation for the specified numeric value. - Numeric value converted in the method + Numeric value converted in the method. - Amount by which the control value is increased or decreased when UpDown is clicked + Amount by which the control value is increased or decreased when UpDown is clicked.

Increment is an Int64 property in TCustomSpinEditEx, and represents the amount by which the control value is increased or decreased when the UpDown button is clicked. The default value for the property is 1. @@ -1778,7 +1778,7 @@ - Contains the thousands separator used to format and display the control value + Contains the thousands separator used to format and display the control value.

ThousandSeparator is a String property which contains the character used as the thousands separator in the control. It is implemented as a String type to allow use of UTF-8-encoded characters in the property value. When it is unassigned (contains an empty string), the separator is not used to format the string value for the control. @@ -1799,7 +1799,7 @@ - Implements a spin edit control for an Int64 data type + Implements a spin edit control for an Int64 data type.

TSpinEditEx is a TCustomSpinEditEx descendant which implements a spin edit control using an Int64 value. TSpinEditEx sets the visibility for properties defined in ancestor classes. @@ -1896,7 +1896,7 @@ - Gets debugging information about a value from TNullValueBehaviour + Gets debugging information about a value from TNullValueBehaviour.

DbgS is an overloaded String function used to get information displayed in the Debugger. This variant of the routine accepts a TNullValueBehaviour argument, an converts the specified value to its string representation, @@ -1904,14 +1904,14 @@ - String representation for the specified null value behavior + String representation for the specified null value behavior. - Enumeration value converted to a string in the method + Enumeration value converted to a string in the method. - Introduction to Extended Spin Edit Controls + Introduction to Extended Spin Edit Controls.

The SpinEx.pp unit contains extended spin edit controls, like TSpinEditEx and TFloatSpinEditEx. They are very similar to TSpinEdit and TFloatSpinEdit, but provide additional features which allow a NullValue for the control and behaviors performed when the value for the control is not a valid numeric value. diff --git a/components/lazcontrols/docs/treefilteredit.xml b/components/lazcontrols/docs/treefilteredit.xml index 4b976ad0c2..cbdc1f7bd6 100644 --- a/components/lazcontrols/docs/treefilteredit.xml +++ b/components/lazcontrols/docs/treefilteredit.xml @@ -3,7 +3,7 @@ - Implements a control used to filter an associated TreeView + Implements a control used to filter an associated TreeView. @@ -30,16 +30,22 @@ - When a filtered text is a directory name, it is split and shown as a tree structure. + + When a filtered text is a directory name, it is split and shown as a tree structure. + - This has effect only in the "sub-branches" mode. The "whole tree" mode uses the existing tree nodes as is and only changes their visibility. +

+ This has effect only in the "sub-branches" mode. The "whole tree" mode uses the existing tree nodes as is and only changes their visibility. +

Tree branches are expanded also initially. - The branches are expanded in any case when the tree is filtered and matches are found. This setting only affects the initial state. +

+ The branches are expanded in any case when the tree is filtered and matches are found. This setting only affects the initial state. +

@@ -49,19 +55,26 @@ Get an existing branch for a given tree-node, or Nil if there is none. - This can be used only with the "sub-branches" mode. + +

+ This can be used only with the "sub-branches" mode. +

Get a new or existing branch with data cleared for a given tree-node. - This can be used only with the "sub-branches" mode. In fact calling this method switches - the filter into "sub-branches" mode. This is the way to add those branches. + +

+ This can be used only with the "sub-branches" mode. In fact calling this method switches the filter into "sub-branches" mode. This is the way to add those branches. +

- A branch associated with an existing TreeNode when the filter is used in "sub-branches" mode. + + A branch associated with an existing TreeNode when the filter is used in "sub-branches" mode. + diff --git a/components/rtticontrols/fpdoc/rttictrls.xml b/components/rtticontrols/fpdoc/rttictrls.xml index 0e66df8016..4bef46b9f6 100644 --- a/components/rtticontrols/fpdoc/rttictrls.xml +++ b/components/rtticontrols/fpdoc/rttictrls.xml @@ -2,14 +2,12 @@ - Contains controls which access properties in TPersistent objects using RTTI + + Contains controls which access properties in TPersistent objects using RTTI. +

- Provides LCL controls that access properties of TPersistent objects via RTTI (the FreePascal Run - Time Type Information). Every published property can be edited in the Object Inspector. There - you have a TOIPropertyGrid working with TEdit, TComboBox and TButton. These controls extends the - possibilities to edit single properties and the developer can choose how to represent the - property. + Provides LCL controls that access properties of TPersistent objects via RTTI (the FreePascal Run Time Type Information). Every published property can be edited in the Object Inspector. There you have a TOIPropertyGrid working with TEdit, TComboBox and TButton. These controls extends the possibilities to edit single properties and the developer can choose how to represent the property.

@@ -38,12 +36,11 @@ - Maps strings to alias strings + Maps strings to alias strings.

- Some RTTI controls uses this to map RTTI values to display values. Eventually accelerate search - for Names and Values. + Some RTTI controls uses this to map RTTI values to display values. Eventually accelerate search for Names and Values.

@@ -133,13 +130,13 @@ - Optional flags for TPropertyLink + Optional flags for TPropertyLink. - Options for the RTTI Control to Property Editor link + Options for the RTTI Control to Property Editor link. @@ -147,11 +144,11 @@ - Auto-save on EditingDone + Auto-save on EditingDone. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Set during default drawing. - - - - - - - - - - - - - - - - - - Out or undfined - - - - - A normal property cell - - - - - Header cell for property name - - - - - Header cell for alternative property name (e. g. FixedRows>1) - - - - - - - Header cell for the object name - - - - - Header cell for an alternative object name (e. g. FixedCols>1) - - - - - Corner cell at the left, top of the grid - - - - - - - - - - - - - - - - - Start object index at 1 for displayed object - - - - - Show only those properties in ShowOnlyProperties - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + Contains controls which access properties in TPersistent objects using RTTI. + + +

+ Provides LCL controls that access properties of TPersistent objects via RTTI (the FreePascal Run Time Type Information). Every published property can be edited in the Object Inspector. There you have a TOIPropertyGrid working with TEdit, TComboBox and TButton. These controls extends the possibilities to edit single properties and the developer can choose how to represent the property. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Set during default drawing. + + + + + + + + + + + + + + + + + + Out or undfined. + + + + + A normal property cell. + + + + + Header cell for property name. + + + + + Header cell for alternative property name (e. g. FixedRows>1). + + + + + + + Header cell for the object name. + + + + + Header cell for an alternative object name (e. g. FixedCols>1). + + + + + Corner cell at the left, top of the grid. + + + + + + + + + + + + + + + + + Start object index at 1 for displayed object. + + + + + Show only those properties in ShowOnlyProperties. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +