SimpleLayout is a Boolean property which indicates if the popup dialog for the control uses the 2 (rows) by 6 (columns) layout with 30 minute intervals between time values. The default value for the property is True. When set to False, a more detailed layout with 12 rows by 5 columns using 5 minute time intervals is used.
@@ -3266,7 +3266,7 @@
- .
+
The default value for the property is poScreenCenter.
diff --git a/docs/xml/lcl/extdlgs.xml b/docs/xml/lcl/extdlgs.xml
index c30a9b907c..9f2c8ca002 100644
--- a/docs/xml/lcl/extdlgs.xml
+++ b/docs/xml/lcl/extdlgs.xml
@@ -950,7 +950,7 @@
- .
+
@@ -1302,10 +1302,10 @@
- .
+
- .
+
@@ -1316,10 +1316,10 @@
- .
+
- .
+
@@ -1330,7 +1330,7 @@
- .
+
@@ -1341,7 +1341,7 @@
- .
+
@@ -1352,7 +1352,7 @@
- .
+
@@ -1363,7 +1363,7 @@
- .
+
@@ -1374,7 +1374,7 @@
- .
+
@@ -1387,7 +1387,7 @@
groupededit.pp provides a base class where a TCustomMaskEdit (derived) control is grouped inside a TCustomControl with another TControl derived class. The objective of this base class is to forward all relevant methods and properties of TCustomMaskEdit. Grouping the controls inside a TCustomControl is done, so that the resulting control can be aligned and anchored.
@@ -37,7 +37,7 @@
- Implements the edit control used in TCustomAbstractGroupedEdit
+ Implements the edit control used in TCustomAbstractGroupedEdit.
TGEEdit is a TCustomMaskedit descendant which implements the edit control used in TCustomAbstractGroupedEdit. TGEEdit provides an overridden method to handle Tab keys. The key can be frowarded to the control that owns the class instance, to the ancestor class, or simply discarded.
@@ -54,25 +54,25 @@
- Handles Tab key presses for the control
+ Handles Tab key presses for the control.
- True when the Tab key has been handled
+ True when the Tab key has been handled.
- True forwards the key to the ancestor class
+ True forwards the key to the ancestor class.
- Class type used to create instances of TGEEdit
+ Class type used to create instances of TGEEdit.
- Implements a grouped edit control
+ Implements a grouped edit control.
TCustomAbstractGroupedEdit is a TCustomControl descendant which implements a grouped edit control. TCustomAbstractGroupedEdit is composed of a TGEEdit control that provides an editor for the control value, and a related TControl descendant.
@@ -130,95 +130,95 @@
- Gets the value for the Alignment property
+ Gets the value for the Alignment property.
- Value for the property
+ Value for the property.
- Gets the value for the AutoSelect property
+ Gets the value for the AutoSelect property.
- Value for the property
+ Value for the property.
- Gets the value for the AutoSelected property
+ Gets the value for the AutoSelected property.
- Value for the property
+ Value for the property.
- Gets the value for the CanUndo property
+ Gets the value for the CanUndo property.
- Value for the property
+ Value for the property.
- Gets the value for the CaretPos property
+ Gets the value for the CaretPos property.
- Value for the property
+ Value for the property.
- Gets the value for the CharCase property
+ Gets the value for the CharCase property.
- Value for the property
+ Value for the property.
- Gets the value for the Color property
+ Gets the value for the Color property.
- Value for the property
+ Value for the property.
- Gets the value for the DirectInput property
+ Gets the value for the DirectInput property.
- Value for the property
+ Value for the property.
- Gets the value for the EchoMode property
+ Gets the value for the EchoMode property.
@@ -226,99 +226,99 @@
- Value for the property
+ Value for the property.
- Gets the value for the EditMask property
+ Gets the value for the EditMask property.
- Value for the property
+ Value for the property.
- Gets the value for the EditText property
+ Gets the value for the EditText property.
- Value for the property
+ Value for the property.
- Gets the value for the HideSelection property
+ Gets the value for the HideSelection property.
- Value for the property
+ Value for the property.
- Gets the value for the IsMasked property
+ Gets the value for the IsMasked property.
- Value for the property
+ Value for the property.
- Gets the value for the MaxLength property
+ Gets the value for the MaxLength property.
- Value for the property
+ Value for the property.
- Gets the value for the Modified property
+ Gets the value for the Modified property.
- Value for the property
+ Value for the property.
- Gets the value for the NumbersOnly property
+ Gets the value for the NumbersOnly property.
- Value for the property
+ Value for the property.
- Gets the value for the ParentColor property
+ Gets the value for the ParentColor property.
- Value for the property
+ Value for the property.
- Gets the value for the PasswordChar property
+ Gets the value for the PasswordChar property.
Read access for the the value is redirected to the PasswordChar property in BaseEditor.
@@ -328,22 +328,22 @@
- Value for the property
+ Value for the property.
- Gets the value for the ReadOnly property
+ Gets the value for the ReadOnly property.
- Value for the property
+ Value for the property.
- Gets the value for the SelLength property
+ Gets the value for the SelLength property.
Read access to the property value is redirected to BaseEditor.
@@ -352,11 +352,11 @@
- Value for the property
+ Value for the property.
- Gets the value for the SelStart property
+ Gets the value for the SelStart property.
Read access to the property value is redirected to BaseEditor.
@@ -365,11 +365,11 @@
- Value for the property
+ Value for the property.
- Gets the value for the SelText property
+ Gets the value for the SelText property.
Read access to the property value is redirected to BaseEditor.
@@ -378,11 +378,11 @@
- Value for the property
+ Value for the property.
- Gets the value for the TabStop property
+ Gets the value for the TabStop property.
Read access to the property value is redirected to BaseEditor.
@@ -391,11 +391,11 @@
- Value for the property
+ Value for the property.
- Gets the value for the TextHint property
+ Gets the value for the TextHint property.
Read access to the property value is redirected to BaseEditor.
@@ -404,47 +404,47 @@
- Value for the property
+ Value for the property.
- Executes the click event handler for the Buddy control
+ Executes the click event handler for the Buddy control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the click event handler for the BaseEditor control
+ Executes the click event handler for the BaseEditor control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the double click event handler for the BaseEditor control
+ Executes the double click event handler for the BaseEditor control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the OnChange event handler for the BaseEditor control
+ Executes the OnChange event handler for the BaseEditor control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the OnEditContextPopup handler for the control
+ Executes the OnEditContextPopup handler for the control.
@@ -459,12 +459,12 @@
- Executes the OnEditDragDrop event handler for the control
+ Executes the OnEditDragDrop event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -477,12 +477,12 @@
- Executes the OnEditDragOver event handler for the control
+ Executes the OnEditDragOver event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -501,40 +501,40 @@
- Executes the OnEditingDone event handler for the control
+ Executes the OnEditingDone event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the OnEditEnter event handler for the control
+ Executes the OnEditEnter event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the OnEditExit event handler for the control
+ Executes the OnEditExit event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the OnEditEndDrag event handler for the control
+ Executes the OnEditEndDrag event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -547,12 +547,12 @@
- Executes the OnEditKeyDown event handler for the control
+ Executes the OnEditKeyDown event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -562,24 +562,24 @@
- Executes the OnEditKeyPress event handler for the control
+ Executes the OnEditKeyPress event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
- Executes the OnEditKeyUp event handler for the control
+ Executes the OnEditKeyUp event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -589,12 +589,12 @@
- Executes the OnEditMouseDown event handler for the control
+ Executes the OnEditMouseDown event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -610,12 +610,12 @@
- Executes the OnEditMouseUp event handler for the control
+ Executes the OnEditMouseUp event handler for the control.
- Object instance for the event notification
+ Object instance for the event notification.
@@ -748,7 +748,7 @@
- Sets the value for the Alignment property
+ Sets the value for the Alignment property.
Write access for the property value is redirected to the Alignment property in BaseEditor.
@@ -758,11 +758,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the AutoSelect property
+ Sets the value for the AutoSelect property.
Write access for the property value is redirected to BaseEditor.
@@ -772,11 +772,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the AutoSelected property
+ Sets the value for the AutoSelected property.
Write access to the property value is redirected to BaseEditor.
@@ -787,11 +787,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the CaretPos property
+ Sets the value for the CaretPos property.
Write access to the property value is redirected to BaseEditor.
@@ -802,11 +802,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the CharCase property
+ Sets the value for the CharCase property.
Write access to the property value is redirected to BaseEditor.
@@ -819,11 +819,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the EchoMode property
+ Sets the value for the EchoMode property.
Write access to the property value is redirected to BaseEditor.
@@ -834,11 +834,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the EditMask property
+ Sets the value for the EditMask property.
Write access to the property value is redirected to BaseEditor.
@@ -849,11 +849,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the EditText property
+ Sets the value for the EditText property.
Write access to the property value is redirected to BaseEditor.
@@ -864,11 +864,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the HideSelection property
+ Sets the value for the HideSelection property.
Read and write access for the property value is redirected to BaseEditor.
@@ -881,22 +881,22 @@
- New value for the property
+ New value for the property.
- Sets the value for the Layout property
+ Sets the value for the Layout property.
- New value for the property
+ New value for the property.
- Sets the value for the MaxLength property
+ Sets the value for the MaxLength property.
@@ -904,11 +904,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the Modified property
+ Sets the value for the Modified property.
@@ -918,11 +918,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the NumbersOnly property
+ Sets the value for the NumbersOnly property.
@@ -931,11 +931,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the ParentColor property
+ Sets the value for the ParentColor property.
@@ -944,11 +944,11 @@
- New value for the property
+ New value for the property.
- Sets the value for the PasswordChar property
+ Sets the value for the PasswordChar property.
@@ -957,85 +957,85 @@
- New value for the property
+ New value for the property.
- Sets the value for the PopupMenu property
+ Sets the value for the PopupMenu property.
- New value for the property
+ New value for the property.
- Sets the value for the ReadOnly property
+ Sets the value for the ReadOnly property.
- New value for the property
+ New value for the property.
- Sets the value for the SelLength property
+ Sets the value for the SelLength property.
- New value for the property
+ New value for the property.
- Sets the value for the SelStart property
+ Sets the value for the SelStart property.
- New value for the property
+ New value for the property.
- Sets the value for the SelText property
+ Sets the value for the SelText property.
- New value for the property
+ New value for the property.
- Sets the value for the Spacing property
+ Sets the value for the Spacing property.
- New value for the property
+ New value for the property.
- Sets the value for the TabStop property
+ Sets the value for the TabStop property.
- New value for the property
+ New value for the property.
- Sets the value for the TextHint property
+ Sets the value for the TextHint property.
- New value for the property
+ New value for the property.
- Registers the widget set class used to create new instances of the grouped edit
+ Registers the widget set class used to create new instances of the grouped edit.
Calls the inherited method, and registers the following properties to be skipped during LCL component streaming:
@@ -1052,7 +1052,7 @@
- Calculates the preferred size for the control with optional space reserved by theme services
+ Calculates the preferred size for the control with optional space reserved by theme services.
@@ -1068,17 +1068,17 @@
- Width for the control; always zero in the method
+ Width for the control; always zero in the method.
- Height for the control
+ Height for the control.
- Indicates if additional space needed for theme services is reserved
+ Indicates if additional space needed for theme services is reserved.
- Creates the TControl instance assigned to the Buddy property
+ Creates the TControl instance assigned to the Buddy property.
CreateBuddy is a TControl function used to create the TControl instance assigned to the Buddy property. CreateBuddy calls GetBuddyClassType to get the class reference used to create new instances of the control, and calls its Create method using the current class instance as the owner for the TControl instance.
@@ -1095,20 +1095,20 @@
- TControl instance created in the method
+ TControl instance created in the method.
- Creates the TGEEdit instance used in the BaseEditor property
+ Creates the TGEEdit instance used in the BaseEditor property.
- TGEEdit instance created in the method
+ TGEEdit instance created in the method.
- Gives focus to the control, and optionally selects text in its editor
+ Gives focus to the control, and optionally selects text in its editor.
FocusAndMaybeSelectAll is a procedure used to give focus to the control, and to optionally select text in its editor. FocusAndMaybeSelectAll calls the SetFocus method in BaseEditor to ensure that the editor portion of the grouped edit control has focus.
@@ -1130,156 +1130,156 @@
- Gets the class reference used to create the BaseEditor for the control
+ Gets the class reference used to create the BaseEditor for the control.
- Class reference used to create the BaseEditor for the control
+ Class reference used to create the BaseEditor for the control.
- Gets the class reference used to create the Buddy for the control
+ Gets the class reference used to create the Buddy for the control.
- Class reference sed to create the Buddy for the control
+ Class reference sed to create the Buddy for the control.
- Gets the default size for new instances of the control
+ Gets the default size for new instances of the control.
- Default size for new class instances
+ Default size for new class instances.
- Sets the value for the DirectInput property
+ Sets the value for the DirectInput property.
- New value for the property
+ New value for the property.
- Gets the value for the text in the control
+ Gets the value for the text in the control.
- Value for the text in the control
+ Value for the text in the control.
- Sets the value for the text in the control
+ Sets the value for the text in the control.
- New value for the text in the control
+ New value for the text in the control.
- Gets the popup menu for the BaseEditor in the control
+ Gets the popup menu for the BaseEditor in the control.
- The popup menu for the BaseEditor in the control
+ The popup menu for the BaseEditor in the control.
- Gets the Caption used in the Buddy property
+ Gets the Caption used in the Buddy property.
- Caption used in the Buddy property
+ Caption used in the Buddy property.
- Gets the value for the BuddyCursor property
+ Gets the value for the BuddyCursor property.
- Value for the property
+ Value for the property.
- Gets the value for the BuddyHint property
+ Gets the value for the BuddyHint property.
- Value for the property
+ Value for the property.
- Gets the value for the BuddyWidth property
+ Gets the value for the BuddyWidth property.
- Value for the property
+ Value for the property.
- Sets the Caption used in the Buddy property
+ Sets the Caption used in the Buddy property.
- Value assigned as the Caption in the Buddy property
+ Value assigned as the Caption in the Buddy property.
- Sets the cursor shape used in the Buddy property
+ Sets the cursor shape used in the Buddy property.
- Value assigned as the Cursor in the Buddy property
+ Value assigned as the Cursor in the Buddy property.
- Sets the Hint displayed for the Buddy property
+ Sets the Hint displayed for the Buddy property.
- Value assigned as the Hint in the Buddy property
+ Value assigned as the Hint in the Buddy property.
- Sets the Width used for the Buddy property
+ Sets the Width used for the Buddy property.
- Value assigned as the Width in the Buddy property
+ Value assigned as the Width in the Buddy property.
- Performs actions needed when the Buddy control is clicked
+ Performs actions needed when the Buddy control is clicked.
Used in internal methods to redirect events from the Buddy control to the container class (the current class instance).
@@ -1302,7 +1302,7 @@
- Performs actions needed when the control is entered
+ Performs actions needed when the control is entered.
DoEnter is an overridden procedure used to perform actions needed when the control is entered using keyboard navigation. DoEnter calls the inherited DoEnter method to signal the OnEnter event handler, and calls the SetFocus method in BaseEditor at run-time. The focus change is not performed at design-time.
@@ -1314,7 +1314,7 @@
- Signals the OnEditChange event handler, when assigned
+ Signals the OnEditChange event handler, when assigned.
EditChange is a procedure used to signals the OnEditChange event handler, when assigned. EditChange is used in the implementation of the InternalOnEditChange method, which is assigned as the OnChange event handler in the BaseEditor property.
@@ -1327,7 +1327,7 @@
- Signals the internal OnEditClick event handler, when assigned
+ Signals the internal OnEditClick event handler, when assigned.
@@ -1590,14 +1590,14 @@
- Forwards a CheckCursor method call to the BaseEditor for the control
+ Forwards a CheckCursor method call to the BaseEditor for the control.
- Handles the control message received when the ParentColor property is changed
+ Handles the control message received when the ParentColor property is changed.
@@ -1616,83 +1616,83 @@
- Gets the offsets for the current text selection in the control
+ Gets the offsets for the current text selection in the control.
- Starting position for the text selection in the control
+ Starting position for the text selection in the control.
- Ending position for the text selection in the control
+ Ending position for the text selection in the control.
- Gets the value for the Spacing property
+ Gets the value for the Spacing property.
- Value for the property
+ Value for the property.
- Sets the current text selection in the control
+ Sets the current text selection in the control.
- Initial position selected in the control
+ Initial position selected in the control.
- Final position selected in the control
+ Final position selected in the control.
- Performs actions when the control has finished loading in the LCL streaming mechanism
+ Performs actions when the control has finished loading in the LCL streaming mechanism.
- Forwards a Reset method call to the BaseEditor in the control
+ Forwards a Reset method call to the BaseEditor in the control.
- Sets the value for the AutoSize property
+ Sets the value for the AutoSize property.
- New value for the property
+ New value for the property.
- Sets the value for the Color property
+ Sets the value for the Color property.
- New value for the property
+ New value for the property.
- Sets the value for the Cursor property
+ Sets the value for the Cursor property.
TControl.Cursor
- New value for the property
+ New value for the property.
@@ -1709,20 +1709,20 @@
- Indicates if the text in the control is automatically selected when focus is received
+ Indicates if the text in the control is automatically selected when focus is received.
- Indicates if the current text selection was performed automatically
+ Indicates if the current text selection was performed automatically.
- Represents the associated TControl instance in the grouped edit control
+ Represents the associated TControl instance in the grouped edit control.
Buddy normally contains a TSpeedButton, TUpDown or similar control. Derived classes may implement a different class type for the control using the GetBuddyClassType method.
@@ -1735,25 +1735,25 @@
- Caption used for the Buddy control
+ Caption used for the Buddy control.
- Cursor shape used for the Buddy control
+ Cursor shape used for the Buddy control.
- Hint displayed for the Buddy control
+ Hint displayed for the Buddy control.
- Width for the Buddy control
+ Width for the Buddy control.
@@ -1765,14 +1765,14 @@
- Indicates if text can be entered directly into the BaseEditor control
+ Indicates if text can be entered directly into the BaseEditor control.
- Represents the control used as the editor for the value in the grouped edit control
+ Represents the control used as the editor for the value in the grouped edit control.
@@ -1782,7 +1782,7 @@
- Contains the masking characters used in the editor for the control
+ Contains the masking characters used in the editor for the control.
EditMask is a String property that contains the masking characters used in the editor for the control. EditMask redirects read and write access for the property to the TGEEdit instance in the BaseEditor property.
@@ -1797,7 +1797,7 @@
- Contains the value entered in the control including masking characters
+ Contains the value entered in the control including masking characters.
@@ -1814,7 +1814,7 @@
- Determines if the control receives focus when the Buddy conrol is clicked
+ Determines if the control receives focus when the Buddy conrol is clicked.
FocusOnBuddyClick is a Boolean property which determines if the control receives focus (and a potential change to the text selection in the editor) when the Buddy control is clicked. The default value for the property is False.
@@ -1831,7 +1831,7 @@
- Indicates if an edit mask is in use in the BaseEditor in the grouped edit control
+ Indicates if an edit mask is in use in the BaseEditor in the grouped edit control.
@@ -1864,7 +1864,7 @@
- Spacing used between the BaseEditor and the Buddy controls
+ Spacing used between the BaseEditor and the Buddy controls.
Spacing is an Integer property that contains the spacing used between the BaseEditor and the Buddy controls.
@@ -1874,13 +1874,13 @@
- Event handler signalled when the Buddy control is clicked
+ Event handler signalled when the Buddy control is clicked.
- Constructor for the class instance
+ Constructor for the class instance.
Create is the overridden constructor for the class instance. Create allocates resources needed for the BaseEditor and Buddy properties prior to calling the inherited constructor. The default values for properties and event handlers are assigned in the constructor, including those needed in the BaseEditor and Buddy properties.
@@ -1898,11 +1898,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. Destroy calls the inherited destructor.
@@ -1915,7 +1915,7 @@
- Sets the focus to the editor in the control
+ Sets the focus to the editor in the control.
SetFocus is an overridden procedure which gives focus to the grouped edit control. SetFocus redirects the method call to the SetFocus method in the BaseEditor for the control.
@@ -1928,7 +1928,7 @@
- Performs actions needed when the control receives focus
+ Performs actions needed when the control receives focus.
Focused is an overridden Boolean function used to perform actions needed when the control receives focus. Focused calls the Focused method in the BaseEditor for the control.
@@ -1940,11 +1940,11 @@
- True when the control has focus
+ True when the control has focus.
- Removes the text content in the control
+ Removes the text content in the control.
Clear is a procedure used to remove the text content in the control. Clear class the Clear method in BaseEditor.
@@ -1957,45 +1957,45 @@
- Clears the content for the current selection in the control
+ Clears the content for the current selection in the control.
- Copies content in the control to the clipboard
+ Copies content in the control to the clipboard.
- Copies content in the control to the clipboard, and removes it from the control
+ Copies content in the control to the clipboard, and removes it from the control.
- Pastes content into the control from the clipboard
+ Pastes content into the control from the clipboard.
- Selects all of the content in the control
+ Selects all of the content in the control.
- Reverses the last edit performed on the control value
+ Reverses the last edit performed on the control value.
- Performs actions needed to validate the value for the control
+ Performs actions needed to validate the value for the control.
ValidateEdit is a procedure used to perform actions needed to validate the value for the control. The method calls the ValidateEdit method in the BaseEditor member to validate its Text against the edit mask assigned to the property.
@@ -2011,7 +2011,7 @@
- Indicates if the height for BaseEditor is used as the height for the control when autosizing
+ Indicates if the height for BaseEditor is used as the height for the control when autosizing.
@@ -2028,7 +2028,7 @@
- Indicates the text alignment used for the control value
+ Indicates the text alignment used for the control value.
Alignment is a TAlignment property which indicates the text alignment used for the control value in the BaseEditor control. Read and write access for the property value are redirected to the BaseEditor control.
@@ -2045,20 +2045,20 @@
- Indicates if the Undo method can used to revert changes to the control value
+ Indicates if the Undo method can used to revert changes to the control value.
- Position of the editing caret in the control
+ Position of the editing caret in the control.
- Controls the case conversion used for a value entered in the control
+ Controls the case conversion used for a value entered in the control.
CharCase is a TEditCharCase property that controls the case conversion used (if any) for a value entered in the control. The default value for the property is ecNormal, and indicates that no case conversion is used. See TEditCharCase for more information about the enumeration values supported for the type.
@@ -2079,7 +2079,7 @@
- Indicates if the color in the Parent control is used
+ Indicates if the color in the Parent control is used.
ParentColor is a Boolean property which indicates if the Color from the Parent control is used instead the value assigned to the control. When this property is True, all changes to Color in the parent will also be applied to the Color in the control, ensuring that they both contain the same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
@@ -2097,68 +2097,68 @@
- Indicates if characters entered in the control value are hidden, displayed, or obscured
+ Indicates if characters entered in the control value are hidden, displayed, or obscured.
- Hides the current text selection in the control
+ Hides the current text selection in the control.
- Maximum number of characters allowed in the editor for the control
+ Maximum number of characters allowed in the editor for the control.
- Indicates if the content in the control has been changed
+ Indicates if the content in the control has been changed.
- Indicates that only numbers can be enetered in the control value
+ Indicates that only numbers can be enetered in the control value.
- Contains the character displayed when entering a password value
+ Contains the character displayed when entering a password value.
- PopupMenu for the control
+ PopupMenu for the control.
- Indicates if value in the control cannot be changed
+ Indicates if value in the control cannot be changed.
- Number of characters in the current selection for the control
+ Number of characters in the current selection for the control.
- Starting position for the current selection in the control
+ Starting position for the current selection in the control.
- Returns the selected text in the control
+ Returns the selected text in the control.
GetSelText is a String function used to get the selected text in the grouped edit control. Read and write access to the property are redirected to the BaseEdit property.
@@ -2189,7 +2189,7 @@
- Contains the hint text displayed for the grouped edit control
+ Contains the hint text displayed for the grouped edit control.
TextHint is a TTranslateString property which contains the hint text displayed for the grouped edit control. Read and write access to the property value are redirected to the BaseEditor property.
@@ -2202,7 +2202,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 that contains the event handler signalled when the value for the control is changed. OnChange is triggered from the EditChange method called when the BaseEditor control has modified its value.
diff --git a/docs/xml/lcl/helpintfs.xml b/docs/xml/lcl/helpintfs.xml
index cf22e98d1a..ad47cbab3c 100644
--- a/docs/xml/lcl/helpintfs.xml
+++ b/docs/xml/lcl/helpintfs.xml
@@ -7,7 +7,7 @@
====================================================================
-->
- Interfaces to define the abstract HelpSystem
+ Interfaces to define the abstract HelpSystem.
helpintfs.pas contains interfaces to define the abstract HelpSystem.
@@ -29,7 +29,7 @@
- Exception raised for Help system errors
+ Exception raised for Help system errors.
All help-specific errors should use this Exception type.
@@ -39,7 +39,7 @@
- Represents result codes returned by THelpManager
+ Represents result codes returned by THelpManager.
TShowHelpResult is an enumerated type with values that represent result codes for help requests using THelpManager. It is also the type returned from convenience methods like ShowTableOfContents, ShowHelpForKeyword, ShowHelpForPascalContexts, et. al.
@@ -50,41 +50,41 @@
- No help result available (help error)
+ No help result available (help error).
- Help request successfully completed
+ Help request successfully completed.
- Help request was canceled
+ Help request was canceled.
- Help database was not found
+ Help database was not found.
- Help database found, but the context was not found
+ Help database found, but the context was not found.
- No Help viewer registered for this format
+ No Help viewer registered for this format.
- No Help found for the keyword or directive
+ No Help found for the keyword or directive.
- Help viewer could not display a help node
+ Help viewer could not display a help node.
- No help node(s) found for the help selector
+ No help node(s) found for the help selector.
- Set type used to store values from the TShowHelpResult enumeration
+ Set type used to store values from the TShowHelpResult enumeration.
- Identifier used to represent a Help database
+ Identifier used to represent a Help database.
THelpDatabaseID is an alias for the String type.
@@ -108,7 +108,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -140,7 +140,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -168,7 +168,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -197,7 +197,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -234,7 +234,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -308,7 +308,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -324,7 +324,7 @@
- Destructor for the class instance
+ Destructor for the class instance.
@@ -352,7 +352,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -372,7 +372,7 @@
- Defines a help manager used to display a help query or a table of contents
+ Defines a help manager used to display a help query or a table of contents.
@@ -596,7 +596,7 @@
- Display the Help table of contents
+ Display the Help table of contents.
@@ -752,7 +752,7 @@
- Displays a Help file wih the given file name and MIME type
+ Displays a Help file wih the given file name and MIME type.
@@ -793,7 +793,7 @@
- Display a Help file wih the give URL and MIME type
+ Display a Help file wih the give URL and MIME type.
@@ -834,7 +834,7 @@
- Displaying Help (How It Works)
+ Displaying Help (How It Works).
diff --git a/docs/xml/lcl/icnstypes.xml b/docs/xml/lcl/icnstypes.xml
index 619cd6a714..ed2f319e58 100644
--- a/docs/xml/lcl/icnstypes.xml
+++ b/docs/xml/lcl/icnstypes.xml
@@ -9,7 +9,7 @@
-->
-Provides support for Mac OS X icon resources
+Provides support for Mac OS X icon resources.
icnstypes.pas contains types, constants and functions needed to read Mac OS X icon resource files (or icns). Most defines present here were taken from the univint package in FPC.
diff --git a/docs/xml/lcl/imagelistcache.xml b/docs/xml/lcl/imagelistcache.xml
index 75d227e52e..a6484548bd 100644
--- a/docs/xml/lcl/imagelistcache.xml
+++ b/docs/xml/lcl/imagelistcache.xml
@@ -10,7 +10,7 @@
-Implements a caching mechanism for TCustomImageList (TImageList) instances
+Implements a caching mechanism for TCustomImageList (TImageList) instances.
@@ -34,7 +34,7 @@ This file is part of the Lazarus Component Library (LCL).
-Interface that cache user should have to listen for cache changes
+Interface that cache user should have to listen for cache changes.
@@ -47,36 +47,36 @@ Interface that cache user should have to listen for cache changes
-Sets the image list for the cache listener
+Sets the image list for the cache listener.
-TCustomImageList instance for the listener
+TCustomImageList instance for the listener.
-Sets the new image index for an image in the list
+Sets the new image index for an image in the list.
-Old image index in the listener
+Old image index in the listener.
-New image index in the listener
+New image index in the listener.
-Represents an item in the cache
+Represents an item in the cache.
@@ -86,27 +86,27 @@ Interface that cache user should have to listen for cache changes
-Reference to the image list
+Reference to the image list.
-Reference to the listener interface
+Reference to the listener interface.
-Indices in the image list that the listener has reserved
+Indices in the image list that the listener has reserved.
-Pointer to a TImageCacheItem type
+Pointer to a TImageCacheItem type.
-Implements a container for cached image lists
+Implements a container for cached image lists.
TImageCacheItems is a TList descendant which implements
@@ -136,7 +136,7 @@ TImageCacheItems is used in the implementation of the
-Notifies observers when a value in the container has been changed
+Notifies observers when a value in the container has been changed.
@@ -145,17 +145,17 @@ TImageCacheItems is used in the implementation of the
-Untyped Pointer to the value for the change notification
+Untyped Pointer to the value for the change notification.
-Action for the notification (Add, Extract, Delete)
+Action for the notification (Add, Extract, Delete).
-Allocates and stores a new image list reference in the container
+Allocates and stores a new image list reference in the container.
GetNew is a PImageCacheItem function used to allocate and
@@ -172,13 +172,13 @@ the container.
-Reference for an image list stored in the container
+Reference for an image list stored in the container.
-Provides indexed access to image list references in the container
+Provides indexed access to image list references in the container.
@@ -198,12 +198,12 @@ Items is the default property for the container.
-Ordinal position in the container for the requested image list
+Ordinal position in the container for the requested image list.
-Implements a caching mechanism for image lists
+Implements a caching mechanism for image lists.
TImageListCache is a class which implements a caching mechanism for
@@ -230,37 +230,37 @@ initiate actions affecting the cache storage.
Determines if the cache storage needs to be rebuilt when the change
-threshold is exceeded
+threshold is exceeded.
-Gets a TCustomImageList instance with the specified image size
+Gets a TCustomImageList instance with the specified image size.
-Width for the images in the image list
+Width for the images in the image list.
-Height for the images in the image list
+Height for the images in the image list.
-Marks an image list and its images as unused for the specified cache listener
+Marks an image list and its images as unused for the specified cache listener.
-Cache listener removed in the method
+Cache listener removed in the method.
-Constructor for the class instance
+Constructor for the class instance.
Allocates resources needed for internal members in the class instance.
@@ -271,7 +271,7 @@ Allocates resources needed for internal members in the class instance.
-Destructor for the class instance
+Destructor for the class instance.
Frees resources allocated to internal members in the class instance,
@@ -284,7 +284,7 @@ including any stored images requested by cache listeners.
-Adds a listener for an image list stored in the cache
+Adds a listener for an image list stored in the cache.
@@ -305,21 +305,21 @@ RegisterListener is called from the RegisterBitmap method.
-Position where the specified listener was stored in the internal list
+Position where the specified listener was stored in the internal list.
-Listener interface added to the internal list
+Listener interface added to the internal list.
-Removes the specified cache listener from the internal list
+Removes the specified cache listener from the internal list.
@@ -341,13 +341,13 @@ singleton used for the image list cache is set to Nil.
-Cache listener removed from the list
+Cache listener removed from the list.
-Adds the specified bitmap to the image list for a cache listener
+Adds the specified bitmap to the image list for a cache listener.
@@ -377,22 +377,22 @@ the index positions used in the image list.
-Interface for the cache listener for the bitmap
+Interface for the cache listener for the bitmap.
-Bitmap registered in the method
+Bitmap registered in the method.
-Number of image "slices" in the bitmap
+Number of image "slices" in the bitmap.
-Rebuilds the cache storage
+Rebuilds the cache storage.
Removes unused image lists in the cache where the cache listener is no
@@ -407,7 +407,7 @@ indexes.
-Provides access to the TImageListCache singleton in the implementation
+Provides access to the TImageListCache singleton in the implementation.
@@ -415,7 +415,7 @@ Provides access to the TImageListCache singleton in the implementation
-TImageListCache instance for the implementation
+TImageListCache instance for the implementation.
diff --git a/docs/xml/lcl/imglist.xml b/docs/xml/lcl/imglist.xml
index 1482cfe79c..890b423e79 100644
--- a/docs/xml/lcl/imglist.xml
+++ b/docs/xml/lcl/imglist.xml
@@ -8,8 +8,8 @@
-->
- Contains classes and types used in TCustomImageList, the base class for TImageList
-
+ Contains classes and types used in TCustomImageList, the base class for TImageList.
+
imglist.pp implements TImageList and TChangelink in the Lazarus Component Library (LCL).
@@ -49,7 +49,7 @@
- Type used for an image list index (integer)
+ Type used for an image list index (integer).
Not used in the current implementation. Exists for Delphi compatibility only, but is unused there as well.
@@ -57,7 +57,7 @@
- Specifies an event handler signalled when images are removed from TImageList
+ Specifies an event handler signalled when images are removed from TImageList.
@@ -69,18 +69,18 @@
- Image list generating the event notification
+ Image list generating the event notification.
- Width of the image being removed
+ Width of the image being removed.
- Handle for the image list updated in the method
+ Handle for the image list updated in the method.
- Performs notifications when images are added or deleted in TImageList
+ Performs notifications when images are added or deleted in TImageList.
@@ -103,7 +103,7 @@
- Destructor for the class instance
+ Destructor for the class instance.
Destroy is the overridden destructor for the class instance. Destroy ensures that the image list in the Sender property calls its UnRegisterChanges method before freeing the class instance. When Sender is unassigned (contains Nil), no actions are performed. Destroy calls the inherited destructor prior to exiting from the method.
@@ -117,7 +117,7 @@
- Signals the OnChange event handler
+ Signals the OnChange event handler.
@@ -131,7 +131,7 @@
- Event handler signalled for a change in the image list
+ Event handler signalled for a change in the image list.
@@ -146,13 +146,13 @@
- The Image list for change notifications in the class
+ The Image list for change notifications in the class.
- Defines drawing styles for images
+ Defines drawing styles for images.
@@ -162,23 +162,23 @@
- Draws the image background using its focused color
+ Draws the image background using its focused color.
- Draws the image background using its selected color
+ Draws the image background using its selected color.
- Draw using BkColor for the background, or transparent if BkColor is clNone
+ Draw using BkColor for the background, or transparent if BkColor is clNone.
- Always draw transparently, ignore BkColor and BlendColor
+ Always draw transparently, ignore BkColor and BlendColor.
- Indicates if an image contains display data or a mask for its transparent parts
+ Indicates if an image contains display data or a mask for its transparent parts.
@@ -188,15 +188,15 @@
- Does not represent a mask
+ Does not represent a mask.
- Contains a mask
+ Contains a mask.
- Represents the valid index positions used to access overlay image assignments
+ Represents the valid index positions used to access overlay image assignments.
@@ -213,7 +213,7 @@
- Implements an image resolution (or size) used in TCustomImageList
+ Implements an image resolution (or size) used in TCustomImageList.
@@ -251,7 +251,7 @@
- Allocates storage for the specified number of images in the resolution
+ Allocates storage for the specified number of images in the resolution.
@@ -266,19 +266,19 @@
- Number of images that require data storage
+ Number of images that require data storage.
- Gets the value for the Reference property
+ Gets the value for the Reference property.
- Value for the Reference property
+ Value for the Reference property.
- Adds an image with an optional mask to the resolution
+ Adds an image with an optional mask to the resolution.
@@ -300,78 +300,78 @@
- Ordinal position for the image added in the method
+ Ordinal position for the image added in the method.
- Bitmap image added in the method
+ Bitmap image added in the method.
- Optional bitmap mask for the image
+ Optional bitmap mask for the image.
- Performs actions to insert raw image data at the specified position
+ Performs actions to insert raw image data at the specified position.
- Position where image data is inserted in the list
+ Position where image data is inserted in the list.
- Bitmap data to insert at the specified position
+ Bitmap data to insert at the specified position.
- Performs actions to move the storage position for image data
+ Performs actions to move the storage position for image data.
- Current position of the image moved in the method
+ Current position of the image moved in the method.
- New position for the image
+ New position for the image.
- Indicates if memory in the current index position is updated after moving the image data
+ Indicates if memory in the current index position is updated after moving the image data.
- Performs actions to replace image data at the specified position
+ Performs actions to replace image data at the specified position.
- Position in the list where the image data is stored
+ Position in the list where the image data is stored.
- Image data stored in the method
+ Image data stored in the method.
- Performs actions to store raw image data at the specified position
+ Performs actions to store raw image data at the specified position.
- Pointer to the 32-bit RGBA raw image data stored in the method
+ Pointer to the 32-bit RGBA raw image data stored in the method.
- Position in the list where image data is stored
+ Position in the list where image data is stored.
- Image data stored in the method
+ Image data stored in the method.
- Ensures an index position is valid for the specified operation
+ Ensures an index position is valid for the specified operation.
@@ -393,14 +393,14 @@
- Ordinal position in the list to validate in the method
+ Ordinal position in the list to validate in the method.
- Indicates if the index position is for an insert operation
+ Indicates if the index position is for an insert operation.
- Removes all image data for the current resolution
+ Removes all image data for the current resolution.
Clear is a procedure used to remove the 32-bit RGBA raw image data stored in the class instance. No actions are performed in the method when images have not been stored using the resolution.
@@ -419,7 +419,7 @@
- Deletes the image at the specified position in the resolution
+ Deletes the image at the specified position in the resolution.
Delete is a procedure used to delete the image at the specified position in the resolution.
@@ -440,12 +440,12 @@
- Ordinal position for the image deleted in the method
+ Ordinal position for the image deleted in the method.
- Stores raw image data for all images in the resolution to a bitmap
+ Stores raw image data for all images in the resolution to a bitmap.
@@ -471,12 +471,12 @@
- Raw image data for all images in the resolution
+ Raw image data for all images in the resolution.
- Stores the raw image data for the resolution to a Stream
+ Stores the raw image data for the resolution to a Stream.
@@ -501,15 +501,15 @@
- Stream where raw image data for the resolution is stored
+ Stream where raw image data for the resolution is stored.
- Indicates if compression is applied to raw image data
+ Indicates if compression is applied to raw image data.
- Reads raw image data from the specified Stream
+ Reads raw image data from the specified Stream.
@@ -568,11 +568,11 @@
- Stream which contains the raw image data read in the method
+ Stream which contains the raw image data read in the method.
- Gets the Handle for the Reference image list
+ Gets the Handle for the Reference image list.
GetReferenceHandle is an overridden method used to get the handle for the TWSCustomImageListReference class for the widgetset. Some (all?) platforms / widgetsets require a handle when manipulating an image list. GetReferenceHandle uses the value in the Reference property to supply the value for the Handle.
@@ -583,32 +583,32 @@
- Handle for the Reference class in the image list
+ Handle for the Reference class in the image list.
- Creates the Reference image list using the facilities for the widgetset
+ Creates the Reference image list using the facilities for the widgetset.
- Class instance for the reference class
+ Class instance for the reference class.
- Parameters used to create the reference class
+ Parameters used to create the reference class.
- Registers the class type used to create references for the widgetset
+ Registers the class type used to create references for the widgetset.
- Notifies an image list list when the handle for the resolution is freed
+ Notifies an image list list when the handle for the resolution is freed.
@@ -618,13 +618,13 @@
- Destructor for the class instance
+ Destructor for the class instance.
- Get the coordinates for the HotSpot in an image in the list
+ Get the coordinates for the HotSpot in an image in the list.
GetHotSpot is a TPoint function used to get the HotSpot for an image stored in the resolution. The HotSpot is an offset from the drawing position to the image origin. A HotSpot is used only in TDragImageList. In TCustomImageList, its position is always (0,0).
@@ -633,12 +633,12 @@
- Point with the horizontal and vertical offset for the image hot spot
+ Point with the horizontal and vertical offset for the image hot spot.
- Stores the image description for the raw image data for the resolution
+ Stores the image description for the raw image data for the resolution.
@@ -700,12 +700,12 @@
- Stores values updated in the method
+ Stores values updated in the method.
- Gets the bitmap for an image drawn using the specified drawing effect
+ Gets the bitmap for an image drawn using the specified drawing effect.
@@ -733,18 +733,18 @@
- Ordinal position for the image in the list
+ Ordinal position for the image in the list.
- Bitmap updated in the method
+ Bitmap updated in the method.
- Drawing effect applied to the bitmap
+ Drawing effect applied to the bitmap.
- Gets an Icon rendered using the specified drawing effect
+ Gets an Icon rendered using the specified drawing effect.
@@ -772,18 +772,18 @@
- Ordinal position for the image requested in the method
+ Ordinal position for the image requested in the method.
- TIcon class where the image data is stored
+ TIcon class where the image data is stored.
- Drawing effect applied to the rendered image
+ Drawing effect applied to the rendered image.
- Gets a bitmap representing all images in the resolution
+ Gets a bitmap representing all images in the resolution.
@@ -808,15 +808,15 @@
- Bitmap image with the combined images for the resolution
+ Bitmap image with the combined images for the resolution.
- Drawing effect applied to images and stored in the bitmap
+ Drawing effect applied to images and stored in the bitmap.
- Gets the 32-bit RGBA raw image data for the specified image
+ Gets the 32-bit RGBA raw image data for the specified image.
@@ -847,14 +847,14 @@
- Ordinal position for the image in the list
+ Ordinal position for the image in the list.
- TRawImage instance where image data is stored in the method
+ TRawImage instance where image data is stored in the method.
- Renders an image to the specified canvas
+ Renders an image to the specified canvas.
Draw is an overloaded method used to render an image to the specified canvas. Overloaded variants allow the use of a drawing effect or style for the rendered image.
@@ -890,33 +890,33 @@
- Canvas where the image is drawn
+ Canvas where the image is drawn.
- Horizontal offset for the image on the canvas
+ Horizontal offset for the image on the canvas.
- Vertical offset for the image on the canvas
+ Vertical offset for the image on the canvas.
- Position of the image drawn in the method
+ Position of the image drawn in the method.
- Indicates if the image is drawn in an Enabled state
+ Indicates if the image is drawn in an Enabled state.
- Drawing effect applied to the rendered image
+ Drawing effect applied to the rendered image.
- Drawing style applied to the rendered image
+ Drawing style applied to the rendered image.
- Indicates if the image contains a mask or source data
+ Indicates if the image contains a mask or source data.
- Draws an image stretched to the dimensions for the target rectangle
+ Draws an image stretched to the dimensions for the target rectangle.
@@ -951,20 +951,20 @@
- Canvas used for the drawing operation
+ Canvas used for the drawing operation.
- Ordinal position for the image drawn in the method
+ Ordinal position for the image drawn in the method.
- Rectangle coordinates used for the draw operation
+ Rectangle coordinates used for the draw operation.
- Indicates if the image is drawn using the enabled display state
+ Indicates if the image is drawn using the enabled display state.
- Draws the specified image with the given overlay
+ Draws the specified image with the given overlay.
DrawOverlay is an overloaded procedure used to draw the specified image with an overlay. An overlay is an masked image drawn transparently over another image. The overlay image is generally used to convey state or status information about the image it adorns. The overlay images are stored in the image list resolution just like the images they decorate.
@@ -1006,37 +1006,37 @@
- Canvas where the image and its overlay are rendered
+ Canvas where the image and its overlay are rendered.
- Horizontal offset for the overlay image
+ Horizontal offset for the overlay image.
- Vertical offset for the overlay image
+ Vertical offset for the overlay image.
- Ordinal position for the base image drawn in the method
+ Ordinal position for the base image drawn in the method.
- Position in the internal array with the index for an overlay image
+ Position in the internal array with the index for an overlay image.
- Indicates if the image is drawn in the enabled state
+ Indicates if the image is drawn in the enabled state.
- Drawing effect applied to the image and its overlay
+ Drawing effect applied to the image and its overlay.
- Drawing style applied to the image and its overlay
+ Drawing style applied to the image and its overlay.
- Image type for the requested image
+ Image type for the requested image.
- Image list which owns the resolution
+ Image list which owns the resolution.
ImageList is a read-only TCustomImageList property that represents the image list which owns the resolution. The value in the ImageList property is provided as an argument to the Create constructor.
@@ -1052,7 +1052,7 @@
- Width of the images stored in the resolution
+ Width of the images stored in the resolution.
@@ -1075,7 +1075,7 @@
- Height of the images stored in the resolution
+ Height of the images stored in the resolution.
Height is a read-only Integer property that indicates the height of images stored in the resolution. Height is used along with Width and Count to determine the internal storage allocated for 32-bit RGBA raw image data in the resolution.
@@ -1098,7 +1098,7 @@
- Number of images stored in the resolution
+ Number of images stored in the resolution.
@@ -1120,7 +1120,7 @@
- Indicates if the Resolution was auto-created at design-time
+ Indicates if the Resolution was auto-created at design-time.
@@ -1140,7 +1140,7 @@
- Reference to the widgetset image list using this resolution
+ Reference to the widgetset image list using this resolution.
@@ -1157,7 +1157,7 @@
- Implements a scaled image resolution (size)
+ Implements a scaled image resolution (size).
@@ -1189,29 +1189,29 @@
- Gets the value for the Count property
+ Gets the value for the Count property.
- Value for the Count property
+ Value for the Count property.
- Gets the value for the Size property
+ Gets the value for the Size property.
- Value for the Size property
+ Value for the Size property.
- Gets the value for the Valid property
+ Gets the value for the Valid property.
- Value for the the Valid property
+ Value for the the Valid property.
- Allocates a new record instance
+ Allocates a new record instance.
@@ -1229,58 +1229,58 @@
- Record instance allocated in the class function
+ Record instance allocated in the class function.
- Resolution used as the basis for the scaled images
+ Resolution used as the basis for the scaled images.
- Scale factor applied to the scaled images
+ Scale factor applied to the scaled images.
- Gets the scaled bitmap for the specified image
+ Gets the scaled bitmap for the specified image.
- Ordinal position for the bitmap requested in the method
+ Ordinal position for the bitmap requested in the method.
- Bitmap used to store the requested image
+ Bitmap used to store the requested image.
- Drawing effect applied to the image
+ Drawing effect applied to the image.
- Draws the scaled image to the specified canvas
+ Draws the scaled image to the specified canvas.
- Canvas used to render the image
+ Canvas used to render the image.
- Horizontal canvas offset for the rendered image
+ Horizontal canvas offset for the rendered image.
- Vertical canvas offset for the rendered image
+ Vertical canvas offset for the rendered image.
- Ordinal position for the image rendered in the method
+ Ordinal position for the image rendered in the method.
- Indicates if the image is drawn in the enabled state
+ Indicates if the image is drawn in the enabled state.
- Drawing effect applied to the rendered image
+ Drawing effect applied to the rendered image.
- Drawing style applied to the rendered image
+ Drawing style applied to the rendered image.
- Image type for the rendered image
+ Image type for the rendered image.
- Draws the scaled image sized to the target rectangle
+ Draws the scaled image sized to the target rectangle.
@@ -1296,7 +1296,7 @@
- Draws an image with an overlay at the specified canvas position
+ Draws an image with an overlay at the specified canvas position.
DrawOverlay is an overloaded method used to draw an image with an overlay at the given position on a canvas. The overloaded variants allow the enabled state, drawing effect, or drawing style for the image(s) to be specified.
@@ -1325,56 +1325,56 @@
- Canvas where the image and overlay are drawn
+ Canvas where the image and overlay are drawn.
- Horizontal coordinate on the canvas where the image is drawn
+ Horizontal coordinate on the canvas where the image is drawn.
- Vertical coordinate on the canvas where the image is drawn
+ Vertical coordinate on the canvas where the image is drawn.
- Ordinal position for the image drawn in the method
+ Ordinal position for the image drawn in the method.
- Position for the overlay image applied in the method
+ Position for the overlay image applied in the method.
- True when the image is drawn in the enabled state (default)
+ True when the image is drawn in the enabled state (default).
- TGraphicsDrawEffect value applied to the image
+ TGraphicsDrawEffect value applied to the image.
- TDrawingStyle value applied to the image
+ TDrawingStyle value applied to the image.
- Indicates if the content is the image or a mask
+ Indicates if the content is the image or a mask.
- Width of the images stored in the scaled image resolution
+ Width of the images stored in the scaled image resolution.
- Height of the images stored in the scaled image resolution
+ Height of the images stored in the scaled image resolution.
- Size of an image stored in the scaled resolution
+ Size of an image stored in the scaled resolution.
- Resolution used as the bases for scaled images
+ Resolution used as the bases for scaled images.
- Number of images stored in the scaled image list
+ Number of images stored in the scaled image list.
- Indicates if the source resolution is assigned for the class instance
+ Indicates if the source resolution is assigned for the class instance.
@@ -1385,12 +1385,12 @@
- Class type used to create instances of TCustomImageListResolution
+ Class type used to create instances of TCustomImageListResolution.
- Provides multiple image resolutions in TCustomImageList
+ Provides multiple image resolutions in TCustomImageList.
@@ -1422,7 +1422,7 @@
- Checks for an existing image resolution in the Items property
+ Checks for an existing image resolution in the Items property.
@@ -1437,17 +1437,17 @@
- True when the image resolution exists in the Items property
+ True when the image resolution exists in the Items property.
- Image width desired from the Items property
+ Image width desired from the Items property.
- Ordinal position for the image resolution in the Items property
+ Ordinal position for the image resolution in the Items property.
- Gets the value for the Image Lists property
+ Gets the value for the Image Lists property.
GetImageLists is an overloaded TCustomImageListResolution function. The variant with only an image width argument is used to get the value for the indexed ImageLists property. The other variant is called from the read access specifier.
@@ -1466,42 +1466,42 @@
- Value for the ImageLists property
+ Value for the ImageLists property.
- Image width desired in the image list
+ Image width desired in the image list.
- Indicates if a missing resolution can be scaled from another resolution
+ Indicates if a missing resolution can be scaled from another resolution.
- Indicates if the image resolution was auto-created at design-time
+ Indicates if the image resolution was auto-created at design-time.
- Gets the value for the indexed Items property
+ Gets the value for the indexed Items property.
- Value for the Items property
+ Value for the Items property.
- Ordinal position for the requested item
+ Ordinal position for the requested item.
- Gets the value for the Count property
+ Gets the value for the Count property.
- Value for the Count property
+ Value for the Count property.
- Finds the resolution that is the best candidate for scaling to the target width
+ Finds the resolution that is the best candidate for scaling to the target width.
@@ -1520,17 +1520,17 @@
- Ordinal position of the image resolution selected in the method
+ Ordinal position of the image resolution selected in the method.
- Image width desired in the resolution
+ Image width desired in the resolution.
- Ordinal position of an image resolution ignored in the method
+ Ordinal position of an image resolution ignored in the method.
- Constructor for the class instance
+ Constructor for the class instance.
Create is the constructor for the class instance. Create calls the inherited constructor. Create allocates resources needed for the internal object list which stores the image resolutions in the container. Create sets the value for the ImageList property to AImageList. Create stores the class type in AResolutionClass to an internal member used in the container.
@@ -1539,16 +1539,16 @@
- Image list that owns the container
+ Image list that owns the container.
- Class type used to create resolution class instances in the container
+ Class type used to create resolution class instances in the container.
- Destructor for the class instance
+ Destructor for the class instance.
Destroy is the destructor for the class instance. Destroy frees resources allocated to the internal list used to store image resolutions in the container. Destroy calls the inherited destructor prior to exiting from the method.
@@ -1559,7 +1559,7 @@
- Finds the image resolution with the best size for scaling to the target width
+ Finds the image resolution with the best size for scaling to the target width.
@@ -1583,15 +1583,15 @@
- Source image resolution to use for scaling to the target width
+ Source image resolution to use for scaling to the target width.
- Target width for the scaled image resolution
+ Target width for the scaled image resolution.
- Deletes the image resolution stored at the specified position in the container
+ Deletes the image resolution stored at the specified position in the container.
@@ -1609,12 +1609,12 @@
- Ordinal position of the image resolution to delete from the container
+ Ordinal position of the image resolution to delete from the container.
- Clears all image resolutions stored in the container
+ Clears all image resolutions stored in the container.
@@ -1631,7 +1631,7 @@
- Provides access to an image list which uses the specified image width
+ Provides access to an image list which uses the specified image width.
@@ -1651,15 +1651,15 @@
- Image list with images using the specified width
+ Image list with images using the specified width.
- Image width requested in the image list
+ Image width requested in the image list.
- Provides indexed access to existing image resolutions in the container
+ Provides indexed access to existing image resolutions in the container.
@@ -1681,15 +1681,15 @@
- The image resolution class instance at the specified position
+ The image resolution class instance at the specified position.
- Ordinal position for the requested image resolution
+ Ordinal position for the requested image resolution.
- Number of image resolutions stored in the container
+ Number of image resolutions stored in the container.
@@ -1704,7 +1704,7 @@
- Implements an enumerator for image resolutions in TCustomImageList
+ Implements an enumerator for image resolutions in TCustomImageList.
@@ -1732,15 +1732,15 @@
- Gets the value for the Current property
+ Gets the value for the Current property.
- Value for the Current property
+ Value for the Current property.
- Gets the enumerator for the class instance
+ Gets the enumerator for the class instance.
@@ -1761,12 +1761,12 @@
- Enumerator for the image resolutions in the image list
+ Enumerator for the image resolutions in the image list.
- Constructor for the class instance
+ Constructor for the class instance.
@@ -1796,15 +1796,15 @@
- Image list that owns the image resolutions in the enumerator
+ Image list that owns the image resolutions in the enumerator.
- Indicates if the enumerator navigates in descending order
+ Indicates if the enumerator navigates in descending order.
- Moves to the next image resolution for the enumerator
+ Moves to the next image resolution for the enumerator.
@@ -1823,11 +1823,11 @@
- True when another image resolution is available in the enumerator
+ True when another image resolution is available in the enumerator.
- The current image resolution for the enumerator
+ The current image resolution for the enumerator.
Current is a read-only TCustomImageListResolution property that represents the current image resolution for the enumerator. Current implements the property defined in the IEnumerator interface.
@@ -1847,7 +1847,7 @@
- Specifies an event handler used to get image widths for a display density (PPI)
+ Specifies an event handler used to get image widths for a display density (PPI).
@@ -1875,21 +1875,21 @@
- Image list generating the event notification
+ Image list generating the event notification.
- Initial image width used in the event handler
+ Initial image width used in the event handler.
- Display density (Pixels per Inch)
+ Display density (Pixels per Inch).
- Imaged width calculated in the event handler for the display density
+ Imaged width calculated in the event handler for the display density.
- The base class for TImageList
+ The base class for TImageList.
@@ -1965,7 +1965,7 @@
- Stores the TCustomImageListResolutions container used in the image list
+ Stores the TCustomImageListResolutions container used in the image list.
@@ -1979,19 +1979,19 @@
- List of TChangeLinks which are notified of changes
+ List of TChangeLinks which are notified of changes.
- Used to remember changes that occur while update notifications are locked (FUpdateCount > 0)
+ Used to remember changes that occur while update notifications are locked (FUpdateCount > 0).
- Counter for BeginUpdate/EndUpdate method calls
+ Counter for BeginUpdate/EndUpdate method calls.
@@ -2003,7 +2003,7 @@
- Notifies all subscribed objects of a change in the image list
+ Notifies all subscribed objects of a change in the image list.
@@ -2013,58 +2013,58 @@
- Sets the value for the BkColor property
+ Sets the value for the BkColor property.New value for the BkColor property.
- Sets the value for the DrawingStyle property
+ Sets the value for the DrawingStyle property.
- New value for the DrawingStyle property
+ New value for the DrawingStyle property.
- Sets the value for the Height property
+ Sets the value for the Height property.
- New value for the Height property
+ New value for the Height property.
- Sets the value for the Masked property
+ Sets the value for the Masked property.
- New value for the Masked property
+ New value for the Masked property.
- Sets the value for the ShareImages property
+ Sets the value for the ShareImages property.
- New value for the ShareImages property
+ New value for the ShareImages property.
- Sets the value for the Width property
+ Sets the value for the Width property.
- New value for the Width property
+ New value for the Width property.
- Gets the value for the Reference property
+ Gets the value for the Reference property.
- Value for the Reference property
+ Value for the Reference property.
- Gets an image list with images resized for the specified display density
-
+ Gets an image list with images resized for the specified display density.
+
GetResolutionForPPI is a TScaledImageListResolution function used to get an image list with images suitable for use at the specified display density (PPI).
@@ -2095,48 +2095,48 @@
- Image list with the resized images
+ Image list with the resized images.
- Image width for source images in the operation
+ Image width for source images in the operation.
- Display density (pixels per inch) for the resized images
+ Display density (pixels per inch) for the resized images.
- Scaling factor used for the target canvas
+ Scaling factor used for the target canvas.
- Gets the value for the WidthForPPI property
+ Gets the value for the WidthForPPI property.
- Image width derived for the specified display density
+ Image width derived for the specified display density.
- Initial image width used in the method
+ Initial image width used in the method.
- Display density (PPI) for the calculation
+ Display density (PPI) for the calculation.
- Gets the value for the HeightForPPI property
+ Gets the value for the HeightForPPI property.
- Image height derived for the specified display density
+ Image height derived for the specified display density.
- Image width used to derive the value
+ Image width used to derive the value.
- Display density (PPI) used in the calculation
+ Display density (PPI) used in the calculation.
- Gets the height for images using the specified width
-
+ Gets the height for images using the specified width.
+
GetHeightForWidth is an Integer function used to get the vertical size for images using the image width specified in AWidth. When AWidth contains a non-zero value, it is used to calculate the proportional image height using the values in the Height and Width properties.
@@ -2154,24 +2154,24 @@
- Image height calculated for the specified image width
+ Image height calculated for the specified image width.
- Image width used to derive the proportional image height
+ Image width used to derive the proportional image height.
- Gets the value for the Count property
+ Gets the value for the Count property.
- Value for the Count property
+ Value for the Count property.
- Gets the image size for the specified image width and display density (PPI)
-
+ Gets the image size for the specified image width and display density (PPI).
+
GetSizeForPPI is a TSize function used to get the image size for the specified image width and display density (PPI).
@@ -2199,19 +2199,19 @@
- The calculated size for images at the specified display density
+ The calculated size for images at the specified display density.
- Image width used as the basis for the calculated image size
+ Image width used as the basis for the calculated image size.
- Display density (PPI) for the calculated image size
+ Display density (PPI) for the calculated image size.
- Gets the index position for an icon with a suitable size
-
+ Gets the index position for an icon with a suitable size.
+
GetBestIconIndexForSize is an Integer function used to locate the index position for an icon with the size specified in AWidth. If an exact match is not found for the specified width, the next largest value in AIcon is used. If an icon size larger than AWidth is not found, the largest icon size available is used.
@@ -2232,39 +2232,39 @@
- Position of the candidate icon
+ Position of the candidate icon.
- Icon examined in the method
+ Icon examined in the method.
- Icon width requested in the method
+ Icon width requested in the method.
- Gets the value for the ResolutionByIndex property
+ Gets the value for the ResolutionByIndex property.
- Value for the ResolutionByIndex property
+ Value for the ResolutionByIndex property.
- Index position for the requested image resolution
+ Index position for the requested image resolution.
- Gets the value for the ResolutionCount property
+ Gets the value for the ResolutionCount property.
- Value for the ResolutionCount property
+ Value for the ResolutionCount property.
- Creates the default resolution (size) for the image list
+ Creates the default resolution (size) for the image list.
@@ -2300,7 +2300,7 @@
- Performs actions when the reference class for a resolution is freed
+ Performs actions when the reference class for a resolution is freed.
@@ -2318,15 +2318,15 @@
- Image width for the resolution being freed
+ Image width for the resolution being freed.
- Reference class for the resolution being freed
+ Reference class for the resolution being freed.
- Gets the value for the indexed Resolution property
+ Gets the value for the indexed Resolution property.
@@ -2347,15 +2347,15 @@
- Value for the Resolution property
+ Value for the Resolution property.
- Image width for the requested resolution
+ Image width for the requested resolution.
- Gets the class type used to create image resolutions in the list
+ Gets the class type used to create image resolutions in the list.
@@ -2373,12 +2373,12 @@
- Class type used to create resolutions in the image list
+ Class type used to create resolutions in the image list.
- Ensures that an Index position is valid for the bounds of the image list
+ Ensures that an Index position is valid for the bounds of the image list.
@@ -2399,15 +2399,15 @@
- Index position validated in the method
+ Index position validated in the method.
- True when the index position is used for insertion (default is False)
+ True when the index position is used for insertion (default is False).
- Performs the initial set up for the image list
+ Performs the initial set up for the image list.
@@ -2448,7 +2448,7 @@
- Defines properties used in the LCL component streaming mechanism
+ Defines properties used in the LCL component streaming mechanism.
@@ -2478,12 +2478,12 @@
- TFiler class used to read and write the component
+ TFiler class used to read and write the component.
- Sets the Width and Height for images in the default resolution
+ Sets the Width and Height for images in the default resolution.
@@ -2507,15 +2507,15 @@
- New value for the Width property
+ New value for the Width property.
- New value for the Height property
+ New value for the Height property.
- Clears images indexes assigned as overlay images in the image list
+ Clears images indexes assigned as overlay images in the image list.
@@ -2534,7 +2534,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -2561,12 +2561,12 @@
- Owner of the class instance
+ Owner of the class instance.
- Initializes the image list using the specified height and width
+ Initializes the image list using the specified height and width.
@@ -2587,14 +2587,14 @@
- The width of images in the default resolution
+ The width of images in the default resolution.
- The height of images in the default resolution
+ The height of images in the default resolution.
- Destructor for the class instance
+ Destructor for the class instance.
Destroy is the overridden destructor for the class instance. Destroy ensures that resources allocated to the internal TCustomImageListResolutions instance in the class are freed, and calls the inherited destructor. Destroy calls UnRegisterChanges to remove the TChangeLink items in the internal list of change links for the class, and frees resources allocated to the list.
@@ -2609,7 +2609,7 @@
- Scales an image and its optional mask to the specified target size
+ Scales an image and its optional mask to the specified target size.
@@ -2667,27 +2667,27 @@
- Bitmap with the image scaled in the method
+ Bitmap with the image scaled in the method.
- Optional mask that defines the transparent areas of the image
+ Optional mask that defines the transparent areas of the image.
- Target width for the scaled image
+ Target width for the scaled image.
- Target Height for the scaled image
+ Target Height for the scaled image.
- 32-bit RGBA raw image data for the scaled image
+ 32-bit RGBA raw image data for the scaled image.
- Defines the area in the original image scaled in the method
+ Defines the area in the original image scaled in the method.
- Assigns properties in an image list to another instance of the class
+ Assigns properties in an image list to another instance of the class.
@@ -2705,12 +2705,12 @@
- Image list to receive the values for the class instance
+ Image list to receive the values for the class instance.
- Stores properties from the specified image list to the current class instance
+ Stores properties from the specified image list to the current class instance.
@@ -2739,12 +2739,12 @@
- Image list with properties stored in the current class instance
+ Image list with properties stored in the current class instance.
- Writes image data for the default resolution to a stream
+ Writes image data for the default resolution to a stream.
@@ -2770,12 +2770,12 @@
- Stream used to store the image data
+ Stream used to store the image data.
- Reads image data for the default resolution from a stream
+ Reads image data for the default resolution from a stream.
@@ -2804,12 +2804,12 @@
- Stream with the image data read in the method
+ Stream with the image data read in the method.
- Writes the image content for multiple resolutions to the specified stream
+ Writes the image content for multiple resolutions to the specified stream.
@@ -2840,12 +2840,12 @@
- Stream where the content for the image resolutions is stored
+ Stream where the content for the image resolutions is stored.
- Reads the image content for multiple resolutions from a stream
+ Reads the image content for multiple resolutions from a stream.
@@ -2910,12 +2910,12 @@
- Stream with the image resolutions loaded in the method
+ Stream with the image resolutions loaded in the method.
- Compares the contents of the image lists
+ Compares the contents of the image lists.
@@ -2937,15 +2937,15 @@
- True when the image lists are equivalent
+ True when the image lists are equivalent.
- The image list object used for the comparison
+ The image list object used for the comparison.
- Starts an update to the image list, and blocks execution of the OnChange event
+ Starts an update to the image list, and blocks execution of the OnChange event.
@@ -2967,7 +2967,7 @@
- Finishes an update to the image list, and calls Change
+ Finishes an update to the image list, and calls Change.
@@ -2989,7 +2989,7 @@
- Adds an image to the list using its source data and optional mask
+ Adds an image to the list using its source data and optional mask.
@@ -3022,18 +3022,18 @@
- The index of the added image
+ The index of the added image.
- Bitmap image data added in the method
+ Bitmap image data added in the method.
- A bitmap mask which defines the transparent parts of Image
+ A bitmap mask which defines the transparent parts of Image.
- Adds images with varying sizes to the corresponding image resolution
+ Adds images with varying sizes to the corresponding image resolution.
@@ -3067,15 +3067,15 @@
- Ordinal position where images were stored in the various resolutions
+ Ordinal position where images were stored in the various resolutions.
- Array of images stored in the method
+ Array of images stored in the method.
- Adds images to the image list from image data stored as adjacent columns and rows
+ Adds images to the image list from image data stored as adjacent columns and rows.
@@ -3108,21 +3108,21 @@
- Ordinal position where the first image was stored in the image list
+ Ordinal position where the first image was stored in the image list.
- Image data stored as a row(s) and columns(s) of adjacent images
+ Image data stored as a row(s) and columns(s) of adjacent images.
- Number of adjacent horizontal images (columns)
+ Number of adjacent horizontal images (columns).
- Number of adjacent vertical images (rows)
+ Number of adjacent vertical images (rows).
- Adds a portion of an image to each of the resolutions in the image list
+ Adds a portion of an image to each of the resolutions in the image list.
@@ -3159,19 +3159,19 @@
- Ordinal position where the new image was stored in each of the image resolutions
+ Ordinal position where the new image was stored in each of the image resolutions.
- Image added in the method
+ Image added in the method.
- Area from the source image added in the method
+ Area from the source image added in the method.
- Adds an image centered in the height and width for the image resolutions
+ Adds an image centered in the height and width for the image resolutions.
@@ -3193,14 +3193,14 @@
- Ordinal position where the image was stored in the image resolutions
+ Ordinal position where the image was stored in the image resolutions.
- Image content added in the method
+ Image content added in the method.
- Adds an icon to the image list
+ Adds an icon to the image list.
AddIcon is used to add the TIcon instance in the Image parameter to the image list. AddIcon calls InsertIcon to store the Image at the ordinal position represented by the Count property. The return value contains the index of the newly added icon, or -1 if the icon could not be added to the list.
@@ -3215,15 +3215,15 @@
- The index of the added icon, -1 if unsuccessful
+ The index of the added icon, -1 if unsuccessful.
- The Icon to be added
+ The Icon to be added.
- Adds images from another image list to the current class instance
+ Adds images from another image list to the current class instance.
@@ -3245,13 +3245,13 @@
- The image list with the source images to add in the method
+ The image list with the source images to add in the method.
- Adds an image(s) to the list using the MaskColor for transparent pixels
+ Adds an image(s) to the list using the MaskColor for transparent pixels.
@@ -3264,18 +3264,18 @@
- The index of the first added image, -1 if unsuccessful
+ The index of the first added image, -1 if unsuccessful.
- The bitmap to be added to the image list
+ The bitmap to be added to the image list.
- The color used as the transparent pixels in the image(s)
+ The color used as the transparent pixels in the image(s).
- Gets a bitmap from a Lazarus resource and stores it in the image list
+ Gets a bitmap from a Lazarus resource and stores it in the image list.
@@ -3300,20 +3300,20 @@
- Position where the image was stored
+ Position where the image was stored.
- The name of the Lazarus resource
+ The name of the Lazarus resource.
- The mask color for transparent images. clNone for solid (opaque) images
+ The mask color for transparent images. clNone for solid (opaque) images.
- Adds a graphic from a resource with the specified resource name
+ Adds a graphic from a resource with the specified resource name.
@@ -3345,23 +3345,23 @@
- Ordinal position where the image was stored
+ Ordinal position where the image was stored.
- Handle for the resource
+ Handle for the resource.
- Name of the resource loaded in the method
+ Name of the resource loaded in the method.
- Color for transparent areas in the image, clNone for an opaque image
+ Color for transparent areas in the image, clNone for an opaque image.
- Sends change notifications when the image list is updated
+ Sends change notifications when the image list is updated.
@@ -3395,7 +3395,7 @@
- Removes all images store in the the image list
+ Removes all images store in the the image list.
@@ -3417,7 +3417,7 @@
- Deletes the image at the specified position from all image resolutions
+ Deletes the image at the specified position from all image resolutions.
@@ -3439,13 +3439,13 @@
- The index of the image deleted in the method, or -1 to delete all images
+ The index of the image deleted in the method, or -1 to delete all images.
- Renders an image to the specified canvas using a drawing style or effect
+ Renders an image to the specified canvas using a drawing style or effect.
@@ -3483,33 +3483,33 @@
- Canvas used for the draw operation
+ Canvas used for the draw operation.
- Horizontal offset on the canvas for the image
+ Horizontal offset on the canvas for the image.
- Vertical offset on the canvas for the image
+ Vertical offset on the canvas for the image.
- Position in the list for the image drawn to the canvas
+ Position in the list for the image drawn to the canvas.
- If False, the image is drawn disabled (dithered)
+ If False, the image is drawn disabled (dithered).
- Drawing effect applied to the rendered image
+ Drawing effect applied to the rendered image.
- Drawing style applied to the rendered image
+ Drawing style applied to the rendered image.
- Indicates if the image contains a mask or source data
+ Indicates if the image contains a mask or source data.
- Renders an image to a canvas scaled to a specified display density
+ Renders an image to a canvas scaled to a specified display density.
@@ -3548,54 +3548,54 @@
- Canvas where the image is rendered
+ Canvas where the image is rendered.
- Horizontal offset on the canvas where the image is drawn
+ Horizontal offset on the canvas where the image is drawn.
- Vertical offset on the canvas where the image is drawn
+ Vertical offset on the canvas where the image is drawn.
- Ordinal position for the image drawn in the method
+ Ordinal position for the image drawn in the method.
- Width of the image in the default resolution
+ Width of the image in the default resolution.
- Target display density (PPI) for the rendered image
+ Target display density (PPI) for the rendered image.
- Canvas scaling factor applied in the method
+ Canvas scaling factor applied in the method.
- Indicates if the image is rendered in the enabled state
+ Indicates if the image is rendered in the enabled state.
- Drawing effect applied to the rendered image
+ Drawing effect applied to the rendered image.
- Renders an image with an overlay to the specified canvas
-
+ Renders an image with an overlay to the specified canvas.
+
DrawOverlay is an overloaded procedure used to draw the specified image with an overlay. An overlay is an masked image drawn transparently over another image. The overlay image is generally used to convey state or status information about the image it adorns. The overlay images are stored in the image list (or the resolution) just like the images they decorate.
@@ -3641,36 +3641,36 @@
- Canvas where the image and its overlay are drawn
+ Canvas where the image and its overlay are drawn.
- Horizontal offset for the image on the canvas
+ Horizontal offset for the image on the canvas.
- Vertical offset for the image on the canvas
+ Vertical offset for the image on the canvas.
- Ordinal position for the image drawn in the method
+ Ordinal position for the image drawn in the method.
- Position for the overlay image drawn in the method
+ Position for the overlay image drawn in the method.
- Indicates if the image and overlay are drawn in the enabled state
+ Indicates if the image and overlay are drawn in the enabled state.
- Drawing effect applied to the image and the overlay
+ Drawing effect applied to the image and the overlay.
- Drawing style used for the image and overlay
+ Drawing style used for the image and overlay.
- Indicates the image type (masked or unmasked)
+ Indicates the image type (masked or unmasked).
- Gets image data at the specified position as a bitmap
+ Gets image data at the specified position as a bitmap.
@@ -3697,18 +3697,18 @@
- Ordinal position of the requested image
+ Ordinal position of the requested image.
- Bitmap used to store the image data
+ Bitmap used to store the image data.
- Drawing effect applied to the image
+ Drawing effect applied to the image.
- Gets a bitmap with all of the images in the default resolution
+ Gets a bitmap with all of the images in the default resolution.
@@ -3739,15 +3739,15 @@
- Bitmap where image data is stored
+ Bitmap where image data is stored.
- Drawing effect applied to the rendered images
+ Drawing effect applied to the rendered images.
- Gets the raw image data for all images in the default resolution
+ Gets the raw image data for all images in the default resolution.
@@ -3764,13 +3764,13 @@
- Image used to store the 32-bit raw image data for the default resolution
+ Image used to store the 32-bit raw image data for the default resolution.
- Returns the offset from the drawing position to the image origin
+ Returns the offset from the drawing position to the image origin.
@@ -3780,12 +3780,12 @@
- TPoint with the coordinates for the image hot spot
+ TPoint with the coordinates for the image hot spot.
- Inserts an image into each image resolution at the specified position
+ Inserts an image into each image resolution at the specified position.
@@ -3811,18 +3811,18 @@
- Ordinal position where the image is stored
+ Ordinal position where the image is stored.
- Bitmap image stored in the method
+ Bitmap image stored in the method.
- Transparency mask, Nil for opaque
+ Transparency mask, Nil for opaque.
- Inserts an Icon into each of the resolutions for the image list
+ Inserts an Icon into each of the resolutions for the image list.
@@ -3846,15 +3846,15 @@
- Position in the image list where the icon is inserted
+ Position in the image list where the icon is inserted.
- The Icon to insert into the image list
+ The Icon to insert into the image list.
- Inserts a transparent image into the image resolutions at the specified position
+ Inserts a transparent image into the image resolutions at the specified position.
@@ -3881,18 +3881,18 @@
- The index for the inserted image
+ The index for the inserted image.
- The bitmap to be inserted
+ The bitmap to be inserted.
- The color used transparent areas in the image
+ The color used transparent areas in the image.
- Moves an image from the position at CurIndex to NewIndex
+ Moves an image from the position at CurIndex to NewIndex.
@@ -3915,15 +3915,15 @@
- Current Index position for the image(s) to be moved
+ Current Index position for the image(s) to be moved.
- New index position for the image(s)
+ New index position for the image(s).
- Assigns an overlay index for the specified image in the image list
+ Assigns an overlay index for the specified image in the image list.
@@ -3957,17 +3957,17 @@
- Ordinal position of the image used as an overlay
+ Ordinal position of the image used as an overlay.
- Ordinal position in the internal array where the image index is stored
+ Ordinal position in the internal array where the image index is stored.
- Indicates if any images in the list have been used as an overlay image
+ Indicates if any images in the list have been used as an overlay image.
@@ -3990,7 +3990,7 @@
- Replaces an image at the specified position with the given bitmap
+ Replaces an image at the specified position with the given bitmap.
@@ -4017,18 +4017,18 @@
- Ordinal position for the image replace in the method
+ Ordinal position for the image replace in the method.
- The bitmap image stored in the method
+ The bitmap image stored in the method.
- The bitmap which defines the transparent parts of the image
+ The bitmap which defines the transparent parts of the image.
- Replace an image at the specified position with a slice from the specified image
+ Replace an image at the specified position with a slice from the specified image.
@@ -4057,21 +4057,21 @@
- Ordinal position for the image updated in the method
+ Ordinal position for the image updated in the method.
- Image with data stored in the method
+ Image with data stored in the method.
- Defines the coordinates for the image stored in the method
+ Defines the coordinates for the image stored in the method.
- Indicates if all image resolutions are updated in the method
+ Indicates if all image resolutions are updated in the method.
- Replaces the image at the specified position from image data stored as adjacent columns and rows
+ Replaces the image at the specified position from image data stored as adjacent columns and rows.
@@ -4099,21 +4099,21 @@
- Ordinal position for the image replaced in the method
+ Ordinal position for the image replaced in the method.
- Image width for the resolution updated in the method
+ Image width for the resolution updated in the method.
- Image data stored in the method
+ Image data stored in the method.
- Indicates if all image resolutions are updated in the method
+ Indicates if all image resolutions are updated in the method.
- Replaces the icon at the specified position in all resolutions for the image list
+ Replaces the icon at the specified position in all resolutions for the image list.
@@ -4136,15 +4136,15 @@
- Ordinal position for the icon replaced in the method
+ Ordinal position for the icon replaced in the method.
- Icon stored in the method
+ Icon stored in the method.
- Replaces the image at the specified position with a masked image
+ Replaces the image at the specified position with a masked image.
@@ -4176,18 +4176,18 @@
- Ordinal position for the image replaced in the method
+ Ordinal position for the image replaced in the method.
- Bitmap image stored in the method
+ Bitmap image stored in the method.
- The color used for transparent pixels the image
+ The color used for transparent pixels the image.
- Registers a TChangeLink object for notifications when the image list is changed
+ Registers a TChangeLink object for notifications when the image list is changed.
@@ -4214,12 +4214,12 @@
- Reference to the ChangeLink object
+ Reference to the ChangeLink object.
- Unregisters a ChangeLink object for change notifications
+ Unregisters a ChangeLink object for change notifications.
@@ -4238,12 +4238,12 @@
- Reference to the changelink object to remove
+ Reference to the changelink object to remove.
- Draws an image stretched to the dimensions for the target rectangle
+ Draws an image stretched to the dimensions for the target rectangle.
@@ -4271,21 +4271,21 @@
- Canvas used for the drawing operation
+ Canvas used for the drawing operation.
- Ordinal position for the image drawn in the method
+ Ordinal position for the image drawn in the method.
- Rectangle coordinates used for the draw operation
+ Rectangle coordinates used for the draw operation.
- Indicates if the image is drawn using the enabled display state
+ Indicates if the image is drawn using the enabled display state.
- Registers image resolutions (sizes) to use in the image list
+ Registers image resolutions (sizes) to use in the image list.
@@ -4304,12 +4304,12 @@
- Array of image resolutions to allocate in the image list
+ Array of image resolutions to allocate in the image list.
- Deletes the image resolution which uses the specified image width
+ Deletes the image resolution which uses the specified image width.
@@ -4324,12 +4324,12 @@
- Image width for the resolution removed in the method
+ Image width for the resolution removed in the method.
- Finds the image resolution which uses the specified image width
+ Finds the image resolution which uses the specified image width.
@@ -4355,18 +4355,18 @@
- True when an image resolution using the specified width is found
+ True when an image resolution using the specified width is found.
- Image width for the resolution requested in the method
+ Image width for the resolution requested in the method.
- Image resolution class located in the method
+ Image resolution class located in the method.
- Size used to increment the allocated data count
+ Size used to increment the allocated data count.
@@ -4383,7 +4383,7 @@
- Color used when blending (dithering) an image
+ Color used when blending (dithering) an image.
@@ -4406,7 +4406,7 @@
- Specifies the background color used for transparent parts of images
+ Specifies the background color used for transparent parts of images.
@@ -4428,7 +4428,7 @@
- Number of images stored in the default resolution for the image list
+ Number of images stored in the default resolution for the image list.
@@ -4443,7 +4443,7 @@
- The default drawing style for images in the image list
+ The default drawing style for images in the image list.
DrawingStyle is a TDrawingStyle property that indicates the default drawing style for images in the image list.
@@ -4455,7 +4455,7 @@
- Height of images in the default resolution for the image list
+ Height of images in the default resolution for the image list.
@@ -4474,7 +4474,7 @@
- Height for images at the specified display density
+ Height for images at the specified display density.
@@ -4496,15 +4496,15 @@
- Initial image width used to calculate the property value
+ Initial image width used to calculate the property value.
- Display density used to calculate the property value
+ Display density used to calculate the property value.
- Height used for images with the width specified width
+ Height used for images with the width specified width.
@@ -4528,12 +4528,12 @@
- Image width used as the basis for the calculated image height
+ Image width used as the basis for the calculated image height.
- Width of images in the default resolution for the image list
+ Width of images in the default resolution for the image list.
@@ -4552,7 +4552,7 @@
- Image width needed for the specified display density
+ Image width needed for the specified display density.
@@ -4607,15 +4607,15 @@
- Initial image width used for the derived value
+ Initial image width used for the derived value.
- Display density for the the derived image width
+ Display density for the the derived image width.
- Size used for images with the specified image width at the given display density
+ Size used for images with the specified image width at the given display density.
@@ -4641,15 +4641,15 @@
- Initial image width used to calculate the image size
+ Initial image width used to calculate the image size.
- Display density for the calculated image size
+ Display density for the calculated image size.
- Event handler signalled when the image list is changed
+ Event handler signalled when the image list is changed.
@@ -4666,7 +4666,7 @@
- Indicates if an image mask is used for images in the list
+ Indicates if an image mask is used for images in the list.
@@ -4684,7 +4684,7 @@
- Provides access to the reference class for the specified resolution
+ Provides access to the reference class for the specified resolution.
@@ -4702,7 +4702,7 @@
- Reference class using the specified image width and display density
+ Reference class using the specified image width and display density.
@@ -4724,15 +4724,15 @@
- Image width for the requested property value
+ Image width for the requested property value.
- Display density for the requested property value
+ Display density for the requested property value.
- Provides indexed access to an image resolution with the specified image width
+ Provides indexed access to an image resolution with the specified image width.
@@ -4761,12 +4761,12 @@
- Image width to locate in the resolutions for the image list
+ Image width to locate in the resolutions for the image list.
- Provides access to an image resolution by its ordinal position in the image list
+ Provides access to an image resolution by its ordinal position in the image list.
@@ -4795,12 +4795,12 @@
- Ordinal position for the requested image resolution
+ Ordinal position for the requested image resolution.
- Gets a scaled resolution with the specified width, display density, and scaling factor
+ Gets a scaled resolution with the specified width, display density, and scaling factor.
@@ -4826,18 +4826,18 @@
- Image width requested in the list of image resolutions
+ Image width requested in the list of image resolutions.
- Display density (PPI) for the scaled images
+ Display density (PPI) for the scaled images.
- Canvas scaling factor for the scaled images
+ Canvas scaling factor for the scaled images.
- Number of image resolutions available in the image list
+ Number of image resolutions available in the image list.
@@ -4859,7 +4859,7 @@
- Provides access to the image resolutions (or sizes) used in the image lists
+ Provides access to the image resolutions (or sizes) used in the image lists.
@@ -4872,12 +4872,12 @@
- Container for the images resolutions used in the class instance
+ Container for the images resolutions used in the class instance.
- Provides access to the descending enumerator for image resolutions in the list
+ Provides access to the descending enumerator for image resolutions in the list.
@@ -4890,12 +4890,12 @@
- Descending Resolutions enumerator for the class instance
+ Descending Resolutions enumerator for the class instance.
- Indicates if images are automatically scaled for missing resolutions
+ Indicates if images are automatically scaled for missing resolutions.
@@ -4923,7 +4923,7 @@
- True when the handle for the image list is shared
+ True when the handle for the image list is shared.
@@ -4938,7 +4938,7 @@
- Controls whether images are drawn with or without a mask
+ Controls whether images are drawn with or without a mask.
@@ -4957,7 +4957,7 @@
- Event handler used to override the scaled width for a display density
+ Event handler used to override the scaled width for a display density.
@@ -4978,14 +4978,14 @@
- Indicates the actions performed for resources with missing image sizes
+ Indicates the actions performed for resources with missing image sizes.
- Show an exception if any image resolution is missing for a resource
+ Show an exception if any image resolution is missing for a resource.
@@ -5001,37 +5001,37 @@
- Represents glyphs for buttons or icons used in LCL controls
+ Represents glyphs for buttons or icons used in LCL controls.
- Record representing glyph names
+ Record representing glyph names.
- Glyph name for the entry key
+ Glyph name for the entry key.
- Pointer to a TEntryKey type
+ Pointer to a TEntryKey type.
- Represents the key/value pair for glyph name and index position
+ Represents the key/value pair for glyph name and index position.
- Glyph name for the entry
+ Glyph name for the entry.
- Ordinal position for the image using the specified glyph name
+ Ordinal position for the image using the specified glyph name.
- Record used to track width and scale suffix values used for glyphs
+ Record used to track width and scale suffix values used for glyphs.
- Width of the glyphs for the resolution
+ Width of the glyphs for the resolution.
- Scaling level for glyphs using the resolution
+ Scaling level for glyphs using the resolution.
@@ -5040,59 +5040,59 @@
- Gets the position of the specified resource
+ Gets the position of the specified resource.
- Ordinal position for the specified resource name
+ Ordinal position for the specified resource name.
- Resource name to locate
+ Resource name to locate.
- Register a list of resolutions using the specified suffixes
+ Register a list of resolutions using the specified suffixes.
- List of image widths to register
+ List of image widths to register.
- List of suffixes used for images using the corresponding width
+ List of suffixes used for images using the corresponding width.
- Sets the suffix used for images at the 100% scaling level
+ Sets the suffix used for images at the 100% scaling level.
- Suffix for the scaling level
+ Suffix for the scaling level.
- Constructor for the class instance
+ Constructor for the class instance.
- Owner of the class instance
+ Owner of the class instance.
- Destructor for the class instance
+ Destructor for the class instance.
- Indicates the action performed for missing resources
+ Indicates the action performed for missing resources.
- Provides access to the TLCLGlyphs instance in the implementation
+ Provides access to the TLCLGlyphs instance in the implementation.
LCLGlyphs is a TLCLGlyphs function used to provide access to the TLCLGlyphs instance in the implementation section for the unit. LCLGlyphs ensures that the unit variable has been instantiated, and resolutions are registered using 16, 24, and 32 pixel sizes. The unit variable is freed in the finalization section for the unit.
@@ -5106,12 +5106,12 @@
- The TLCLGlyphs instance in the implementation
+ The TLCLGlyphs instance in the implementation.
- Gets a glyph with the specified name from the default resource file
+ Gets a glyph with the specified name from the default resource file.
@@ -5143,16 +5143,16 @@
- Bitmap for the requested resource name and scaling level
+ Bitmap for the requested resource name and scaling level.Resource name for the glyph
- Scaling level for the bitmap image
+ Scaling level for the bitmap image.
- Indicates if a missing resource can be ignored
+ Indicates if a missing resource can be ignored.
diff --git a/docs/xml/lcl/industrialbase.xml b/docs/xml/lcl/industrialbase.xml
index 2ad7c7db07..8d4d344164 100644
--- a/docs/xml/lcl/industrialbase.xml
+++ b/docs/xml/lcl/industrialbase.xml
@@ -9,7 +9,7 @@
-->
-Contains the base class for graphic controls that support anti-aliasing
+Contains the base class for graphic controls that support anti-aliasing.
industrialbase.pp contains the base class for graphic controls that support anti-aliasing.
diff --git a/docs/xml/lcl/inipropstorage.xml b/docs/xml/lcl/inipropstorage.xml
index 8ac0079143..f46f001c62 100644
--- a/docs/xml/lcl/inipropstorage.xml
+++ b/docs/xml/lcl/inipropstorage.xml
@@ -52,7 +52,7 @@
- Class of TCustomIniFile
+ Class of TCustomIniFile.
@@ -102,7 +102,7 @@
- Returns the class TIniFile
+ Returns the class TIniFile.
@@ -110,7 +110,7 @@
- The class TIniFile
+ The class TIniFile.
@@ -148,7 +148,7 @@
- Ask the underlying storage object for an entry
+ Ask the underlying storage object for an entry.
diff --git a/docs/xml/lcl/interfacebase.xml b/docs/xml/lcl/interfacebase.xml
index c88ea90172..9773aee647 100644
--- a/docs/xml/lcl/interfacebase.xml
+++ b/docs/xml/lcl/interfacebase.xml
@@ -8,8 +8,8 @@
-->
- Provides a platform-independent widgetset class and helper functions
-
+ Provides a platform-independent widgetset class and helper functions.
+
interfacebase.pp contains classes, types, and routines used to define a platform-independent widgetset class (TWidgetSet) and helper functions.
@@ -39,7 +39,7 @@
- Pointer to an event handler routine
+ Pointer to an event handler routine.
PEventHandler is an alias to the Pointer type. It is used in widgetset class to add or remove event handlers in the class instance.
@@ -49,7 +49,7 @@
- Pointer to a processs event handler routine
+ Pointer to a processs event handler routine.
@@ -60,7 +60,7 @@
- Pointer to a pipe event handler routine
+ Pointer to a pipe event handler routine.
PPipeEventHandler is an alias to the Pointer type. It is used in widgetset class to add or remove pipe event handlers in the class instance.
@@ -70,7 +70,7 @@
- Pointer to a socket event handler routine
+ Pointer to a socket event handler routine.
PSocketEventHandler is an alias to the Pointer type. It is used in widgetset class to add or socket event handlers in the class instance.
@@ -80,7 +80,7 @@
- Represents reasons that a child process was exited
+ Represents reasons that a child process was exited.
TChildExitReason is an enumerted type with values that represent reasons a child process was exited. TChildExitReason values are passed as a parameter to TChildExitEvent event handler routines, and used in the TAsyncProcess.HandleProcessTermination method which implements the event handler.
@@ -92,14 +92,14 @@
- Child process was exited normally
+ Child process was exited normally.
- Child process was terminated by a signal
+ Child process was terminated by a signal.
- Represents reasons that a pipe event was signalled
+ Represents reasons that a pipe event was signalled.
TPipeReason is an enumerated type with values that represent reasons a pipe event was signalled. TPipeReason values are passed as a parameter to TPipeEvent event handler routines used in WidgetSet classes.
@@ -110,17 +110,17 @@
- Data is available as input for the pipe
+ Data is available as input for the pipe.
- The pipe was closed or did not provide expected data
+ The pipe was closed or did not provide expected data.
- Data is available to be written as output
+ Data is available to be written as output.
- Set type used to store values from TPipeReason
+ Set type used to store values from TPipeReason.
@@ -129,7 +129,7 @@
- Represents the main processing loop in an application
+ Represents the main processing loop in an application.
TApplicationMainLoop is an object procedure type which represents the main processing loop for an application. TApplicationMainLoop is the type passed as an argument to the TWidgetSet.AppRun method.
@@ -142,7 +142,7 @@
- Specifies an event handler signalled for the handle in an interface object
+ Specifies an event handler signalled for the handle in an interface object.
@@ -161,14 +161,14 @@
- Integer pointer to the data for the event
+ Integer pointer to the data for the event.
- Flag value(s) for the event notification
+ Flag value(s) for the event notification.
- Specifies an event handler signalled when a child process is exited
+ Specifies an event handler signalled when a child process is exited.
TChildExitEvent is an object precedure type which specifies an event handler signalled when a child process is exited in a widgetset object. The parameters provide a pointer to the event data, the reason the process was exited, and a unique identifier for the event.
@@ -183,18 +183,18 @@
- Pointer to the data for the event
+ Pointer to the data for the event.
- Reason the process was exited
+ Reason the process was exited.
- Unique identifier for the event notification
+ Unique identifier for the event notification.
- Specifies an event handler signalled for a pipe handle in a widgetset object
+ Specifies an event handler signalled for a pipe handle in a widgetset object.
@@ -210,15 +210,15 @@
- Pointer to the data for the event notification
+ Pointer to the data for the event notification.
- Reason for the event notification
+ Reason for the event notification.
- Specifies an event handler signalled for a socket handle in a widgetset object
+ Specifies an event handler signalled for a socket handle in a widgetset object.
@@ -229,14 +229,14 @@
Cannot find a use case. Redeclared in widgetset classes.
- Pointer to the data for the event notification
+ Pointer to the data for the event notification.
- Flag values for the event notification
+ Flag values for the event notification.
- The type used for all LCL message handlers
+ The type used for all LCL message handlers.
@@ -245,7 +245,7 @@
- Represents capabilities used in the LCL
+ Represents capabilities used in the LCL.TLCLCapability is an enumerated type with values that represent capabilities used in the Lazarus Component Library (LCL). The enumeration values identify features or behaviors that may be implemented in a given widgetset object. The enumeration values can be passed to the TWidgetSet.GetLCLCapability method to determine whether the feature or behavior is implemented for the platform.
@@ -254,38 +254,38 @@
- Supports asynchronous processes
+ Supports asynchronous processes.
- Supports drawing outside of the OnPaint event for a control
+ Supports drawing outside of the OnPaint event for a control.
- When the main form is minimized, the application is minimized too
+ When the main form is minimized, the application is minimized too.
- Can change application title at run-time
+ Can change application title at run-time.
- Application has a special root window
+ Application has a special root window.
- Forms have an icon
+ Forms have an icon.
- Has native modal window support
+ Has native modal window support.
- Can drag-dock forms by clicking on the title bar
+ Can drag-dock forms by clicking on the title bar.
- amDontCare is the same as amOn for the widgetset
+ amDontCare is the same as amOn for the widgetset.
- Has support for the LM_HELP command
+ Has support for the LM_HELP command.
- Carbon does not receive LM_CLEAR, LM_CUT, LM_COPY, LM_PASTE reliably; this affects DB controls
+ Carbon does not receive LM_CLEAR, LM_CUT, LM_COPY, LM_PASTE reliably; this affects DB controls.
@@ -295,31 +295,31 @@
- Used by the LCL custom-drawn widgetset so that it can inject child controls in native ones
+ Used by the LCL custom-drawn widgetset so that it can inject child controls in native ones.
- Provides emulation of MDI commands for widgetsets which do not provide native MDI handling
+ Provides emulation of MDI commands for widgetsets which do not provide native MDI handling.
- Indicates accessibility is implemented; mostly for TCustomControl descendents as native widgetsets should have in-built accessibility
+ Indicates accessibility is implemented; mostly for TCustomControl descendents as native widgetsets should have in-built accessibility.
- Indicates that CreateBrushWithRadialGradient is supported to create a brush with a radial gradient pattern
+ Indicates that CreateBrushWithRadialGradient is supported to create a brush with a radial gradient pattern.
- Has the ability to pass mouse messages through a window (on win32 LM_NCHITTEST with HTTRANSPARENT result)
+ Has the ability to pass mouse messages through a window (on win32 LM_NCHITTEST with HTTRANSPARENT result).
- Has native TextHint support
+ Has native TextHint support.
@@ -328,17 +328,17 @@
- The system rendering engine might request a hidden control to be drawn (macOS 10.9 and later)
+ The system rendering engine might request a hidden control to be drawn (macOS 10.9 and later).
- Supports UI accelerator keys using & as a prefix for the accelerator character
+ Supports UI accelerator keys using & as a prefix for the accelerator character.
- Implements a standard dialog button
+ Implements a standard dialog button.
TDialogButton is a TCollectionItem descendant which implements a standard dialog button.
@@ -380,7 +380,7 @@
- Gets the value for the DisplayName property
+ Gets the value for the DisplayName property.
GetDisplayName is an overridden method in TDialogButton and uses the value in the Caption property as the name displayed for the collection item.
@@ -392,22 +392,22 @@
- Display name for the collection item
+ Display name for the collection item.
- Sets the value for the Caption property
+ Sets the value for the Caption property.
- New value for the properly
+ New value for the properly.
- Constructor for the class instance
+ Constructor for the class instance.
Create is the overridden constructor for the class instance, and calls the inherited method on entry.
@@ -425,11 +425,11 @@
- Collection which owns the collection item
+ Collection which owns the collection item.
- Value displayed on the button face
+ Value displayed on the button face.
Caption is a String property with the value displayed on the button face for the dialog button. The value in Caption is also used as the DisplayName for the collection item in the TDialogButtons collection.
@@ -442,7 +442,7 @@
- True if the button is the Cancel button
+ True if the button is the Cancel button.
Cancel is a Boolean property which indicates if the button is used as the Cancel button in the dialog.
@@ -465,7 +465,7 @@
- True if the button is the default button
+ True if the button is the default button.
Default is a Boolean property which indicates if the button is the default button for the dialog.
@@ -488,7 +488,7 @@
- The modal result value returned when the button is clicked
+ The modal result value returned when the button is clicked.
ModalResult is a LongInt property which contains the modal result value returned when the button is clicked in the dialog.
@@ -503,7 +503,7 @@
- Collection used to store TDialogButton instances
+ Collection used to store TDialogButton instances.
TDialogButtons is a TCollection descendant used to create and maintain the TDialogButton instances in the Items for the collection.
@@ -536,59 +536,59 @@
- Gets the value for the indexed Items property
+ Gets the value for the indexed Items property.
- Value for the indexed property
+ Value for the indexed property.
- Ordinal position for the collection item in the property
+ Ordinal position for the collection item in the property.
- Sets the value for the CancelButton property
+ Sets the value for the CancelButton property.
- New value for the property
+ New value for the property.
- Sets the value for the DefaultButton property
+ Sets the value for the DefaultButton property.
- New value for the property
+ New value for the property.
- Sets the value in the indexed Items property
+ Sets the value in the indexed Items property.
- Ordinal position for the new value in the Items property
+ Ordinal position for the new value in the Items property.
- New value stored in the indexed Items property
+ New value stored in the indexed Items property.
- Adds a new button instance to the Items in the collction
+ Adds a new button instance to the Items in the collction.
Add is an overridden TDialogButton function in TDialogButtons used to add a new button instance to the Items in the collection. Add ensures that the value returned from the inherited Add method is cast to the TDialogButton type used in Items.
@@ -599,11 +599,11 @@
- TDialogButton instance created and stored in the Items for the collection
+ TDialogButton instance created and stored in the Items for the collection.
- Finds the button associated with (one of) the given modal result values
+ Finds the button associated with (one of) the given modal result values.
FindButton is an overloaded TDialogButton function used to locate a dialog button in the collection which uses the specified modal result value. Overloaded variants are provided which accept one or multiple modal result values to locate in the method.
@@ -624,17 +624,17 @@
- Dialog button which uses the modal result value
+ Dialog button which uses the modal result value.
- The modal result value for the button located in the method
+ The modal result value for the button located in the method.
- List of modal result values to find in the collection
+ List of modal result values to find in the collection.
- The default button for the dialog
+ The default button for the dialog.
DefaultButton is a TDialogButton property which contains the dialog button which has its Default property set to True.
@@ -654,13 +654,13 @@
- The cancel button for the dialog
+ The cancel button for the dialog.
- Provides indexed access to the dialog buttons in the collection
+ Provides indexed access to the dialog buttons in the collection.
Items is an indexed TDialogButton property used to access to a dialog button by its ordinal position in the Items for the collection. Read and write access to the property value is re-implemented in TDialogButtons to use the TDialogButton type for the collection item in the property value.
@@ -688,11 +688,11 @@
- Ordinal position for the dialog button
+ Ordinal position for the dialog button.
- Type used for a timer callback procedure
+ Type used for a timer callback procedure.
@@ -700,7 +700,7 @@
- Provides an application helper class (platform and drawing interface)
+ Provides an application helper class (platform and drawing interface).
TWidgetSet is a TObject descendant which implements an application helper class that provides access to platform-specific operating system and drawing interfaces. A number of methods are declared as abstract virtual, and must be implemented in descendent classes. Other methods are declared as virtual to allow them to be overridden for a specific platform.
@@ -722,7 +722,7 @@
- Passes commandline arguments needed for the platform
+ Passes commandline arguments needed for the platform.
PassCmdLineOptions is a procedure used to pass commandline arguments used for the platfom-specific widgetset implementation. PassCmdLineOptions has an empty implementation in TWidgetSet, and must be overridden in a descendent class. It allows commandline arguments to be preprocessed or modified prior to starting an application.
@@ -740,7 +740,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
Create is the constructor for the class instance, and calls the inherited method on entry. Create calls CreateThemeServices to allocate the TThemeServices instance used in the ThemeServices property.
@@ -753,7 +753,7 @@
- Performs actions needed before freeing the class instance
+ Performs actions needed before freeing the class instance.
BeforeDestruction is an overridden method used to perform actions needed prior to freeing the class instance. BeforeDestruction ensures that resources allocated for the ThemeServices property are freed and nil'd. BeforeDestruction calls the inherited method prior to exit.
@@ -767,7 +767,7 @@
- Initializes the application for the platform, and returns Screen information
+ Initializes the application for the platform, and returns Screen information.
@@ -781,7 +781,7 @@
- Enters a state in which the application waits for system messages
+ Enters a state in which the application waits for system messages.
Called by Application.Run. Don't call this directly, the LCL will use it when adequate.
@@ -790,17 +790,17 @@
- Main processing loop for the application
+ Main processing loop for the application.
- Waits for arrival of a message
+ Waits for arrival of a message.Don't call this directly, the LCL will use it when adequate.
- Handles all pending messages
+ Handles all pending messages.
Called by Application.ProcessMessages. Don't call this directly, the LCL will use it when adequate.
@@ -810,7 +810,7 @@
- Terminates the application
+ Terminates the application.
Called by Application.Terminate. Don't call this directly, the LCL will use it when adequate.
@@ -820,7 +820,7 @@
- Minimizes the whole application to the taskbar
+ Minimizes the whole application to the taskbar.
Called by Application.Minimize. Don't call this directly, the LCL will use it when adequate.
@@ -832,7 +832,7 @@
- Restore application previously minimized to the taskbar
+ Restore application previously minimized to the taskbar.
Called by Application.Restore. Don't call this directly, the LCL will use it when adequate.
@@ -844,7 +844,7 @@
- Brings the entire application on top of all other non-topmost programs
+ Brings the entire application on top of all other non-topmost programs.
Called by Application.BringToFront. Don't call this directly, the LCL will use it when adequate.
@@ -854,7 +854,7 @@
- Sets the icon in the taskbar
+ Sets the icon in the taskbar.
Don't call this directly, the LCL will use it when adequate.
@@ -870,7 +870,7 @@
- Sets the title for an application
+ Sets the title for an application.
Don't call this directly, the LCL will use it when adequate.
@@ -883,7 +883,7 @@
- Changes the visibility of the application window
+ Changes the visibility of the application window.
Don't call this directly, the LCL will use it when adequate.
@@ -896,7 +896,7 @@
- Resets all StayOnTop windows to NoTopmost
+ Resets all StayOnTop windows to NoTopmost.
Don't call this directly, the LCL will use it when adequate.
@@ -905,14 +905,14 @@
- False on failure
+ False on failure.
- Sets all windows in the StayOnTop list to TopMost
+ Sets all windows in the StayOnTop list to TopMost.
@@ -924,25 +924,25 @@
- Shows or hides the taskbar icon for the MainForm
+ Shows or hides the taskbar icon for the MainForm.
- The visibility of the MainForm icon in the TaskBar
+ The visibility of the MainForm icon in the TaskBar.
- Returns the name for the widgetset used for the platform
+ Returns the name for the widgetset used for the platform.
- Widgetset in use for the platform
+ Widgetset in use for the platform.
- Checks whether the widgetset supports the specified LCL capability
+ Checks whether the widgetset supports the specified LCL capability.
GetLCLCapability is a PtrUInt function used to determine if a specific LCL capability is supported in the widgetset implementation.
@@ -982,14 +982,14 @@
- Can be either LCL_CAPABILITY_NO or LCL_CAPABILITY_YES
+ Can be either LCL_CAPABILITY_NO or LCL_CAPABILITY_YES.
- TLCLCapability enumeration value checked in the method
+ TLCLCapability enumeration value checked in the method.
- Gets the color for a pixel on the specified device context
+ Gets the color for a pixel on the specified device context.
Defined as an abstract virtual method. Must be implemented in a descendent class to use the image format and device context needed for the platform.
@@ -1011,7 +1011,7 @@
- Sets the color for a pixel on the specified device context
+ Sets the color for a pixel on the specified device context.
Defined as an abstract virtual method. Must be implemented in a descendent class to use the image format and device context needed for the platform.
@@ -1033,7 +1033,7 @@
- Redraws the device context for the specified canvas handle
+ Redraws the device context for the specified canvas handle.
Used in the implementation of the TCanvas.RealizeAutoRedraw method called when its AutoRedraw property is changed.
@@ -1045,11 +1045,11 @@
- Canvas handle with the device context for the redraw operation
+ Canvas handle with the device context for the redraw operation.
- Enables or disables anti-aliasing for the specified device context
+ Enables or disables anti-aliasing for the specified device context.
Called from the RealizeAntiAliasing method in TCanvas when its handle or AntialiasingMode properrty is changed.
@@ -1058,10 +1058,10 @@
- Canvas handle with the device context updated in the method
+ Canvas handle with the device context updated in the method.
- True to enable anti-aliasing for the device context
+ True to enable anti-aliasing for the device context.
@@ -1074,55 +1074,55 @@
- Initializes a font object to a (predefined) stock font
+ Initializes a font object to a (predefined) stock font.
- False on failure
+ False on failure.
- The font to initialize
+ The font to initialize.
- The predefined font to use for the initialization
+ The predefined font to use for the initialization.
- Checks whether the widgetset uses the key to show help
+ Checks whether the widgetset uses the key to show help.
- True when this is a Help key
+ True when this is a Help key.
- The virtual key
+ The virtual key.
- The modifier key state
+ The modifier key state.
- Creates a timer with the given callback method
+ Creates a timer with the given callback method.
- The timer ID, zero on failure
+ The timer ID, zero on failure.
- The time interval
+ The time interval.
- The callback method
+ The callback method.
- Destroys a timer
+ Destroys a timer.
Declared as an abstract virtual method in TWidgetSet. Must be implemented in a descendent class to use the platform-specific mechanism(s) required for the implementation.
@@ -1133,14 +1133,14 @@
- False on failure
+ False on failure.
- The timer ID
+ The timer ID.
- Native handle for a TApplication instance
+ Native handle for a TApplication instance.
AppHandle is a platform-specific property. The meaning and use for the handle changes from widgetset to widgetset.
@@ -1151,7 +1151,7 @@
- Use Arc to draw an elliptically curved line with the current Pen
+ Use Arc to draw an elliptically curved line with the current Pen.
The arc is part of the ellipse inscribed in the bounding rectangle.
@@ -1163,7 +1163,7 @@
- False on failure
+ False on failure.
@@ -1181,14 +1181,14 @@
- base angle
+ base angle.
- angle length
+ angle length.
- Use AngleChord to draw a filled Chord shape on a canvas
+ Use AngleChord to draw a filled Chord shape on a canvas.
The chord is outlined with the current pen, and filled with the current brush.
@@ -1200,7 +1200,7 @@
- False on failure
+ False on failure.
@@ -1218,14 +1218,14 @@
- Base angle
+ Base angle.
- Angle length
+ Angle length.
- Start painting in a window
+ Start painting in a window.
This function is for use in WM_PAINT handlers only. Not all platforms allow for painting outside WM_PAINT messages.
@@ -1237,18 +1237,18 @@
- A Device Context for the window, Nil on failure
+ A Device Context for the window, Nil on failure.
- The window Handle
+ The window Handle.
- Will receive painting information
+ Will receive painting information.
- Copies part of a source DC into a destination DC, using the specified raster operation
+ Copies part of a source DC into a destination DC, using the specified raster operation.
@@ -1296,59 +1296,59 @@
- False on failure
+ False on failure.
- The destination Device Context
+ The destination Device Context.
- The origin in the destination DC
+ The origin in the destination DC.
- The origin in the destination DC
+ The origin in the destination DC.
- The image size
+ The image size.
- The image size
+ The image size.
- The source Device Context
+ The source Device Context.
- The origin in the source DC
+ The origin in the source DC.
- The origin in the source DC
+ The origin in the source DC.
- The raster operation
+ The raster operation.
- Calls the next procedure in the hook chain
+ Calls the next procedure in the hook chain.
- Depends on the Hook type
+ Depends on the Hook type.
- Handle of the current hook
+ Handle of the current hook.
- The Hook code (message ID)
+ The Hook code (message ID).
- Message parameter
+ Message parameter.
- Message parameter
+ Message parameter.
- Calls another Window procedure, to handle a message
+ Calls another Window procedure, to handle a message.
@@ -1372,22 +1372,22 @@
- Converts (relative) Client coordinates into absolute Screen coordinates
+ Converts (relative) Client coordinates into absolute Screen coordinates.
- False on failure
+ False on failure.
- The window with the client area
+ The window with the client area.
- The point to convert
+ The point to convert.
- Combines two regions
+ Combines two regions.
The Destination must already be initialized. The Return value is the Region type for the Destination, or ERROR (0).
@@ -1416,30 +1416,30 @@
- The Destination's Region type, or ERROR (0)
+ The Destination's Region type, or ERROR (0).The Handle of the destination region. This region must already exist!
- The handle of a region to combine
+ The handle of a region to combine.
- The handle of a region to combine
+ The handle of a region to combine.
- How the regions are combined
+ How the regions are combined.
- Creates a bitmap for the widgetset
+ Creates a bitmap for the widgetset.
Creates a bitmap with the specified width, height, and color format (color planes and bits per pixel).
- The bitmap Handle, zero on failure
+ The bitmap Handle, zero on failure.
@@ -1448,13 +1448,13 @@
- The number of color planes
+ The number of color planes.
- The number of color bits per pixel and plane
+ The number of color bits per pixel and plane.
- Pointer to array containing color data
+ Pointer to array containing color data.
@@ -1465,25 +1465,25 @@
- The brush Handle, zero on failure
+ The brush Handle, zero on failure.
- Description of the brush
+ Description of the brush.
- Creates a new shape for the system caret and assigns ownership of the caret to the specified window
+ Creates a new shape for the system caret and assigns ownership of the caret to the specified window.
- False on failure
+ False on failure.
- The window that owns the caret
+ The window that owns the caret.
- Bitmap Handle, or zero for a solid (black) caret, 1 for a grey caret
+ Bitmap Handle, or zero for a solid (black) caret, 1 for a grey caret.
@@ -1493,15 +1493,15 @@
- Creates a bitmap that is compatible with the given DC
+ Creates a bitmap that is compatible with the given DC.
- The bitmap handle, zero on failure
+ The bitmap handle, zero on failure.
- The Device Context for the bitmap
+ The Device Context for the bitmap.
@@ -1511,30 +1511,30 @@
- Creates a memory Device Context, compatible with the device for the given DC
+ Creates a memory Device Context, compatible with the device for the given DC.
- The memory DC, zero on failure
+ The memory DC, zero on failure.
- The device DC
+ The device DC.
- Creates a Device Dependent Bitmap (DDB) from a Device Independent Bitmap (DIB)
+ Creates a Device Dependent Bitmap (DDB) from a Device Independent Bitmap (DIB).
- The bitmap handle, zero on failure
+ The bitmap handle, zero on failure.
- The context for the DDB
+ The context for the DDB.
@@ -1543,50 +1543,50 @@
- An array containing the bitmap pixels
+ An array containing the bitmap pixels.
- CBM_INIT when InitBits contains valid data, else zero
+ CBM_INIT when InitBits contains valid data, else zero.
- Creates a bitmap into which the application can write
+ Creates a bitmap into which the application can write.
- The bitmap Handle, zero on failure
+ The bitmap Handle, zero on failure.
- The DC for the bitmap
+ The DC for the bitmap.
- Contains all information about the bitmap, except the pixels
+ Contains all information about the bitmap, except the pixels.
- The type of the bitmap colors, e.g. DIB_RGB_COLORS
+ The type of the bitmap colors, e.g. DIB_RGB_COLORS.
- Pointer to the bitmap pixels
+ Pointer to the bitmap pixels.
- Zero or the Handle of a file-mapping object, from which the bitmap is initialized (needs CreateFileMapping)
+ Zero or the Handle of a file-mapping object, from which the bitmap is initialized (needs CreateFileMapping).
- The offset to the bitmap bits in the file-mapping object
+ The offset to the bitmap bits in the file-mapping object.
- Creates an elliptic region, bounded by the given rectangle
+ Creates an elliptic region, bounded by the given rectangle.
- The region Handle, zero on failure
+ The region Handle, zero on failure.
@@ -1602,17 +1602,17 @@
- Creates a logical font, selectable into any DC
+ Creates a logical font, selectable into any DC.
- The font handle, zero on failure
+ The font handle, zero on failure.
- The font description
+ The font description.
@@ -1623,41 +1623,41 @@
- The font handle, zero on failure
+ The font handle, zero on failure.
- The font description
+ The font description.
- The font name, can be longer than 32 characters
+ The font name, can be longer than 32 characters.
- Creates an icon or cursor
+ Creates an icon or cursor.
- The Handle, zero on failure
+ The Handle, zero on failure.
- Creates a logical palette, selectable into any DC
+ Creates a logical palette, selectable into any DC.
- The palette Handle, zero on failure
+ The palette Handle, zero on failure.
- Creates a logical brush, selectable into any DC
+ Creates a logical brush, selectable into any DC.
The bitmap pattern is repeated for areas of larger width or height, it should allow for smooth transitions.
@@ -1669,26 +1669,26 @@
- The brush handle, zero on failure
+ The brush handle, zero on failure.
- The bitmap to use for the brush
+ The bitmap to use for the brush.
- Creates a logical Pen, selectable into any DC
+ Creates a logical Pen, selectable into any DC.
- The pen Handle, zero on failure
+ The pen Handle, zero on failure.
- Creates a polygonal region
+ Creates a polygonal region.
The Points parameter is an array of points that give the vertices of the polygon. The connections between two points can cross others.
@@ -1703,25 +1703,25 @@
- The region Handle, zero on failure
+ The region Handle, zero on failure.
- The array of points
+ The array of points.
- The number of points in Points
+ The number of points in Points.
- Can be ALTERNATE or WINDING
+ Can be ALTERNATE or WINDING.
- Creates a rectangular region
+ Creates a rectangular region.
- The region handle, zero on failure
+ The region handle, zero on failure.
@@ -1737,12 +1737,12 @@
- Creates a rectangular region with rounded corners
+ Creates a rectangular region with rounded corners.
- The region Handle, zero on failure
+ The region Handle, zero on failure.
@@ -1757,14 +1757,14 @@
- The extent of the ellipse, used for the rounded corners
+ The extent of the ellipse, used for the rounded corners.
- The extent of the ellipse, used for the rounded corners
+ The extent of the ellipse, used for the rounded corners.
- Deletes an unowned critical section
+ Deletes an unowned critical section.
Results are unpredictable when the section is owned, i.e. has been entered but not yet left.
@@ -1774,18 +1774,18 @@
- The critical section object
+ The critical section object.
- Deletes a Device Context created using CreateDC
+ Deletes a Device Context created using CreateDC.
- False on failure
+ False on failure.
@@ -1799,68 +1799,68 @@
- False on failure
+ False on failure.
- Destroys the caret but doesn't free the bitmap
+ Destroys the caret but doesn't free the bitmap.
- False on failure
+ False on failure.
- Handle of the window with the caret
+ Handle of the window with the caret.
- Destroys a mouse cursor
+ Destroys a mouse cursor.
- False on failure
+ False on failure.
- The cursor Handle
+ The cursor Handle.
- Destroys an icon
+ Destroys an icon.
- False on failure
+ False on failure.
- Converts an array of Device Points (coordinates) into Logical Points
+ Converts an array of Device Points (coordinates) into Logical Points.
- False on failure
+ False on failure.
- The device context, containing the coordinate mapping information
+ The device context, containing the coordinate mapping information.
- An array of points
+ An array of points.
- The number of points to convert
+ The number of points to convert.
- Draws a window frame control, of the specified type and style
+ Draws a window frame control, of the specified type and style.
A window frame includes these components (uType):
@@ -1881,23 +1881,23 @@
- False on failure
+ False on failure.
- The window frame device context
+ The window frame device context.
- The control type, e.g. DFC_CAPTION
+ The control type, e.g. DFC_CAPTION.
- The control state, e.g. DFCS_CAPTIONCLOSE (close button)
+ The control state, e.g. DFCS_CAPTIONCLOSE (close button).
- Shows or hides a focus rectangle
+ Shows or hides a focus rectangle.
This function is intended to temporarily outline part of a canvas, e.g. a rectangular selection following mouse moves (rubber banding box, DockRect).
@@ -1915,38 +1915,38 @@
- False on failure
+ False on failure.
- Almost a screen DC
+ Almost a screen DC.
- Draws one or more edges of a rectangle
+ Draws one or more edges of a rectangle.
- False on failure
+ False on failure.
- Device context for the drawing operation
+ Device context for the drawing operation.
- Rectangle with the bounds for the drawing operation
+ Rectangle with the bounds for the drawing operation.
- A combination of edge styles (inner/outer, raised/sunken)
+ A combination of edge styles (inner/outer, raised/sunken).
- Indicates e.g. the edges to paint (BF_LEFT)
+ Indicates e.g. the edges to paint (BF_LEFT).
- Draws formatted text within a rectangle
+ Draws formatted text within a rectangle.
Several formatting options are available for use in the Flags argument. The value correspond to the DrawText constants defined in the lcltype.pp unit.
@@ -1963,39 +1963,39 @@
- Device context for the text rendering operation
+ Device context for the text rendering operation.
- The text (should be zero terminated)
+ The text (should be zero terminated).
- The number of (Wide)Chars in the text
+ The number of (Wide)Chars in the text.
- The bounding (clipping) rectangle
+ The bounding (clipping) rectangle.
- Formatting flags apllied in the method
+ Formatting flags apllied in the method.
- Enables or disables the arrows in a scrollbar control, or the scrollbars in a window
+ Enables or disables the arrows in a scrollbar control, or the scrollbars in a window.
- False when nothing was changed
+ False when nothing was changed.
- The window or control handle
+ The window or control handle.
- The scrollbar type (SB_CTL, SB_HORZ...)
+ The scrollbar type (SB_CTL, SB_HORZ...).
- The affected buttons
+ The affected buttons.
@@ -2006,34 +2006,34 @@
- True when the window was disabled before
+ True when the window was disabled before.
- Handle for the window
+ Handle for the window.
- True to enable the window, False to disable the window
+ True to enable the window, False to disable the window.
- Ends a paint operation in a window, started with BeginPaint
+ Ends a paint operation in a window, started with BeginPaint.
- Almost nonzero
+ Almost nonzero.
- The window to paint
+ The window to paint.
- Painting information
+ Painting information.
- Enters a critical section
+ Enters a critical section.
The call returns only when the calling thread has obtained ownership of the critical
section. See TryEnterCriticalSection for testing the ownership of the critical section.
@@ -2043,16 +2043,16 @@
- The critical section object
+ The critical section object.
- Calls a callback function for every available display monitor
+ Calls a callback function for every available display monitor.
- False on failure
+ False on failure.
@@ -2061,33 +2061,33 @@
- The callback function
+ The callback function.
- Data passed to the callback function
+ Data passed to the callback function.
- Invokes a callback function for every font available on a specified device
+ Invokes a callback function for every font available on a specified device.
- The last value returned by the callback function
+ The last value returned by the callback function.
- The device context
+ The device context.
- The font family name, empty for all families
+ The font family name, empty for all families.
- The callback function
+ The callback function.
- Data passed to the callback function
+ Data passed to the callback function.
@@ -2098,26 +2098,26 @@
- The last value returned by the callback function
+ The last value returned by the callback function.
- The device context
+ The device context.
- Description of the desired fonts
+ Description of the desired fonts.
- The callback function
+ The callback function.
- Data passed to the callback function
+ Data passed to the callback function.
- Draws a filled circle or ellipse, bounded by a rectangle
+ Draws a filled circle or ellipse, bounded by a rectangle.
The ellipse is outlined with the current pen, and filled with the current brush.
@@ -2126,7 +2126,7 @@
- False on failure
+ False on failure.
@@ -2152,7 +2152,7 @@
- The type of the new clipping region, Error (0) on failure
+ The type of the new clipping region, Error (0) on failure.
@@ -2171,31 +2171,31 @@
- Creates a logical pen, selectable into any DC
+ Creates a logical pen, selectable into any DC.
- The pen handle, zero on failure
+ The pen handle, zero on failure.
- A collection of style options
+ A collection of style options.
- The pen width
+ The pen width.
- The brush description
+ The brush description.
- The number of sections for a dashed pen
+ The number of sections for a dashed pen.
- Array of the section lengths in a dashed pen
+ Array of the section lengths in a dashed pen.
- Draws a string without formatting (single line)
+ Draws a string without formatting (single line).
The string is drawn with the current font and colors. The following Options are supported:
@@ -2210,35 +2210,35 @@
- False on failure
+ False on failure.
- The Device Context
+ The Device Context.
- The reference point, used to position the text
+ The reference point, used to position the text.
- The reference point, used to position the text
+ The reference point, used to position the text.
- Output options
+ Output options.
- The bounding rectangle
+ The bounding rectangle.
- The text
+ The text.
- The number of (Wide)Chars in the string
+ The number of (Wide)Chars in the string.
- Pointer to an array of inter-character spacing values, can be Nil
+ Pointer to an array of inter-character spacing values, can be Nil.
- Combines the passed Region with the current clipping region
+ Combines the passed Region with the current clipping region.
The Mode can be one of:
@@ -2264,25 +2264,25 @@
- The type of the resulting clipping region
+ The type of the resulting clipping region.
- The region to combine with
+ The region to combine with.
- How the regions are combined
+ How the regions are combined.
- Fills a rectangle using the specified brush
+ Fills a rectangle using the specified brush.
- False on failure
+ False on failure.
@@ -2295,7 +2295,7 @@
- Fills a region using the specified brush
+ Fills a region using the specified brush.
@@ -2313,7 +2313,7 @@
- Fills an area of the display surface with the current brush
+ Fills an area of the display surface with the current brush.
FillStyle specifies the area:
@@ -2333,45 +2333,45 @@
- False on failure
+ False on failure.
- The device context
+ The device context.
- The starting point
+ The starting point.
- The starting point
+ The starting point.
- The area or boundary color, depending on FillStyle
+ The area or boundary color, depending on FillStyle.
- fsBorder or fsSurface
+ fsBorder or fsSurface.
- The brush used to fill the area
+ The brush used to fill the area.
- Draws a border around a rectangle
+ Draws a border around a rectangle.
The boundary is one logical unit wide, painted using the given brush.
- Zero on failure
+ Zero on failure.
- The rectangle to outline
+ The rectangle to outline.
- The brush for drawing the border
+ The brush for drawing the border.
@@ -2381,62 +2381,62 @@
- The window handle, zero on failure
+ The window handle, zero on failure.
- Fills a buffer with the bitmap bits
+ Fills a buffer with the bitmap bits.
- The number of bytes copied, zero on failure
+ The number of bytes copied, zero on failure.
- The (device dependent) bitmap handle
+ The (device dependent) bitmap handle.
- The byte size of the buffer
+ The byte size of the buffer.
- Pointer to the output buffer
+ Pointer to the output buffer.
- Returns the background color of a device context
+ Returns the background color of a device context.
- The background color, CLR_INVALID on failure
+ The background color, CLR_INVALID on failure.
- Returns the window that captures mouse messages
+ Returns the window that captures mouse messages.
- The window handle, zero if no window of the thread captures mouse messages
+ The window handle, zero if no window of the thread captures mouse messages.
- Returns the caret position, in client coordinates
+ Returns the caret position, in client coordinates.
- False on failure
+ False on failure.
- Receives the coordinates
+ Receives the coordinates.
- Returns the client rectangle of a window
+ Returns the client rectangle of a window.
The client rectangle is the size of the inner area of a control, where e.g. the child controls are visible. Left and Top are always 0.
@@ -2448,13 +2448,13 @@
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- Receives the client coordinates
+ Receives the client coordinates.
@@ -2465,96 +2465,96 @@
- The region kind
+ The region kind.
- The device context
+ The device context.
- Receives the coordinates
+ Receives the coordinates.
- Returns the clipping region of a device context
+ Returns the clipping region of a device context.
- Zero on failure
+ Zero on failure.
- The device context
+ The device context.
- The handle of the clipping region
+ The handle of the clipping region.
- Returns the currently selected object in a device context
+ Returns the currently selected object in a device context.
- The object handle, zero on failure
+ The object handle, zero on failure.
- The device context
+ The device context.
- The type of the selected object, e.g. OBJ_BRUSH
+ The type of the selected object, e.g. OBJ_BRUSH.
- Gets the mouse cursor position, in screen coordinates
+ Gets the mouse cursor position, in screen coordinates.
- False on failure
+ False on failure.
- Receives the mouse coordinates
+ Receives the mouse coordinates.
- Returns the ABC widths of a range of character codes
+ Returns the ABC widths of a range of character codes.
_ABC
- False on failure
+ False on failure.
- The device context
+ The device context.
- The first character code
+ The first character code.
- The last character code
+ The last character code.
- Array of ABC records, receiving the information
+ Array of ABC records, receiving the information.
- Returns the handle for the Device Context (DC) in the client area of a window
+ Returns the handle for the Device Context (DC) in the client area of a window.
- The DC handle, zero on failure
+ The DC handle, zero on failure.
- The window handle
+ The window handle.
- Returns various device specific information
+ Returns various device specific information.
The following information can be retrieved:
@@ -2587,17 +2587,17 @@
- The requested value
+ The requested value.
- The device context
+ The device context.
- The value type, e.g. HORZRES
+ The value type, e.g. HORZRES.
- Fills a buffer with bitmap color bits
+ Fills a buffer with bitmap color bits.
The bitmap must be a compatible (device dependent) bitmap, for the given device context. It should not be selected into any DC.
@@ -2615,32 +2615,32 @@
- The number of returned scanlines, zero on failure
+ The number of returned scanlines, zero on failure.
- The device context
+ The device context.
- The bitmap handle
+ The bitmap handle.
- The first scanline to retrieve
+ The first scanline to retrieve.
- The number of scanlines to retrieve
+ The number of scanlines to retrieve.
- Pointer to the color bits array, or Nil to get the BitmapInfo
+ Pointer to the color bits array, or Nil to get the BitmapInfo.
- Contains or receives the BitmapInfo
+ Contains or receives the BitmapInfo.
- The color format, e.g. DIB_RGB_COLORS
+ The color format, e.g. DIB_RGB_COLORS.
- Returns the double-click time, in milliseconds
+ Returns the double-click time, in milliseconds.
@@ -2655,11 +2655,11 @@
- The window handle, zero if no window has the focus
+ The window handle, zero if no window has the focus.
- Returns language information about the currently selected font
+ Returns language information about the currently selected font.
The following flags are supported:
@@ -2670,23 +2670,23 @@
- Font flags, zero for Latin font families
+ Font flags, zero for Latin font families.
- Returns the window that the user is currently working with, session wide
+ Returns the window that the user is currently working with, session wide.
- The window handle, zero when no such window exists
+ The window handle, zero when no such window exists.
- Returns information about an Icon or Cursor
+ Returns information about an Icon or Cursor.
@@ -2694,14 +2694,14 @@
- The item handle
+ The item handle.
- Receives the information
+ Receives the information.
- The status of a virtual key
+ The status of a virtual key.
The result reflects the message processing state, at the time of the last seen key message.
@@ -2719,14 +2719,14 @@
- The key state flags
+ The key state flags.
- The virtual key code
+ The virtual key code.
- Returns the mapping mode of a device context
+ Returns the mapping mode of a device context.
@@ -2734,94 +2734,94 @@
The
- mapping mode, zero on failure
+ mapping mode, zero on failure.
- The device context
+ The device context.
- Returns information about a display monitor
+ Returns information about a display monitor.
- False on failure
+ False on failure.
- The monitor handle
+ The monitor handle.
- Receives the information
+ Receives the information.
- Returns information about a graphics object
+ Returns information about a graphics object.The returned information depends on the object type
- The number of bytes written into the buffer
+ The number of bytes written into the buffer.
- The Handle of the object
+ The Handle of the object.
- The byte count of the buffer
+ The byte count of the buffer.
- Receives the information. Nil means to return the required buffer size
+ Receives the information. Nil means to return the required buffer size.
- Retrieves a range of color entries from a logical palette
+ Retrieves a range of color entries from a logical palette.
- The number of entries copied
+ The number of entries copied.
- The palette handle
+ The palette handle.
- The first entry
+ The first entry.
- The number of entries to retrieve
+ The number of entries to retrieve.
- Array of PALETTEENTRY records, receiving the information
+ Array of PALETTEENTRY records, receiving the information.
- Returns the parent window of a window
+ Returns the parent window of a window.
- The parent window handle, zero on failure
+ The parent window handle, zero on failure.
- The window handle
+ The window handle.
- Retrieves a property value for a window
+ Retrieves a property value for a window.
- Nil on failure
+ Nil on failure.
- The window handle
+ The window handle.
- The property name
+ The property name.
@@ -2831,17 +2831,17 @@
- The region kind
+ The region kind.
- The region handle
+ The region handle.
- Receives the coordinates
+ Receives the coordinates.
- The current Foreground Mixing Mode in a device context
+ The current Foreground Mixing Mode in a device context.
@@ -2849,10 +2849,10 @@
- The mode, zero on failure
+ The mode, zero on failure.
- The device context
+ The device context.
@@ -2864,20 +2864,20 @@
- False on failure
+ False on failure.
- The handle of a ScrollBar, or of a window containing scrollbars
+ The handle of a ScrollBar, or of a window containing scrollbars.
- The ScrollBar kind
+ The ScrollBar kind.
- Receives the values indicated in fMask
+ Receives the values indicated in fMask.
- Retrieves a handle to one of the predefined graphic objects
+ Retrieves a handle to one of the predefined graphic objects.
These are the predefined (Windows) stock objects:
@@ -2906,14 +2906,14 @@
- The handle, zero on failure
+ The handle, zero on failure.
- The object kind
+ The object kind.
- Retrieves the system color for standard display elements
+ Retrieves the system color for standard display elements.
These are the available display elements:
@@ -2958,51 +2958,51 @@
- The RGB color
+ The RGB color.
- The system color type
+ The system color type.
- Retrieves a system brush for standard display elements
+ Retrieves a system brush for standard display elements.
- The brush handle, zero on failure
+ The brush handle, zero on failure.
- The system color type
+ The system color type.
- Retrieves a range of color entries from the system palette for a device
+ Retrieves a range of color entries from the system palette for a device.
- The number of entries copied, zero on failure
+ The number of entries copied, zero on failure.
- The device context
+ The device context.
- The first entry to retrieve
+ The first entry to retrieve.
- The number of requested entries
+ The number of requested entries.
- Receives the color information. When Nil, the total number of palette entries is returned
+ Receives the color information. When Nil, the total number of palette entries is returned.
- Retrieves various system metrics
+ Retrieves various system metrics.
All dimensions are measured in pixels.
@@ -3102,60 +3102,60 @@
- Depends on the requested item
+ Depends on the requested item.
- The requested item
+ The requested item.
- The current text color in a device context
+ The current text color in a device context.
- The RGB color
+ The RGB color.
- The device context
+ The device context.
- Calculates the number of characters, that fit into some horizontal space
+ Calculates the number of characters, that fit into some horizontal space.
- False on failure
+ False on failure.
- The device context
+ The device context.
- The string containing the characters
+ The string containing the characters.The number of
bytes
- in Str, -1 for automatic detection
+ in Str, -1 for automatic detection.
- The maximum display width, in logical units
+ The maximum display width, in logical units.Receives the number of
logical
- (UTF) characters that can be displayed. When Nil, MaxWidth is ignored
+ (UTF) characters that can be displayed. When Nil, MaxWidth is ignored.
- Receives the widths for every partial sequence of characters. Can be Nil
+ Receives the widths for every partial sequence of characters. Can be Nil.
- Receives the total width and height of the display area
+ Receives the total width and height of the display area.
- Computes the display width and height of a string
+ Computes the display width and height of a string.May not work properly without Unicode support.
@@ -3164,25 +3164,25 @@
- False on failure
+ False on failure.
- The display DC
+ The display DC.
- The text
+ The text.The number of
bytes
- in Str, -1 for automatic detection
+ in Str, -1 for automatic detection.
- Receives the total width and height of the required display area
+ Receives the total width and height of the required display area.
- Computes the display width and height for a string
+ Computes the display width and height for a string.
@@ -3206,22 +3206,22 @@
- Retrieves the metrics for the currently selected font
+ Retrieves the metrics for the currently selected font.
- False on failure
+ False on failure.
- The device context, where the font is selected
+ The device context, where the font is selected.
- Receives the information
+ Receives the information.
- Returns the size of the viewport for a device context
+ Returns the size of the viewport for a device context.
@@ -3229,17 +3229,17 @@
- False (zero) on failure
+ False (zero) on failure.
- Receives the viewport size
+ Receives the viewport size.
- Returns the origin of the viewport for a device context
+ Returns the origin of the viewport for a device context.
@@ -3247,32 +3247,32 @@
- False (zero) on failure
+ False (zero) on failure.
- Receives the viewport origin
+ Receives the viewport origin.
- Returns the extent of a window, in logical units
+ Returns the extent of a window, in logical units.
- False (zero) on failure
+ False (zero) on failure.
- Receives the window extent
+ Receives the window extent.
- Returns the attributes of a window
+ Returns the attributes of a window.
The following attributes are defined:
@@ -3310,13 +3310,13 @@
- The attribute
+ The attribute.
- The window handle
+ The window handle.
- Offset of the attribute
+ Offset of the attribute.
@@ -3326,17 +3326,17 @@
- Zero on failure
+ Zero on failure.
- The window handle
+ The window handle.
- Receives the window bounds
+ Receives the window bounds.
- Returns the Width and Height of the window
+ Returns the Width and Height of the window.
The size value is the client width and height for forms, or the total combined size for sub-controls.
@@ -3345,20 +3345,20 @@
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The width
+ The width.
- The height
+ The height.
- Retrieves the window origin for a device context in logical units
+ Retrieves the window origin for a device context in logical units.
@@ -3366,25 +3366,25 @@
- Zero on failure
+ Zero on failure.
- The device context
+ The device context.
- Receives the origin
+ Receives the origin.
- Fills rectangle or triangle areas with gradient colors
+ Fills rectangle or triangle areas with gradient colors.
- False on failure
+ False on failure.
- The device context
+ The device context.
@@ -3399,11 +3399,11 @@
- E.g. GRADIENT_FILL_RECT_H
+ E.g. GRADIENT_FILL_RECT_H.
- Removes the caret from the screen
+ Removes the caret from the screen.
Calls are cumulative; for every HideCaret a call to ShowCaret is required to undo the action.
@@ -3412,14 +3412,14 @@
- False on failure
+ False on failure.
- The window handle, can be zero
+ The window handle, can be zero.
- Initializes a Critical Section object
+ Initializes a Critical Section object.
Critical sections are thread synchronization elements, typically used to prevent concurrent access to a shared resource.
@@ -3438,7 +3438,7 @@
- The critical section object
+ The critical section object.
@@ -3456,7 +3456,7 @@
- The region type, zero on failure
+ The region type, zero on failure.
@@ -3475,43 +3475,43 @@
- Marks a display area for repaint
+ Marks a display area for repaint.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The client coordinates of the area
+ The client coordinates of the area.
- True forces a repaint of the background, before further painting
+ True forces a repaint of the background, before further painting.
- Marks a display area for repaint
+ Marks a display area for repaint.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The region to repaint
+ The region to repaint.
- True forces a repaint of the background, before further painting
+ True forces a repaint of the background, before further painting.
@@ -3520,90 +3520,90 @@
- True when the character code is the first of a double-byte character sequence
+ True when the character code is the first of a double-byte character sequence.
- The character code to test
+ The character code to test.
- True when the window is minimized
+ True when the window is minimized.
- True when the window is minimized
+ True when the window is minimized.
- The window handle
+ The window handle.
- Checks whether a handle refers to a window
+ Checks whether a handle refers to a window.
- True when handle is a valid window handle
+ True when handle is a valid window handle.
- The handle to test
+ The handle to test.
- Determines whether a window can receive mouse and keyboard input
+ Determines whether a window can receive mouse and keyboard input.
- True when the window is enabled (and visible)
+ True when the window is enabled (and visible).
- The window handle
+ The window handle.
- The definite Visible state of a window
+ The definite Visible state of a window.
- True when the window and all its parents are visible
+ True when the window and all its parents are visible.
- True when the window is maximized
+ True when the window is maximized.
- True when the window is maximized
+ True when the window is maximized.
- The window handle
+ The window handle.
- Releases a critical section, and alows use by other threads
+ Releases a critical section, and alows use by other threads.
- The critical section object
+ The critical section object.
- Draws a line from the current position up to, but not including, the specified point
+ Draws a line from the current position up to, but not including, the specified point.
The current position is set to the given endpoint.
@@ -3611,40 +3611,40 @@
- False on failure
+ False on failure.
- The device context
+ The device context.
- The endpoint in logical units
+ The endpoint in logical units.
- The endpoint in logical units
+ The endpoint in logical units.
- Converts logical coordinates into device coordinates
+ Converts logical coordinates into device coordinates.
- False on failure
+ False on failure.
- The device context
+ The device context.
- Holds and receives the transformed coordinates
+ Holds and receives the transformed coordinates.
- The number of points in Points
+ The number of points in Points.
Copies part of a source DC into an destination DC, using the specified foreground and
- background raster operations
+ background raster operations.
@@ -3661,47 +3661,47 @@
- False on failure
+ False on failure.
- The destination device context
+ The destination device context.
- The origin of the destination rectangle
+ The origin of the destination rectangle.
- The origin of the destination rectangle
+ The origin of the destination rectangle.
- The size of the destination rectangle
+ The size of the destination rectangle.
- The size of the destination rectangle
+ The size of the destination rectangle.
- The source device context
+ The source device context.
- The origin of the source rectangle
+ The origin of the source rectangle.
- The origin of the source rectangle
+ The origin of the source rectangle.
- The monochrome mask bitmap handle, can be zero
+ The monochrome mask bitmap handle, can be zero.
- The origin of the mask rectangle
+ The origin of the mask rectangle.
- The origin of the mask rectangle
+ The origin of the mask rectangle.
- The raster operations (optional)
+ The raster operations (optional).
- Displays a modal dialog message box
+ Displays a modal dialog message box.
The MessageBox function displays a modal dialog with the given text, caption, icon and buttons.
@@ -3776,23 +3776,23 @@
- The pressed button, or zero on failure
+ The pressed button, or zero on failure.
- The handle of the window that owns the MessageBox
+ The handle of the window that owns the MessageBox.
- The text displayed in the MessageBox
+ The text displayed in the MessageBox.
- The caption of the MessageBox
+ The caption of the MessageBox.
- Style flags specifying the shown buttons etc
+ Style flags specifying the shown buttons etc.
- Finds a monitor from the screen coordinates
+ Finds a monitor from the screen coordinates.
The return value contains the handle for the monitor, or a value determined using Flags when a monitor does not apply.
@@ -3809,10 +3809,10 @@
- Monotor handle, or a value derived from Flags
+ Monotor handle, or a value derived from Flags.
- The point in screen coordinates
+ The point in screen coordinates.
@@ -3822,83 +3822,83 @@
- Finds the monitor covering most of a rectangle
+ Finds the monitor covering most of a rectangle.
- The monitor handle; see dwFlags
+ The monitor handle; see dwFlags.
- The logical screen coordinates
+ The logical screen coordinates.How coordinates outside any monitor are handled; see
- MonitorFromPoint.Result
+ MonitorFromPoint.Result.
- Finds the monitor covering most of a window
+ Finds the monitor covering most of a window.The monitor handle, see
- MonitorFromPoint.Result
+ MonitorFromPoint.Result.
- The window handle
+ The window handle.How coordinates outside any monitor are handled, see
- MonitorFromPoint.Result
+ MonitorFromPoint.Result.
- Moves the current position to the specified point
+ Moves the current position to the specified point.
- False on failure
+ False on failure.
- The device context
+ The device context.
- The new logical position
+ The new logical position.
- The new logical position
+ The new logical position.
- Receives the old position, can be Nil if not required
+ Receives the old position, can be Nil if not required.
- Moves a region relative
+ Moves a region relative.
- The new region kind, zero on failure
+ The new region kind, zero on failure.
- The Region to move
+ The Region to move.
- The relative distance to move
+ The relative distance to move.
- The relative distance to move
+ The relative distance to move.
- Checks the thread's message queue for a message
+ Checks the thread's message queue for a message.
@@ -3906,7 +3906,7 @@
- Receives the message
+ Receives the message.
@@ -3914,13 +3914,13 @@
- The lowest message ID to retrieve
+ The lowest message ID to retrieve.
- The highest message ID to retrieve, zero for all messages
+ The highest message ID to retrieve, zero for all messages.
- PM_REMOVE will remove the message from the queue
+ PM_REMOVE will remove the message from the queue.
@@ -3938,13 +3938,13 @@
- False on failure
+ False on failure.
- The device context
+ The device context.
- The bounding rectangle
+ The bounding rectangle.
@@ -3956,20 +3956,20 @@
- The starting radial
+ The starting radial.
- The ending radial
+ The ending radial.
- Draws Bezier curves
+ Draws Bezier curves.
- False on failure
+ False on failure.
- The device context
+ The device context.
- The array of points
+ The array of points.
- The number of points in Points
+ The number of points in Points.
- True draws a Polygon
+ True draws a Polygon.
- True uses the end-point as the starting point of the next segment
+ True uses the end-point as the starting point of the next segment.
- Draws a filled Polygon
+ Draws a filled Polygon.
Use Polygon to draw a closed, many-sided shape on the canvas, outlined with the current Pen and filled with the current Brush.
@@ -4033,23 +4033,23 @@
- False on failure
+ False on failure.
- The device context
+ The device context.
- The array of vertices
+ The array of vertices.
- The number of vertices
+ The number of vertices.
- Selects the fill algorithm
+ Selects the fill algorithm.
- Draws a sequence of lines
+ Draws a sequence of lines.
Use Polyline to connect a set of points on the canvas.
@@ -4104,13 +4104,13 @@
- Zero on failure
+ Zero on failure.
- The target window handle
+ The target window handle.
- The message ID
+ The message ID.
@@ -4120,49 +4120,49 @@
- Tests whether a point lies in a region
+ Tests whether a point lies in a region.
- True when the point lies in the region
+ True when the point lies in the region.
- The region
+ The region.
- The point coordinate
+ The point coordinate.
- The point coordinate
+ The point coordinate.
- Maps palette entries from the current logical palette to the system palette
+ Maps palette entries from the current logical palette to the system palette.
- The number of mapped entries
+ The number of mapped entries.
- The device context
+ The device context.
- Draws a filled rectangle
+ Draws a filled rectangle.
The rectangle is outlined with the current Pen, and filled with the current Brush. The bottom and right edges are not part of the rectangle.
- False on failure
+ False on failure.
- The device context
+ The device context.
@@ -4178,22 +4178,22 @@
- Checks whether the clipping region contains (part of) a rectangle
+ Checks whether the clipping region contains (part of) a rectangle.
- True when (part of) the rectangle is visible
+ True when (part of) the rectangle is visible.
- The device context
+ The device context.
- The rectangle
+ The rectangle.
- Redraws (part of) a window
+ Redraws (part of) a window.
All invalidated parts of a window, which deserve an update, are collected in the update region. When this region is not empty, WM_ERASEBKGND, WM_PAINT and WM_NCPAINT messages are sent to the window, as soon as the application is (almost) idle. RedrawWindow can be used to force an immediate redraw instead.
@@ -4254,19 +4254,19 @@
- False on failure
+ False on failure.
- The window to redraw
+ The window to redraw.
- The rectangle to redraw, ignored when a region is given
+ The rectangle to redraw, ignored when a region is given.
- The region to redraw, can be zero
+ The region to redraw, can be zero.
- How the redraw works
+ How the redraw works.
@@ -4277,60 +4277,60 @@
- False on failure
+ False on failure.
- Releases an Device Context obtained by GetDC
+ Releases an Device Context obtained by GetDC.
- Zero on failure
+ Zero on failure.
- The handle of the window, whose DC is released
+ The handle of the window, whose DC is released.
- The device context to release
+ The device context to release.
- Removes a named property from a window
+ Removes a named property from a window.
- The handle of the removed data, zero on failure
+ The handle of the removed data, zero on failure.
- The window handle
+ The window handle.
- The name of the property to remove
+ The name of the property to remove.Restores an Device Context (DC) to an previously
saved
- state
+ state.
- False on failure
+ False on failure.
- The device context
+ The device context.
- The index returned by SaveDC, or -1 for the most recently saved state
+ The index returned by SaveDC, or -1 for the most recently saved state.
- Draws a filled rectangle with rounded corners
+ Draws a filled rectangle with rounded corners.
The rectangle is outlined with the current Pen, and filled with the current Brush.
@@ -4339,13 +4339,13 @@
- False on failure
+ False on failure.
- The device context
+ The device context.
- The rectangle coordinates
+ The rectangle coordinates.
@@ -4357,43 +4357,43 @@
- The extent of the ellipse, used for the rounded corners
+ The extent of the ellipse, used for the rounded corners.
- The extent of the ellipse, used for the rounded corners
+ The extent of the ellipse, used for the rounded corners.
- Saves the state of an Device Context in the context stack
+ Saves the state of an Device Context in the context stack.
- The index of the saved DC, zero on failure
+ The index of the saved DC, zero on failure.
- The device context to save
+ The device context to save.
- Converts absolute Screen coordinates into Client relative coordinates
+ Converts absolute Screen coordinates into Client relative coordinates.
- False on failure
+ False on failure.
- The handle of the window with the client area
+ The handle of the window with the client area.
- The point to convert
+ The point to convert.
- Scrolls the content of a window, by a number of pixels
+ Scrolls the content of a window, by a number of pixels.
The following flags values are defined:
@@ -4416,32 +4416,32 @@
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- Horizontal distance (positive to scroll right)
+ Horizontal distance (positive to scroll right).
- Vertical distance (positive to scroll down)
+ Vertical distance (positive to scroll down).The part of the window, that is to be scrolled. Nil means the entire client area.
- Pixels falling outside this rectangle are lost. Nil means the entire client area
+ Pixels falling outside this rectangle are lost. Nil means the entire client area.
- The invalidated parts of the window are added to this region (can be zero)
+ The invalidated parts of the window are added to this region (can be zero).
- Receives the boundary of the invalidated part of the window (can be Nil)
+ Receives the boundary of the invalidated part of the window (can be Nil).
- Control flags
+ Control flags.
@@ -4451,32 +4451,32 @@
- The region kind
+ The region kind.
- The device context
+ The device context.
- The region to copy, zero for an empty region
+ The region to copy, zero for an empty region.
- Selects an object into an device context
+ Selects an object into an device context.
- The previously selected object, for a region the new region type
+ The previously selected object, for a region the new region type.
- The device context
+ The device context.
- The object to select
+ The object to select.
- Selects a logical palette into an device context
+ Selects a logical palette into an device context.
A foreground palette becomes the palette for the device when the application is in the foreground. A background palette instead is mapped to the closest colors in the palette for the physical device.
@@ -4485,20 +4485,20 @@
- The handle of the previously selected palette
+ The handle of the previously selected palette.
- The device context
+ The device context.
- The palette to select
+ The palette to select.
- True to select the background palette
+ True to select the background palette.
- Sends a message to a window
+ Sends a message to a window.
This section was copied from LCLIntf, and may not apply to all platforms.
@@ -4524,50 +4524,50 @@
- The result depends on the message type
+ The result depends on the message type.
- The handle of the target window
+ The handle of the target window.
- The message ID
+ The message ID.
- Message parameter
+ Message parameter.
- Message parameter
+ Message parameter.
- Sets focus to the specified window, if the application is on top
+ Sets focus to the specified window, if the application is on top.
- The handle of the window that lost the focus, zero on failure
+ The handle of the window that lost the focus, zero on failure.
- The window handle to activate
+ The window handle to activate.
- Sets the current background color of an device context
+ Sets the current background color of an device context.
- The old background color, CLR_INVALID on failure
+ The old background color, CLR_INVALID on failure.
- The device context
+ The device context.
- The new background color
+ The new background color.
- Sets the background mix mode (transparency) of an device context
+ Sets the background mix mode (transparency) of an device context.
The background mode specifies the handling of non-solid painting objects, like text, hatched brushes or dotted pens.
@@ -4584,17 +4584,17 @@
- The previous background mode, zero on failure
+ The previous background mode, zero on failure.
- The device context
+ The device context.
- The new background mode
+ The new background mode.
- Sets the mouse capture to the specified window
+ Sets the mouse capture to the specified window.The window will receive all mouse messages, until capture is released again.
@@ -4602,49 +4602,49 @@
- The handle of the previous capture window, zero if none
+ The handle of the previous capture window, zero if none.
- The handle of the capturing window
+ The handle of the capturing window.
- Moves the Caret to the specified coordinates
+ Moves the Caret to the specified coordinates.
- False on failure
+ False on failure.
- The new caret position
+ The new caret position.
- The new caret position
+ The new caret position.
- Moves the Caret into a window
+ Moves the Caret into a window.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The new caret position
+ The new caret position.
- The new caret position
+ The new caret position.
- Changes the shape of the mouse cursor
+ Changes the shape of the mouse cursor.
@@ -4652,37 +4652,37 @@
- The handle of the previous cursor, zero if none
+ The handle of the previous cursor, zero if none.
- The new cursor handle
+ The new cursor handle.
- Changes the position of the mouse cursor
+ Changes the position of the mouse cursor.
- False on failure
+ False on failure.
- The new screen coordinates
+ The new screen coordinates.
- The new screen coordinates
+ The new screen coordinates.
- Sets the keyboard input focus to the specified window
+ Sets the keyboard input focus to the specified window.
- The handle of the previously focused window, zero if none
+ The handle of the previously focused window, zero if none.
- The handle of the window receiving the focus
+ The handle of the window receiving the focus.
@@ -4693,14 +4693,14 @@
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- Sets the mapping mode of an device context
+ Sets the mapping mode of an device context.
The mapping mode specifies the correspondence between logical and physical units. Supported modes are:
@@ -4732,67 +4732,67 @@
- The old mapping mode
+ The old mapping mode.
- The device context
+ The device context.
- The new mapping mode
+ The new mapping mode.
- Assigns a menu to a window
+ Assigns a menu to a window.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The menu handle
+ The menu handle.
- Changes the parent of a window
+ Changes the parent of a window.
- The handle of the previous parent window, zero if none or failure
+ The handle of the previous parent window, zero if none or failure.
- The handle of the child window
+ The handle of the child window.
- The handle of the new parent window, zero for the desktop window
+ The handle of the new parent window, zero for the desktop window.
- Adds a property to a window
+ Adds a property to a window.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The property name
+ The property name.
- Pointer to the property data
+ Pointer to the property data.
- Sets the Foreground Mixing Mode in a device context
+ Sets the Foreground Mixing Mode in a device context.
The raster operation specifies how foreground painting (Brush, Pen) is combined with the current pixels in the DC. The operation combines bitwise the distinct red, green and blue values in pixel colors.
@@ -4857,40 +4857,40 @@
- The old mode, zero on failure
+ The old mode, zero on failure.
- The device context
+ The device context.
- The new mode
+ The new mode.
- Sets (selected) parameters of a scroll bar
+ Sets (selected) parameters of a scroll bar.
- The (new) slider position
+ The (new) slider position.
- The handle of a ScrollBar, or of a window containing scrollbars
+ The handle of a ScrollBar, or of a window containing scrollbars.
- The ScrollBar kind
+ The ScrollBar kind.
- Contains the new values
+ Contains the new values.
- True forces a repaint of the ScrollBar
+ True forces a repaint of the ScrollBar.
- Sets the StrechBlt mode for an device context
+ Sets the StrechBlt mode for an device context.
The following modes are defined:
@@ -4913,18 +4913,18 @@
- The previous mode, zero on failure
+ The previous mode, zero on failure.
- The Device Context
+ The Device Context.
- The new mode
+ The new mode.
- Sets the colors for one or more display elements of window borders and desktop
+ Sets the colors for one or more display elements of window borders and desktop.
@@ -4932,50 +4932,50 @@
- False on failure
+ False on failure.
- The number of colors to change, size of the arrays
+ The number of colors to change, size of the arrays.
- Array of element identifiers
+ Array of element identifiers.
- Array of RGB colors
+ Array of RGB colors.
- Sets extra inter-character spacing in text output
+ Sets extra inter-character spacing in text output.
- The previous spacing, $80000000 on failure
+ The previous spacing, $80000000 on failure.
- The device context
+ The device context.
- The additional spacing, in logical units
+ The additional spacing, in logical units.
- Sets the text color in a device context
+ Sets the text color in a device context.
- The previous color, CLR_INVALID on failure
+ The previous color, CLR_INVALID on failure.
- The Device Context
+ The Device Context.
- The new text color
+ The new text color.
- Sets the extent of the viewport for a device context
+ Sets the extent of the viewport for a device context.
@@ -4983,19 +4983,19 @@
- False on failure
+ False on failure.
- The Device Context
+ The Device Context.
- The extent in device units
+ The extent in device units.
- The extent in device units
+ The extent in device units.
- Receives the previous extent, if not Nil
+ Receives the previous extent, if not Nil.
@@ -5009,23 +5009,23 @@
- False on failure
+ False on failure.
- The Device Context
+ The Device Context.
- The coordinates in device units
+ The coordinates in device units.
- The coordinates in device units
+ The coordinates in device units.
- Receives the previous origin, if not Nil
+ Receives the previous origin, if not Nil.
- Sets the extent of the window for an device context
+ Sets the extent of the window for an device context.
@@ -5033,64 +5033,64 @@
- False on failure
+ False on failure.
- The Device Context
+ The Device Context.
- The extent in logical units
+ The extent in logical units.
- The extent in logical units
+ The extent in logical units.
- Receives the previous extent, if not Nil
+ Receives the previous extent, if not Nil.
- Sets an attribute of a window
+ Sets an attribute of a window.
- The previous value, zero on failure
+ The previous value, zero on failure.
- The window handle
+ The window handle.
- The attribute offset
+ The attribute offset.
- The new value
+ The new value.
- Specifies which window point maps to the viewport origin (0,0)
+ Specifies which window point maps to the viewport origin (0,0).
- False on failure
+ False on failure.
- The device context
+ The device context.
- The origin in logical units
+ The origin in logical units.
- The origin in logical units
+ The origin in logical units.
- Receives the previous origin, if not Nil
+ Receives the previous origin, if not Nil.
- Changes the size, position, and Z order of a window
+ Changes the size, position, and Z order of a window.
The Z order can be changed to just behind another window, or:
@@ -5146,50 +5146,50 @@
- Zero on failure
+ Zero on failure.
- The window handle
+ The window handle.
- The window handle or Z order position
+ The window handle or Z order position.
- The window origin
+ The window origin.
- The window origin
+ The window origin.
- The window extent
+ The window extent.
- The window extent
+ The window extent.
- General placement flags
+ General placement flags.
- Restricts the visible part of the entire window
+ Restricts the visible part of the entire window.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- The window region handle
+ The window region handle.
- True forces a repaint of the window
+ True forces a repaint of the window.
- Shows the Caret (text cursor)
+ Shows the Caret (text cursor).
ShowCaret is a Boolean function used to display the caret or text cursor for the window handle specified in hWnd. The return value is True if the caret was successfully displayed in the method.
@@ -5209,34 +5209,34 @@
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- Shows or hides a ScrollBar
+ Shows or hides a ScrollBar.
- False on failure
+ False on failure.
- The window or ScrollBar handle
+ The window or ScrollBar handle.
- The scrollbar type (SB_CTL, SB_HORZ...)
+ The scrollbar type (SB_CTL, SB_HORZ...).
- True shows, False hides the ScrollBar
+ True shows, False hides the ScrollBar.
- Shows a window in an specific state
+ Shows a window in an specific state.
These are the available options in nCmdShow:
@@ -5271,10 +5271,10 @@
- True when the window was already visible
+ True when the window was already visible.
- The window handle
+ The window handle.
@@ -5282,7 +5282,7 @@
- Copies a rectangular region to a device context, shrinking or stretching it as needed
+ Copies a rectangular region to a device context, shrinking or stretching it as needed.
@@ -5292,40 +5292,40 @@
- False on failure
+ False on failure.
- The destination device context
+ The destination device context.
- The destination origin
+ The destination origin.
- The destination origin
+ The destination origin.
- The destination extent
+ The destination extent.
- The destination extent
+ The destination extent.
- The source device context
+ The source device context.
- The source origin
+ The source origin.
- The source origin
+ The source origin.
- The source extent
+ The source extent.
- The source extent
+ The source extent.
- The raster opcode (see BitBlt)
+ The raster opcode (see BitBlt).
@@ -5343,47 +5343,47 @@
- The destination Device Context
+ The destination Device Context.
- The destination origin
+ The destination origin.
- The destination origin
+ The destination origin.
- The destination extent
+ The destination extent.
- The destination extent
+ The destination extent.
- The source origin
+ The source origin.
- The source origin
+ The source origin.
- The source extent
+ The source extent.
- The source extent
+ The source extent.
- The device independent bitmap bits
+ The device independent bitmap bits.
- The bitmap info structure
+ The bitmap info structure.
- The color mode
+ The color mode.
- The raster operation
+ The raster operation.
- Retrieves or sets one of the system-wide parameters
+ Retrieves or sets one of the system-wide parameters.
Most of the parameters are Windows platform specific.
@@ -5564,79 +5564,79 @@
- False on failure
+ False on failure.
- The parameter and action
+ The parameter and action.
- Depends on uiAction
+ Depends on uiAction.
- Depends on uiAction
+ Depends on uiAction.
- Additional actions
+ Additional actions.
- Draws an string without formatting (single line)
+ Draws an string without formatting (single line).
- False on failure
+ False on failure.
- The Device Context
+ The Device Context.
- The text origin in logical coordinates
+ The text origin in logical coordinates.
- The text origin in logical coordinates
+ The text origin in logical coordinates.
- The text
+ The text.
- The number of (Wide)Chars in the string
+ The number of (Wide)Chars in the string.
- Forces an immediate repaint of a window, if required
+ Forces an immediate repaint of a window, if required.
- False on failure
+ False on failure.
- The window handle
+ The window handle.
- Finds the window containing the specified point
+ Finds the window containing the specified point.
- The window handle, zero on failure
+ The window handle, zero on failure.
- The screen coordinates
+ The screen coordinates.
- Adds an event handler routine for the specified handle
+ Adds an event handler routine for the specified handle.
- Pointer to the event handler structure created in the widgetset class
+ Pointer to the event handler structure created in the widgetset class.
@@ -5652,7 +5652,7 @@
- Adds a process handler routine for the specified handle
+ Adds a process handler routine for the specified handle.
@@ -5670,7 +5670,7 @@
- Adds a pipe handler routine for the specified handle
+ Adds a pipe handler routine for the specified handle.
@@ -5688,22 +5688,22 @@
- Allocates an invisible window that can be used to receive messages
+ Allocates an invisible window that can be used to receive messages.
- The window handle, zero on failure
+ The window handle, zero on failure.
- The callback method for the window. Can be Nil
+ The callback method for the window. Can be Nil.
- Displays a dialog box with the specified values, and returns the modal result
+ Displays a dialog box with the specified values, and returns the modal result.
@@ -5716,125 +5716,125 @@
- Modal result value for the dialog as a LongInt type
+ Modal result value for the dialog as a LongInt type.
- Caption for the dialog
+ Caption for the dialog.
- Message text for the dialog
+ Message text for the dialog.
- Dialog type used to get an icon and flags used the dialog
+ Dialog type used to get an icon and flags used the dialog.
- Collection with buttons for the dialog
+ Collection with buttons for the dialog.
- Help context used when F1 is pressed in the dialog
+ Help context used when F1 is pressed in the dialog.
- Calls the default window handler to process a message from a control
+ Calls the default window handler to process a message from a control.
- The control posting the message
+ The control posting the message.
- Message structure with the command and parameters
+ Message structure with the command and parameters.
- Gets the MIME type for the specified clipboard format
+ Gets the MIME type for the specified clipboard format.
TClipboardFormat
- MIME type for the clipboard format identifier
+ MIME type for the clipboard format identifier.
- Identifier for the registered clipboard format
+ Identifier for the registered clipboard format.
- Gets clipboard data for a given format and saves it to the specified stream
+ Gets clipboard data for a given format and saves it to the specified stream.
- True if clipboard data was successfully retrieved and stored in the method
+ True if clipboard data was successfully retrieved and stored in the method.
- The clipboard operation type
+ The clipboard operation type.
- Identifier for the registered clipboard format
+ Identifier for the registered clipboard format.
- Stream where the clipboard data is appended
+ Stream where the clipboard data is appended.
- Gets a list of available registered clipboard formats
+ Gets a list of available registered clipboard formats.
- True on success
+ True on success.
- The clipboard operation type
+ The clipboard operation type.
- Number of clipboard formats returned in the list
+ Number of clipboard formats returned in the list.
- Pointer to the list of available registered clipboard formats
+ Pointer to the list of available registered clipboard formats.
- Sets the requested formats and requests ownership of the clipboard
+ Sets the requested formats and requests ownership of the clipboard.
- True on success
+ True on success.
- Type of clipboard type for the request
+ Type of clipboard type for the request.
- Event signalled to get data for the clipboard, or Nil when ownership is lost
+ Event signalled to get data for the clipboard, or Nil when ownership is lost.
- Number of clipbpard formats in the list
+ Number of clipbpard formats in the list.
- Pointer to the list of registered clipboard formats requested
+ Pointer to the list of registered clipboard formats requested.
- Registers a clipboard format for the specified MIME type
+ Registers a clipboard format for the specified MIME type.
- Pointer to the unsigned Integer value for the clipboard format
+ Pointer to the unsigned Integer value for the clipboard format.
- MIME type for the clipboard data
+ MIME type for the clipboard data.
@@ -5901,7 +5901,7 @@
- Creates one of the standard cursors
+ Creates one of the standard cursors.
@@ -5909,10 +5909,10 @@
- The cursor handle, zero on failure
+ The cursor handle, zero on failure.
- The cursor shape
+ The cursor shape.
@@ -5928,14 +5928,14 @@
- Deletes a window created with AllocateHWnd
+ Deletes a window created with AllocateHWnd.
- The window handle
+ The window handle.
@@ -5948,7 +5948,7 @@
- Draws the DockRect during drag-dock operations
+ Draws the DockRect during drag-dock operations.
The Windows implementation doesn't cooperate with the DragManager. See Mantis 0018525.
@@ -5956,17 +5956,17 @@
- The old DockRect
+ The old DockRect.
- The new DockRect
+ The new DockRect.
- Draws a grid lines inside a rectangle with the specified spacing
+ Draws a grid lines inside a rectangle with the specified spacing.
@@ -5984,7 +5984,7 @@
- Draws an UTF-8 string without formatting (single line)
+ Draws an UTF-8 string without formatting (single line).
The inter-character spacing array (Dx) must have one element for every Char (byte) in the UTF-8 text. For multi-byte character codes the values of all Dx elements are summed up.
@@ -5995,36 +5995,36 @@
- False on failure
+ False on failure.
- The Device Context
+ The Device Context.
- The reference point, used to position the text
+ The reference point, used to position the text.
- The reference point, used to position the text
+ The reference point, used to position the text.
- Output options
+ Output options.
- The bounding rectangle
+ The bounding rectangle.
- The text
+ The text.
- The number of Chars in the string
+ The number of Chars in the string.
- Pointer to an array of inter-character spacing values, can be Nil
+ Pointer to an array of inter-character spacing values, can be Nil.
- Determines if the typeface in the specified font handle is a monspaced font
+ Determines if the typeface in the specified font handle is a monspaced font.
@@ -6033,12 +6033,12 @@
- Font handle examined in the method
+ Font handle examined in the method.
- Draws a 3D frame for a rectangle on a device context using the specified style
+ Draws a 3D frame for a rectangle on a device context using the specified style.
@@ -6060,7 +6060,7 @@
- Gets a string representing the specified key and shift modifier
+ Gets a string representing the specified key and shift modifier.
@@ -6126,7 +6126,7 @@
- Gets the coordinates for the client area in the specified window handle
+ Gets the coordinates for the client area in the specified window handle.
@@ -6151,16 +6151,16 @@
- Updates the constraints object (e.g. TSizeConstraints) with interface specific bounds
+ Updates the constraints object (e.g. TSizeConstraints) with interface specific bounds.
- False on failure
+ False on failure.
- Should be a TSizeConstraints
+ Should be a TSizeConstraints.
@@ -6864,7 +6864,7 @@
- Writes UTF-8-encoded text to the specified device context
+ Writes UTF-8-encoded text to the specified device context.
@@ -6888,7 +6888,7 @@
- Theme services class instance for the widgetset
+ Theme services class instance for the widgetset.
ThemeServices is a read-only property which provides access to the TThemeServices class instance for the platform. The value for the property is assigned in the CreateThemeServices method.
@@ -6901,7 +6901,7 @@
- Class reference used to create new instance of the TWidgetSet class
+ Class reference used to create new instance of the TWidgetSet class.
@@ -6927,37 +6927,37 @@
- Constant used in TWidgetSet.GetLCLCapability
+ Constant used in TWidgetSet.GetLCLCapability.
- Constant used in TWidgetSet.GetLCLCapability
+ Constant used in TWidgetSet.GetLCLCapability.
- Base class for exceptions raised in the LCL interface
+ Base class for exceptions raised in the LCL interface.
- Exception raised in the LCL interface
+ Exception raised in the LCL interface.
- Exception raised in the LCL interface
+ Exception raised in the LCL interface.
- Exception raised in the LCL interface
+ Exception raised in the LCL interface.
@@ -7122,7 +7122,7 @@
- Provides access to the widgetset class instance for the platform
+ Provides access to the widgetset class instance for the platform.
WidgetSet is a unit global TWidgetSet variable with the singleton used to access the widgetset class instance for the platform. WidgetSet contains a TWidgetSet descendant which implements the properties, methods, and events for a specific platform.
diff --git a/docs/xml/lcl/intfgraphics.xml b/docs/xml/lcl/intfgraphics.xml
index 8a4ecf1ce1..63b02dc1e3 100644
--- a/docs/xml/lcl/intfgraphics.xml
+++ b/docs/xml/lcl/intfgraphics.xml
@@ -7,7 +7,7 @@
====================================================================
-->
- Classes and functions for easy handling of raw images (interface images)
+ Classes and functions for easy handling of raw images (interface images).
Author: Mattias Gaertner
@@ -1529,7 +1529,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -1550,7 +1550,7 @@
- Alternate constructor for the class instance
+ Alternate constructor for the class instance.
@@ -1565,13 +1565,13 @@
- Destructor for the class instance
+ Destructor for the class instance.
- Stores values from the specified persistent object into the current class instance
+ Stores values from the specified persistent object into the current class instance.
@@ -1580,20 +1580,20 @@
- Increments the internal update counter
+ Increments the internal update counter.
- Decrements the internal update counter
+ Decrements the internal update counter.
- SetSize - define the height and width of the image
+ SetSize - define the height and width of the image.
@@ -1606,7 +1606,7 @@
- CheckDescription - looks at the supplied Image Description record and returns True if it matches the actual properties of the image
+ CheckDescription - looks at the supplied Image Description record and returns True if it matches the actual properties of the image.
Generates an exception if an error is encountered in the image description
@@ -1623,7 +1623,7 @@
- LoadFromDevice - loads the image from the device with specified handle
+ LoadFromDevice - loads the image from the device with specified handle.
@@ -1633,7 +1633,7 @@
- LoadFromBitmap - loads the image from a Bitmap
+ LoadFromBitmap - loads the image from a Bitmap.
@@ -1648,7 +1648,7 @@
- CreateBitmaps - generates a Bitmap and an optional Mask for the image data
+ CreateBitmaps - generates a Bitmap and an optional Mask for the image data.
@@ -1663,7 +1663,7 @@
- Stores the raw image data in the class instance
+ Stores the raw image data in the class instance.
@@ -1675,7 +1675,7 @@
- Gets the raw image data stored in the class instance and optionally release ownership
+ Gets the raw image data stored in the class instance and optionally release ownership.
@@ -1687,7 +1687,7 @@
- Sets the color for all pixels in the raw image data to the specified value
+ Sets the color for all pixels in the raw image data to the specified value.
@@ -1717,7 +1717,7 @@
- Merges a source image with alpha blending
+ Merges a source image with alpha blending.
Merges an image to a canvas using alpha blending according to a separate image containing the alpha channel. White pixels in the alpha channel will correspond to the source image pixel being fully drawn, grey ones are merged and black ones ignored.
@@ -1742,7 +1742,7 @@
- Gets the alpha value from the mask if needed
+ Gets the alpha value from the mask if needed.
AlphaFromMask gets the alpha value from the mask if AKeepAlpha is True (default condition).
@@ -1766,7 +1766,7 @@
- GetXYDataPostion - finds the position of the raw image
+ GetXYDataPostion - finds the position of the raw image.
Yes, it really is spelled 'Postion'
@@ -1781,7 +1781,7 @@
- GetXYMaskPostion - finds the position of the raw image mask
+ GetXYMaskPostion - finds the position of the raw image mask.
@@ -1796,7 +1796,7 @@
- Returns an pointer to the raw data for a scan line
+ Returns an pointer to the raw data for a scan line.
Similar to Delphi's TBitmap.ScanLine. Works with scan lines aligned to whole bytes.
@@ -1846,21 +1846,21 @@
- PixelData - the raw image data for the image
+ PixelData - the raw image data for the image.
- MaskData - the raw data for the mask in the image
+ MaskData - the raw data for the mask in the image.
- DataDescription - the raw description record for the current image
+ DataDescription - the raw description record for the current image.
@@ -1879,7 +1879,7 @@
- TColors - the colors available for the specified pixel
+ TColors - the colors available for the specified pixel.
@@ -1891,7 +1891,7 @@
- Masked - whether the image mask applies at the specified position
+ Masked - whether the image mask applies at the specified position.
@@ -1904,7 +1904,7 @@
- TLazIntfImageMask - applying a mask at the Raw Image level
+ TLazIntfImageMask - applying a mask at the Raw Image level.
@@ -1977,12 +1977,12 @@
- Image - the image to which masking is applied
+ Image - the image to which masking is applied.
- Descendant of TFPPalette which uses an AVL tree for speed up
+ Descendant of TFPPalette which uses an AVL tree for speed up.
@@ -2043,7 +2043,7 @@
- Destructor for the class instance
+ Destructor for the class instance.
@@ -2116,12 +2116,12 @@
- Constructor for the class instance
+ Constructor for the class instance.
- Destructor for the class instance
+ Destructor for the class instance.
@@ -2315,12 +2315,12 @@
- Constructor for the class instance
+ Constructor for the class instance.
- Destructor for the class instance
+ Destructor for the class instance.
@@ -2331,8 +2331,7 @@
-
-
+
ILazImageReader is an interface used to extend TFPCustomImageReader to initialize a TRawImgeDescription based on the image to be read.
@@ -2357,7 +2356,7 @@
- TLazReaderXPM - this is a FPImage reader for xpm images
+ TLazReaderXPM - this is a FPImage reader for xpm images.
@@ -2454,13 +2453,13 @@
- Constructor for the class instance
+ Constructor for the class instance.
- Destructor for the class instance
+ Destructor for the class instance.
@@ -2472,7 +2471,7 @@
- TLazWriterXPM is a FPImage writer for xpm images
+ TLazWriterXPM is a FPImage writer for xpm images.
@@ -2503,7 +2502,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
@@ -2520,10 +2519,10 @@
- No mask is generated
+ No mask is generated.
- A mask is generated based on the first pixel read
+ A mask is generated based on the first pixel read.
Note: when reading images with an alpha channel and the alpha channel has no influence on the mask (the maskcolor is transparent).
@@ -2531,7 +2530,7 @@
- A mask is generated based on the given color
+ A mask is generated based on the given color.
Note: when reading images with an alpha channel and the alpha channel has no influence on the mask (the maskcolor is transparent).
@@ -2554,15 +2553,15 @@
- For completeness - don't know if they exist
+ For completeness - don't know if they exist.
- For completeness - don't know if they exist
+ For completeness - don't know if they exist.
- For completeness - don't know if they exist
+ For completeness - don't know if they exist.
@@ -2643,31 +2642,31 @@
- Color which should be interpreted as masked
+ Color which should be interpreted as masked.
- For palette based images, index of the color which should be interpreted as masked
+ For palette based images, index of the color which should be interpreted as masked.
- Size (in bytes) for a scanline
+ Size (in bytes) for a scanline.
- Information about the bitmap as read from the stream
+ Information about the bitmap as read from the stream.
- Buffer with Palette entries
+ Buffer with Palette entries.Buffer for ascanline. Can be Byte, Word, TColorRGB or TColorRGBA.
- If set, rawimagedescription is updated
+ If set, rawimagedescription is updated.
- For progress support
+ For progress support.
- If alpha channel is declared but does not exist (all values = 0)
+ If alpha channel is declared but does not exist (all values = 0).
@@ -2833,13 +2832,13 @@
- Constructor for the class instance
+ Constructor for the class instance.
- Destructor for the class instance
+ Destructor for the class instance.
@@ -2864,7 +2863,7 @@
- TLazReaderBMP - This is an improved FPImage reader for bmp images
+ TLazReaderBMP - This is an improved FPImage reader for bmp images.
@@ -2950,7 +2949,7 @@
- Implements an image readr for a single DIB in an icon file
+ Implements an image readr for a single DIB in an icon file.
TLazReaderIconDIB is a FPImage reader for a single DIB from an icon file.
@@ -3142,7 +3141,7 @@
- Extends the FCL TIFF image reader to support the ILazImageReader interface
+ Extends the FCL TIFF image reader to support the ILazImageReader interface.
@@ -3246,7 +3245,7 @@
- Extends the FCL TIFF image writer to support the ILazImageWriter interface
+ Extends the FCL TIFF image writer to support the ILazImageWriter interface.
@@ -3453,7 +3452,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 initalizes members in the class instance, and sets the default value for IconType to iitNone.
@@ -3463,7 +3462,7 @@
- Destructor for the class instance
+ Destructor for the class instance.
Destroy is the overridden destructor for the class instance. Destroy frees resources allocated for members, and calls the inherited destructor prior to exit.
diff --git a/docs/xml/lcl/jsonpropstorage.xml b/docs/xml/lcl/jsonpropstorage.xml
index 33dd03ba35..4cd0d25a4f 100644
--- a/docs/xml/lcl/jsonpropstorage.xml
+++ b/docs/xml/lcl/jsonpropstorage.xml
@@ -147,7 +147,7 @@
- A Boolean value to set the property TCustomJSONPropStorage.Formatted
+ A Boolean value to set the property TCustomJSONPropStorage.Formatted.
@@ -178,7 +178,7 @@
- Ask the underlying storage object for an entry
+ Ask the underlying storage object for an entry.
diff --git a/docs/xml/lcl/lazcanvas.xml b/docs/xml/lcl/lazcanvas.xml
index 10273cf838..623b1a02d4 100644
--- a/docs/xml/lcl/lazcanvas.xml
+++ b/docs/xml/lcl/lazcanvas.xml
@@ -7,7 +7,7 @@
====================================================================
-->
- Classes and functions for extending TFPImageCanvas
+ Classes and functions for extending TFPImageCanvas.
lazcanvas.pas contains classes and functions for extending TFPImageCanvas to support more stretching filters, and to support all features from the LCL TCanvas. TLazCanvas also fixes various small problems and incompatibilities between TFPImageCanvas versions, making the interface smoother and more consistent.
@@ -37,7 +37,7 @@
- Identifies image formats supported in TLazCanvas
+ Identifies image formats supported in TLazCanvas.
Used in the implementation of the CanvasCopyRect method in TLazCanvas, and in custom-drawn LCL controls to speed up image drawing in the LCL interface.
@@ -48,33 +48,33 @@
- Images use a format other than those in this enumeration
+ Images use a format other than those in this enumeration.
- Images use 16-bit RGB colors
+ Images use 16-bit RGB colors.
- Images use 24-bit RGB colors
+ Images use 24-bit RGB colors.
- Images use 24-bit RGB colors with inverse values
+ Images use 24-bit RGB colors with inverse values.
- Images use 24-bit BGR colors
+ Images use 24-bit BGR colors.
- Images use 32-bit BGR colors with an Aplha channel
+ Images use 32-bit BGR colors with an Aplha channel.
- Images use 32-bit RGB colors with an Aplha channel
+ Images use 32-bit RGB colors with an Aplha channel.
- Images use 32-bit RGB colors with an Aplha channel in the low-order octet
+ Images use 32-bit RGB colors with an Aplha channel in the low-order octet.
- Implements a very sharp and square interpolation
+ Implements a very sharp and square interpolation.
TFPSharpInterpolation implements a very sharp and square interpolation for stretching, similar to StretchBlt from the Windows API.
@@ -86,7 +86,7 @@
- Paints an image on the Canvas using the specified coordinates and dimensions
+ Paints an image on the Canvas using the specified coordinates and dimensions.
@@ -106,7 +106,7 @@
- Contains properties reflecting the state for a Lazarus canvas
+ Contains properties reflecting the state for a Lazarus canvas.
TLazCanvasState is a class with public members that reflect the state for a TLazCanvas instance. A destructor is provided to ensure that resources allocated to members variables are freed before the class instance is destroyed.
@@ -128,28 +128,28 @@
- Brush for the canvas
+ Brush for the canvas.
- Pen for the canvas
+ Pen for the canvas.
- Font for the canvas
+ Font for the canvas.
- Base window origin for the canvas
+ Base window origin for the canvas.
The values in WindowOrg are relative to the coordinates in BaseWindowOrg. BaseWindowOrg coordinates are relative to the canvas for the containing Form. It is useful when implementing the non-native windowed controls.
@@ -160,7 +160,7 @@
- Window origin for the canvas
+ Window origin for the canvas.
Contains the absolute coordinates for the canvas with BaseWindowOrg summed up.
@@ -171,21 +171,21 @@
- Indicates if Clipping is enabled for the canvas
+ Indicates if Clipping is enabled for the canvas.
- Defines the clipping region for the canvas
+ Defines the clipping region for the canvas.
- Destructor for the class instance
+ Destructor for the class instance.
Destroy is the overridden destructor for the class instance. Destroy ensures that resources allocated for the Brush and Pen properties are freed before the class instance is destroyed. Destroy calls the inherited destructor prior to exiting from the method.
@@ -200,7 +200,7 @@
- Implements a canvas which masks differences between FCL and LCL canvas classes
+ Implements a canvas which masks differences between FCL and LCL canvas classes.
@@ -225,7 +225,7 @@
- Stores saved canvas state information
+ Stores saved canvas state information.
Used to store and restore canvas states in the SaveState and RestoreState methods. Contains TLazCanvasState class instances.
@@ -240,83 +240,83 @@
- Gets the value for the AssignedBrush property
+ Gets the value for the AssignedBrush property.
- Value for the property
+ Value for the property.
- Gets the value for the AssignedPen property
+ Gets the value for the AssignedPen property.
- Value for the property
+ Value for the property.
- Gets the value for the AssignedFont property
+ Gets the value for the AssignedFont property.
- Value for the property
+ Value for the property.
- Gets the value for the WindowOrg property
+ Gets the value for the WindowOrg property.
- Value for the property
+ Value for the property.
- Sets the value for the WindowOrg property
+ Sets the value for the WindowOrg property.
- New value for the property
+ New value for the property.
- Sets the color for the pixel at the specified coordinates
+ Sets the color for the pixel at the specified coordinates.
- Horizontal pixel coordinate
+ Horizontal pixel coordinate.
- Vertical pixel coordinate
+ Vertical pixel coordinate.
- Color for the pixel
+ Color for the pixel.
- Creates the custom font used as the default for the canvas
+ Creates the custom font used as the default for the canvas.
DoCreateDefaultFont is an overridden TFPCustomFont function used to provide the default font for the canvas class instance. DoCreateDefaultFont implements the abstract virtual method defined in an ancestor class, and emulates the method defined in TCanvas.
@@ -328,13 +328,13 @@
- TFPCustomFont instance created and initialized in the method
+ TFPCustomFont instance created and initialized in the method.
- Adjusts the fcl-image coordinate system to be compatible with coordinates used in TCanvas
+ Adjusts the fcl-image coordinate system to be compatible with coordinates used in TCanvas.
@@ -349,12 +349,12 @@
- TRect with the bounds for the rectangular area
+ TRect with the bounds for the rectangular area.
- Adjusts the FCL image rectangle to be LCL compatible
+ Adjusts the FCL image rectangle to be LCL compatible.
Adjusts the fcl-image coordinate system to be compatible with coordinates used in TCanvas.
@@ -363,12 +363,12 @@
- Rectangle bounds adjusted in the method
+ Rectangle bounds adjusted in the method.
- Implements a polygon fill algorithm not present in fcl-image
+ Implements a polygon fill algorithm not present in fcl-image.
Implements a polygon fill algorithm not present in fcl-image. The algorithm is explained here.
@@ -377,30 +377,30 @@
- Array with the TPoint instances for the polygon corners
+ Array with the TPoint instances for the polygon corners.
- Draws a line using the specified coordinates and Pen for the canvas
+ Draws a line using the specified coordinates and Pen for the canvas.
- Initial horizontal coordinate for the line
+ Initial horizontal coordinate for the line.
- Initial vertical coordinate for the line
+ Initial vertical coordinate for the line.
- Terminal horizontal coordinate for the line
+ Terminal horizontal coordinate for the line.
- Terminal vertical coordinate for the line
+ Terminal vertical coordinate for the line.
- Copies a source rectangle to the specified canvas
+ Copies a source rectangle to the specified canvas.
@@ -418,7 +418,7 @@
- Draws the specified image at the given coordinates using AlphaBlending
+ Draws the specified image at the given coordinates using AlphaBlending.
@@ -434,7 +434,7 @@
- Indicates if a valid image was provided in the constructor
+ Indicates if a valid image was provided in the constructor.
HasNoImage is a Boolean member used to indicate if a valid TFPCustomImage was provided as an argument to the Create constructor. Used in the implementation of the UpdateControlLazImageAndCanvas routine for non-native custom drawn window controls.
@@ -447,7 +447,7 @@
- Native device context for the canvas
+ Native device context for the canvas.
NativeDC is a PtrInt member which contains the device context used to render a custom-drawn LCL control.
@@ -458,7 +458,7 @@
- Constructor for the class instance
+ Constructor for the class instance.
Create is the constructor for the class instance. Create calls the inherited constructor using AnImage as an argument.
@@ -472,12 +472,12 @@
- Screen image for the control rendered on the canvas
+ Screen image for the control rendered on the canvas.
- Destructor for the class instance
+ Destructor for the class instance.
Destroy is the overridden destructor for the class instance. Destroy ensures that resources allocated for GraphicStateList, AssignedBrush, and AssignedPen are freed. Destroy calls the inherited destructor prior to exiting from the method.
@@ -491,17 +491,17 @@
- Sets the value in the ClipRegion property
+ Sets the value in the ClipRegion property.
- Region stored in the property
+ Region stored in the property.
- Saves the current canvas state in the GraphicStateList member
+ Saves the current canvas state in the GraphicStateList member.
SaveState is an Integer function used to save the current canvas state in the GraphicStateList member. SaveState creates an instance of TLazCanvasState with copies of the current values for Brush, Pen, and Font. Values from BaseWindowOrg, WindowOrg, and Clipping are also assigned to the class instance.
@@ -524,23 +524,23 @@
- Ordinal position in GraphicStateList where the saved canvas state was stored
+ Ordinal position in GraphicStateList where the saved canvas state was stored.
- Restores the canvas to the state stored at the specified position
+ Restores the canvas to the state stored at the specified position.
- Ordinal position in GraphicStateList restored in the method
+ Ordinal position in GraphicStateList restored in the method.
- Sets the canvas to the default values/state used in the LCL TCanvas class
+ Sets the canvas to the default values/state used in the LCL TCanvas class.
@@ -548,7 +548,7 @@
- Performs an AlphaBlend operation using the specified source canvas
+ Performs an AlphaBlend operation using the specified source canvas.
@@ -608,7 +608,7 @@
- AlphaBlends the specified image onto the canvas
+ AlphaBlends the specified image onto the canvas.
@@ -635,7 +635,7 @@
- Calls DoDraw for the specified image and coordinates
+ Calls DoDraw for the specified image and coordinates.
@@ -651,7 +651,7 @@
- Copies the contents of a supported image format in ASource to the canvas
+ Copies the contents of a supported image format in ASource to the canvas.
@@ -680,7 +680,7 @@
- Fills the entire drawing area with the specified color
+ Fills the entire drawing area with the specified color.
Fills the entire drawing area with the specified color. AIgnoreClippingAndWindowOrg speeds up canvas drawing operations, but it is dangerous; don't use it unless you know what you are doing.
@@ -689,7 +689,7 @@
- Color applied to the canvas area
+ Color applied to the canvas area.
@@ -697,7 +697,7 @@
- Sets the Pen data for the canvas
+ Sets the Pen data for the canvas.
Utilized by LCLIntf.SelectObject and by the RestoreState method. This is needed because calling Assign for the Pen, Brush, or Font properties raises exceptions.
@@ -712,7 +712,7 @@
- Sets the Brush data for the canvas
+ Sets the Brush data for the canvas.
Utilized by LCLIntf.SelectObject and by the RestoreState method. This is needed because calling Assign for the Pen, Brush, or Font properties raises exceptions.
@@ -727,7 +727,7 @@
- Srts the Font data for the canvas
+ Srts the Font data for the canvas.
Utilized by LCLIntf.SelectObject and by the RestoreState method. This is needed because calling Assign for the Pen, Brush, or Font properties raises exceptions.
@@ -742,7 +742,7 @@
- Pen assigned to the canvas
+ Pen assigned to the canvas.
These properties are utilized to implement LCLIntf.SelectObject to keep track of which pen/brush/font handle was assigned to this canvas. They are not utilized by TLazCanvas itself.
@@ -753,7 +753,7 @@
- Brush assigned to the canvas
+ Brush assigned to the canvas.
These properties are used to implement LCLIntf.SelectObject to keep track of which pen/brush/font handle was assigned to this canvas. They are not utilized by TLazCanvas itself.
@@ -764,7 +764,7 @@
- Font assigned to the canvas
+ Font assigned to the canvas.
These properties are used to implement LCLIntf.SelectObject to keep track of which pen/brush/font handle was assigned to this canvas. They are not utilized by TLazCanvas itself.
@@ -775,7 +775,7 @@
- Base window origin for the canvas
+ Base window origin for the canvas.
The values in WindowOrg are relative to the coordinates in BaseWindowOrg. BaseWindowOrg coordinates are relative to the canvas for the containing Form. It is useful when implementing the non-native windowed controls.
@@ -785,14 +785,14 @@
- Clipping region for the canvas
+ Clipping region for the canvas.
- Window origin for the canvas
+ Window origin for the canvas.
Contains the absolute coordinates for the canvas with BaseWindowOrg summed up.