diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index 9b52e42e4d..1634efd8f6 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -403,12 +403,12 @@ - TStatusBar - a strip along the bottom of a form for displaying information on current status + TStatusBar - a strip along the bottom of a form for displaying information on current status -

TStatusBar - a strip along the bottom of a form for displaying information on current status

-

The bar may consist of a single SimplePanel, in which case the displayed text is contained in SimpleText.

-

However if SimplePanel is false, then there can be multiple panels or sub-sections of the status bar, whose properties are described in Panels.

-

The property SimpleText can be assigned programatically to display the value of some variable, such as the position of the Splitter in the example

+

TStatusBar - a strip along the bottom of a form for displaying information on current status

+

The bar may consist of a single SimplePanel, in which case the displayed text is contained in SimpleText.

+

However if SimplePanel is false, then there can be multiple panels or sub-sections of the status bar, whose properties are described in Panels.

+

The property SimpleText can be assigned programatically to display the value of some variable, such as the position of the Splitter in the example

@@ -587,27 +587,27 @@ - Panels - the list of strings to be placed in the sub-panels of TStatusBar + Panels - the list of strings to be placed in the sub-panels of TStatusBar -

If SimplePanel is false, the contents of Panels is displayed.

-

Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to Panels in the Object Inspector is selected and allows insertion of an arbitrary number of sub-panels with their own strings

+

If SimplePanel is false, the contents of Panels is displayed.

+

Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to Panels in the Object Inspector is selected and allows insertion of an arbitrary number of sub-panels with their own strings

- SimpleText - a character string containing the information to be displayed in the Status Bar + SimpleText - a character string containing the information to be displayed in the Status Bar -

SimpleText - a character string containing the information to be displayed in the Status Bar

+

SimpleText - a character string containing the information to be displayed in the Status Bar

This is displayed if SimplePanel is true; otherwise the information in Panels is displayed.

- SimplePanel - boolean. Is there just one continuous panel, or several sub-panels? + SimplePanel - boolean. Is there just one continuous panel, or several sub-panels? -

SimplePanel - boolean. Is there just one continuous panel, or several sub-panels?

-

If true, the value of SimpleText is displayed; if false, the contents of Panels is displayed.

-

Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to Panels is selected and allows insertion of an arbitrary number of sub-panels with their own strings

+

SimplePanel - boolean. Is there just one continuous panel, or several sub-panels?

+

If true, the value of SimpleText is displayed; if false, the contents of Panels is displayed.

+

Contents can be adjusted with a stringlist editor that pops up when the ellipsis (...) next to Panels is selected and allows insertion of an arbitrary number of sub-panels with their own strings

@@ -3090,11 +3090,11 @@ cdsIndeterminate - Caption - the name given to this item on the list + Caption - the name given to this item on the list - Cut this item from the list (but can be placed on clipboard) + Cut this item from the list (but can be placed on clipboard) @@ -3147,7 +3147,7 @@ cdsIndeterminate A list of items with a cache of the last accessed item - TListitems + TListitems has a built-in cache of the last accessed item. This will speed up interface updates since Item.Index is often used for the same item updating more properties. If FCacheIndex = -1 then the cache is not valid. @@ -3939,9 +3939,9 @@ cdsIndeterminate - TCustomListView - the ancestor class for TListView + TCustomListView - the ancestor class for TListView -

TCustomListView is the ancestor for TListView. If you want to define your own ListView class, you should use this class to derive it from.

+

TCustomListView is the ancestor for TListView. If you want to define your own ListView class, you should use this class to derive it from.

@@ -4444,9 +4444,9 @@ cdsIndeterminate - Change - Internal procedure to simulate the OnChange event + Change - Internal procedure to simulate the OnChange event -

This is an internal procedure which is called after an item has been changed. It is a programmatic method for simulating the OnChange event if the programmer has assigned a method to this event.

+

This is an internal procedure which is called after an item has been changed. It is a programmatic method for simulating the OnChange event if the programmer has assigned a method to this event.

@@ -4455,10 +4455,10 @@ cdsIndeterminate - ColClick - procedure to simulate the OnColumnClick event. + ColClick - procedure to simulate the OnColumnClick event. -

ColClick - procedure to simulate the OnColumnClick event.

-

Can be used programmatically to execute the same code as is used to respond to the OnColumnClick event

+

ColClick - procedure to simulate the OnColumnClick event.

+

Can be used programmatically to execute the same code as is used to respond to the OnColumnClick event

@@ -4561,16 +4561,16 @@ cdsIndeterminate - Columns - define and change the columns of a ListView + Columns - define and change the columns of a ListView -

Columns is a TCollectionItem and contains all information on the columns of a listview.

+

Columns is a TCollectionItem and contains all information on the columns of a listview.

- ColumnClick - determines if the OnColumnClick event will be executed. + ColumnClick - determines if the OnColumnClick event will be executed. -

The ColumnClick property of the ListView enables or disables the OnColumnClick Event. A call to OnColumnClick will only be done when a method has been assigned to the OnColumnClick event and ColumnClick is set to true (default).

+

The ColumnClick property of the ListView enables or disables the OnColumnClick Event. A call to OnColumnClick will only be done when a method has been assigned to the OnColumnClick event and ColumnClick is set to true (default).

@@ -4593,25 +4593,25 @@ cdsIndeterminate
- Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item + Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item -

Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item

-

Items is of type TListitems which has a built-in cache of the last accessed item. This speeds up interface updates since Item.Index is often used for the same item updating more properties. If FCacheIndex = -1 then the cache is not valid.

+

Items - the list of entries in the list. Held as a linked list with a cached index of the last accessed item

+

Items is of type TListitems which has a built-in cache of the last accessed item. This speeds up interface updates since Item.Index is often used for the same item updating more properties. If FCacheIndex = -1 then the cache is not valid.

- LargeImages - an ImageList to be used in association with the list of Items + LargeImages - an ImageList to be used in association with the list of Items -

LargeImages - an ImageList to be used in association with the list of Items

-

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

+

LargeImages - an ImageList to be used in association with the list of Items

+

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

SmallImages could be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated SmallImage was selected, the corresponding LargeImage would be displayed in another window.

-

A TImageList control needs to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

+

A TImageList control needs to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

- MultiSelect - enables the selection of more than one entry from Items - by pressing SHIFT or CTRL keys while selecting + MultiSelect - enables the selection of more than one entry from Items - by pressing SHIFT or CTRL keys while selecting @@ -4627,7 +4627,7 @@ cdsIndeterminate - ReadOnly - determines if the list can only be read, and not written or deleted. + ReadOnly - determines if the list can only be read, and not written or deleted. @@ -4643,11 +4643,11 @@ cdsIndeterminate - ScrollBars - the kind of scrollbars to be used: none, auto, horizontal or vertical + ScrollBars - the kind of scrollbars to be used: none, auto, horizontal or vertical - ShowColumnHeaders - whether headers for columns are to be displayed + ShowColumnHeaders - whether headers for columns are to be displayed @@ -4657,29 +4657,29 @@ cdsIndeterminate - SmallImages - an ImageList of small images (icons) to be used in association with the list of Items + SmallImages - an ImageList of small images (icons) to be used in association with the list of Items -

SmallImages - an ImageList of small images (icons) to be used in association with the list of Items

-

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

+

SmallImages - an ImageList of small images (icons) to be used in association with the list of Items

+

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

SmallImages could be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated SmallImage was selected, the corresponding LargeImage would be displayed in another window.

-

A TImageList control needs to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

+

A TImageList control needs to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

- SortType - whether to sort by text, by data, both or not at all + SortType - whether to sort by text, by data, both or not at all - SortColumn - the column that is being sorted + SortColumn - the column that is being sorted - StateImages - an imagelist of icons to demonstrate the state of a process or event + StateImages - an imagelist of icons to demonstrate the state of a process or event - ViewStyle - whether to view as a simple list, a list with large or small icons, or as a report + ViewStyle - whether to view as a simple list, a list with large or small icons, or as a report @@ -4734,19 +4734,19 @@ cdsIndeterminate - BoundingRect - the coordinates of the rectangle containing the ListView + BoundingRect - the coordinates of the rectangle containing the ListView - Canvas - defines the area on which all graphic material is drawn (Read-only) + Canvas - defines the area on which all graphic material is drawn (Read-only) - CheckBoxes - determines if the ListView shows checkboxes beside the items on the list + CheckBoxes - determines if the ListView shows checkboxes beside the items on the list - Column - reads the column information of the listview. + Column - reads the column information of the listview.

This property can be used to read the information of a column.

The column whose information is to be retrieved is determined by an index (AIndex). As with nearly all indexes, this index is 0 based. In column[0] the caption of the listitem is show, in subsequent column the subitems of the listitem are shown.

@@ -4759,11 +4759,11 @@ cdsIndeterminate
- DropTarget - location where an item from the list is to be dropped + DropTarget - location where an item from the list is to be dropped - FlatScrollBars - whether the scroll bars are to be displayed flat + FlatScrollBars - whether the scroll bars are to be displayed flat @@ -4791,19 +4791,19 @@ cdsIndeterminate - ItemFocused - the item currently receiving focus + ItemFocused - the item currently receiving focus - RowSelect - whether the user can select rows of items (across columns). Default false + RowSelect - whether the user can select rows of items (across columns). Default false - SelCount - the number of items selected + SelCount - the number of items selected - Selected - the current list item that has been selected + Selected - the current list item that has been selected @@ -4813,26 +4813,26 @@ cdsIndeterminate - TopItem - the first item on the list + TopItem - the first item on the list - ViewOrigin - the top left coordinate for the current view + ViewOrigin - the top left coordinate for the current view - VisibleRowCount - the number of rows visible in the current view (some items might have scrolled outside the window) + VisibleRowCount - the number of rows visible in the current view (some items might have scrolled outside the window) - TListView - a window showing a list of Items, which may or may not have associated icons + TListView - a window showing a list of Items, which may or may not have associated icons -

TListView - a window showing a list of items, which may or may not have associated icons

-

At first, this control looks very like TListBox, but it has a much higher degree of complexity. It is capable of displaying Items in Columns of Rows, and it can have images associated with the list Items.

-

The important information is held in Items, a string-list that can be created using the string-list editor obtained by right-clicking on the ListView in the Form Editor or by clicking on the ellipsis (...) next to the Items entry in the Object Inspector.

-

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

-

SmallImages (if assigned to a string-list) can be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated Small Image was selected, the corresponding Large Image would be displayed in another window.

-

One or more TImageList controls need to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. The image list can be populated by reading from files. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

+

TListView - a window showing a list of items, which may or may not have associated icons

+

At first, this control looks very like TListBox, but it has a much higher degree of complexity. It is capable of displaying Items in Columns of Rows, and it can have images associated with the list Items.

+

The important information is held in Items, a string-list that can be created using the string-list editor obtained by right-clicking on the ListView in the Form Editor or by clicking on the ellipsis (...) next to the Items entry in the Object Inspector.

+

A typical application might have two ImageLists: one ofLargeImages and one of SmallImages, containing two versions of the same collection of images, in large and small format; the index numbers of the first list would correspond with those in the second list.

+

SmallImages (if assigned to a string-list) can be displayed beside the text strings in the list view, and the programmer would supply code to ensure that when an item with its associated Small Image was selected, the corresponding Large Image would be displayed in another window.

+

One or more TImageList controls need to be selected and pasted on to the Form Designer, and the ImageList Editor can be opened from the pop-up menu obtained by right-clicking on TImageList icon in the Form Designer. The image list can be populated by reading from files. Then in the StringList editor for Items the correct ImageIndex must be allocated to each entry in the list.

@@ -6746,7 +6746,7 @@ cdsIndeterminate - Index - the sequence number of the current button in the list of buttons + Index - the sequence number of the current button in the list of buttons @@ -6774,7 +6774,7 @@ cdsIndeterminate - Is this button Down (ie has it been selected)? Default false + Is this button Down (ie has it been selected)? Default false @@ -6796,9 +6796,9 @@ cdsIndeterminate - A DropDownMenu that appears when this button is selected + A DropDownMenu that appears when this button is selected -

A DropDownMenu that appears when this button is selected

+

A DropDownMenu that appears when this button is selected

It uses the same code as a TPopupMenu, and offers a series of additional menu choices.

@@ -6824,7 +6824,7 @@ cdsIndeterminate
- ImageIndex - the index value of the image from the imagelist to be used with this button + ImageIndex - the index value of the image from the imagelist to be used with this button @@ -6834,7 +6834,7 @@ cdsIndeterminate - Is this button Marked (ie has it been selected)? Default false + Is this button Marked (ie has it been selected)? Default false @@ -7666,15 +7666,15 @@ cdsIndeterminate - The Images to be displayed on the buttons + The Images to be displayed on the buttons - Indent - the amount by which the buttons should be indented Default is 1 + Indent - the amount by which the buttons should be indented Default is 1 - Should the contents of the toolbar be displayed as a List? Default false + Should the contents of the toolbar be displayed as a List? Default false @@ -7738,7 +7738,7 @@ cdsIndeterminate - Wrapable - enables wrapping buttons to the next row if there are too many for the current row + Wrapable - enables wrapping buttons to the next row if there are too many for the current row @@ -7886,9 +7886,9 @@ cdsIndeterminate - TCustomTrackBar - the base class for TTrackBar + TCustomTrackBar - the base class for TTrackBar -

TCustomTrackBar defines many of the properties inherited by TTrackBar, a device that allows the user to determine the value of a variable using a quasi-analog slider

+

TCustomTrackBar defines many of the properties inherited by TTrackBar, a device that allows the user to determine the value of a variable using a quasi-analog slider

@@ -8129,45 +8129,45 @@ cdsIndeterminate - SetTick - set the interval for ticks on the taskbar (integer) + SetTick - set the interval for ticks on the taskbar (integer) - Frequency - how frequently the position of the slider is to be read and updated (currently unsupported) + Frequency - how frequently the position of the slider is to be read and updated (currently unsupported) - Line-Size - increment for slider position when an arrow key is pressed + Line-Size - increment for slider position when an arrow key is pressed - Max - the value corresponding to full movement of the slider. Default = 10 + Max - the value corresponding to full movement of the slider. Default = 10 - Min - the value associated with the minimum slider position. Default = 0 + Min - the value associated with the minimum slider position. Default = 0 - OnChange - action to be taken on change in the slider position + OnChange - action to be taken on change in the slider position - Orientation - horizontal or vertical + Orientation - horizontal or vertical - PageSize - increment for slider position when PageUp or PageDown key is pressed + PageSize - increment for slider position when PageUp or PageDown key is pressed - Position - the location of the slider along the track bar. Represents the Return value from the control + Position - the location of the slider along the track bar. Represents the Return value from the control - ScalePos - whether scaling label appears at top, bottom, left or right + ScalePos - whether scaling label appears at top, bottom, left or right @@ -8183,20 +8183,20 @@ cdsIndeterminate - Tickmarks - whether the ticks are above/left, below/right, or both - Tickmarks - where the ticks appear relative to the bar: above/left, below/right, or both + Tickmarks - whether the ticks are above/left, below/right, or both + Tickmarks - where the ticks appear relative to the bar: above/left, below/right, or both - TickStyle - none, produced automatically, or calculated manually + TickStyle - none, produced automatically, or calculated manually - TTrackBar: a device which allows the user to determine the value of a variable using a quasi-analog slider + TTrackBar: a device which allows the user to determine the value of a variable using a quasi-analog slider -

TTrackBar: a device which allows the user to determine the value of a variable using a quasi-analog slider

+

TTrackBar: a device which allows the user to determine the value of a variable using a quasi-analog slider

The device looks like a slider-potentiometer control on a hi-fi amplifier, and consists of a slider which can be moved along a bar using the mouse. Tick marks can be displayed along one or both edges, giving an indication of the proportion of the maximum value of the controlled variable that is being selected.

-

The Position property indicates the distance along the bar that the slider has been placed, either by the program or by mouse capture and movement

+

The Position property indicates the distance along the bar that the slider has been placed, either by the program or by mouse capture and movement

In the example, movement of the slider is detected and shown in the associated TProgressBar.

@@ -8858,8 +8858,8 @@ Const
- TTreeNode is a single item that holds data in TTreeView - A TTreeNode is part of a TTreeView and is used for storing data. This can be done by using the Caption property or for more complex data the Data property can be used. Each node can have sibling or child items associated with it. + TTreeNode is a single item that holds data in TTreeView + A TTreeNode is part of a TTreeView and is used for storing data. This can be done by using the Caption property or for more complex data the Data property can be used. Each node can have sibling or child items associated with it. @@ -10108,7 +10108,7 @@ Const
- A collection or list of TTreeNode + A collection or list of TTreeNode @@ -10835,8 +10835,8 @@ For the meaning of this options, see the documentation of TTreeView. - TCustomTreeView - ancestor class for TTreeView - TCustomTreeView - ancestor class for TTreeView, which displays a collection of items in a hierarchical tree form. This class defines many properties which are inherited by children classes, including loading the data from files or streams, saving to files or streams, updating, sorting alphabetically, editing, making visible or invisible, expanding or collapsing the tree display, and many more. + TCustomTreeView - ancestor class for TTreeView + TCustomTreeView - ancestor class for TTreeView, which displays a collection of items in a hierarchical tree form. This class defines many properties which are inherited by children classes, including loading the data from files or streams, saving to files or streams, updating, sorting alphabetically, editing, making visible or invisible, expanding or collapsing the tree display, and many more. @@ -12806,8 +12806,8 @@ For the meaning of this options, see the documentation of TTreeView. - TTreeView is a control that displays a hierarchical list of items - Use a TTreeView + TTreeView is a control that displays a hierarchical list of items + Use a TTreeView to display a hierarchical list of items. Items are shown by their caption and an optional bitmap. diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index 98bb8dfd30..4c40fe483f 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -250,7 +250,7 @@ It is the reverse of BitBtnKindToMsgDlgBtn. - TCommonDialog + TCommonDialog : the base type from which other dialogs are derived TCommonDialog: the base type from which all other dialogs are derived.
@@ -375,7 +375,7 @@ and the "Close" method to release it and free the used resources.
- Create + Create - constructor for dialogs @@ -464,7 +464,7 @@ and then check the result to see if the user made a valid choice and pressed the - HelpContext + HelpContext - an index to the context-dependent help message for this dialog @@ -482,11 +482,11 @@ and then check the result to see if the user made a valid choice and pressed the - TFileDialog + TFileDialog : allows selection of a file from the current directory.

- TFileDialog + TFileDialog : allows selection of a file from the current directory.

This is also the base class for the Open and Save (As) dialogs

@@ -691,7 +691,7 @@ and then check the result to see if the user made a valid choice and pressed the - Title + Title - the text appearing in the title label at the top of the dialog @@ -847,10 +847,10 @@ To set this property during runtime assign a value like: "All files|*.*|Lazarus - TOpenDialog + TOpenDialog : open a file in the current directory, selected by File Dialog. - TOpenDialog + TOpenDialog : open a file in the current directory, selected by File Dialog.
If the required file is not in the current directory, another directory can be selected with Select Directory