diff --git a/docs/xml/lcl/comctrls.xml b/docs/xml/lcl/comctrls.xml index a20542b2de..e0cd4760d1 100644 --- a/docs/xml/lcl/comctrls.xml +++ b/docs/xml/lcl/comctrls.xml @@ -280,11 +280,14 @@ - - + + + GetDisplayName - looks first at the Text property; if it is blank calls inherited method - + + TCollectionItem.GetDisplayName + @@ -303,11 +306,14 @@ - - + + + SetIndex saves the old index value, checks that the supplied value is different then calls inherited method - + + TCollectionItem.SetIndex + @@ -338,11 +344,14 @@ - - + + + Assign copies text, width, alignment, bevel and style properties from Source if it is of correct type, otherwise calls inherited Assign (which will probably raise an exception) - + + TPersistent.Assign + @@ -438,11 +447,14 @@ - - + + + GetOwner returns a Status Bar, overriding the inherited method - + + TPersistent.GetOwner + @@ -601,25 +613,34 @@ - - + + + CreateWnd calls inherited method, then fixes handles if needed - + + TWinControl.CreateWnd + - - + + + DestroyWnd calls inherited method and frees handles - + + TWinControl.DestroyWnd + - - + + + Loaded calls inherited method and fixes handles if needed - + + TWinControl.Loaded + @@ -636,7 +657,7 @@ - Create - constructor for TStatusBar: calls inherited Create and initialises a number of local variables + Create - constructor for TStatusBar: calls inherited Create and initialises a number of local variables

Create - constructor for TStatusBar: calls inherited Create and initialises a number of local variables

@@ -1236,12 +1257,11 @@

If GoForward is True, goes to next (higher index) page;

if False, goes to previous (lower index)

-

If CheckTabVisible is True, will only move if the tab is visible

 - SelectNextPage - checking that its tab is visible + SelectNextPage - goes to next page and selects it @@ -1249,8 +1269,13 @@ - - + + SelectNextPage - checking that its tab is visible + +

If GoForward is True, goes to next (higher index) page;

+

if False, goes to previous (lower index)

+

If CheckTabVisible is True, will only move if the tab is visible

+ @@ -1799,18 +1824,24 @@ - - + + + BeginUpdate increments the Update count - + + TStrings.BeginUpdate + - - + + + EndUpdate decrements the Update count - - + An exception is raised if the Update count is zero + + TStrings.EndUpdate + @@ -1917,11 +1948,14 @@ - - + + + Get returns the text string found on the indexed page - + + TStrings.Get + @@ -1943,11 +1977,14 @@ - - + + + GetObject returns the indexed object from the paged notebook - + + TStrings.GetObject + @@ -2017,11 +2054,14 @@ - - + + + Put writes the supplied string to the indexed page of the notebook - + + TStrings.Put + @@ -2032,11 +2072,14 @@ - - + + + PutObject stores the supplied object at the indexed place in the paged notebook - + + TStrings.PutObject + @@ -2047,10 +2090,14 @@ - + - + + TTabControlStrings.SetImages + + + SetImages - if the supplied ImageList is of correct type, stores it in the notebook Images area @@ -2067,33 +2114,43 @@ - - + + + SetUpdateState - if Updating is True, calls BeginUpdate; otherwise calls EndUpdate + - + + TStrings.SetUpdateState + - - + + + SetTabHeight checks if TabHeight is already equal to AValue, otherwise calls inherited method - + + TTabControlStrings.SetTabHeight + - - + + + SetTabWidth checks if TabWidth is already equal to AValue, otherwise calls inherited method - + + TTabControlStrings.SetTabWidth + @@ -2131,29 +2188,38 @@ - - + + + Clear calls the Clear method for the client Notebook - + + TStrings.Clear + - - + + + Delete calls the Delete method for the client NoteBook - + + TStrings.Delete + - - + + + Insert calls the Insert method for the client NoteBok - + + TStrings.Insert + @@ -2625,7 +2691,7 @@ - + @@ -2646,7 +2712,7 @@ - + @@ -3541,8 +3607,8 @@ Most properties are inherited from ancestors, TPersistent and TObject - - + Classes.TPersistent + Objects.TObject @@ -3755,31 +3821,41 @@ - + - + TPersistent.Assign + + Assign - if source has correct type, copies Caption, Data, ImageIndex and SubItems from source, otherwise calls inherited Assign which probably raises an exception - + - + + TObject.Create + + + Create - constructor for TListItem: calls inherited Create then initialises flags, states, ImageIndex and SubItems - - + + + Destroy - destructor for TListItem: frees SubItems, sets flags to signify destruction, then calls inherited Destroy + - + + TPersistent.Destroy + @@ -3947,11 +4023,14 @@ - - + + + DefineProperties - calls inherited method, then defines some specific binary properties - + + TPersistent.DefineProperties + @@ -4058,21 +4137,29 @@ - + - + + TObject.Create + + + Create - constructor for TListItems: calls inherited Create then creates the list - - + + + Destroy destructor for TListItems: frees the individual items on the list, then calls inherited Destroy + - + + TPersistent.Destroy + @@ -4344,22 +4431,28 @@ - - + + + SetIndex - calls inherited method, and if this is a new index value, changes to the new column index - + + TCollectionItem.SetIndex + - - + + + GetDisplayName returns the Caption; if this is blank, calls inherited method - + + TCollectionItem.GetDisplayName + @@ -4391,11 +4484,14 @@ - - + + + Assign - if source is of correct type, copies alignment, caption, visibility and size properties, otherwise calls inherited Assign which probably raises an exception - + + TPersistent.Assign + @@ -4531,29 +4627,39 @@ - - + + + Create - constructor for TListColumns: sets ownership then calls inherited Create + - + + TCollection.Create + - - + + + Destroy - destructor for TListColumns: calls inherited destructor - + + TCollection.Destroy + - - + + + Add calls inherited method, then adjusts state flags - + + TCollection.Add + @@ -4590,11 +4696,14 @@ - - + + + Assign checks that source is of correct type, then adds new columns and copies items from source into them; otherwise calls inherited Assign which probably raises an exception - + + TCollection.Assign + @@ -5488,11 +5597,15 @@ - - - + + + InitializeWnd - calls inherited method, then sets various local properties + + InitializeWnd - calls inherited method, then sets style, adds columns, sets imagelists and item depending properties (scroll bars, sorting etc), adds items and sets other miscellaneous properties (default item height, hot track styles, hover time etc) - + + TWinControl.InitializeWnd + @@ -6445,18 +6558,24 @@ - - + + + InitializeWnd calls inherited method then applies changes - + + TWinControl.InitializeWnd + - - + + + Loaded calls inherited method then applies changes - + + TWinControl.Loaded + @@ -7155,11 +7274,14 @@ - - + + + Notification calls inherited method; if the operation requires removal of the associate control, this is performed - + + TControl.Notification + @@ -7170,11 +7292,14 @@ - - + + + Click - calls OnClick event handler if it is assigned - + + TControl.Click + @@ -7557,11 +7682,14 @@ - - + + + AssignClient calls inherited method then sets client as ToolButton - + + TBasicActionLink.AssignClient + @@ -7937,7 +8065,9 @@ GetActionLinkClass - returns the Class of the ActionLink for this ToolButton - + + TControl.GetActionLinkClass + @@ -7949,7 +8079,9 @@ ActionChange - a method for changing the action associated with the Button - + + TControl.ActionChange + @@ -7960,11 +8092,15 @@ - - + + + AssignTo calls inherited method: if the destination is of correct type, copies ImageIindex to destination and sets it Checked - + + TPersistent.AssignTo + TControl.AssignTo + @@ -8088,11 +8224,12 @@ - - + - + + TComponent.Loaded + @@ -8967,14 +9104,14 @@ - + - + @@ -9059,6 +9196,7 @@ TComponent.Destroy + TCustomControl.Destroy @@ -9800,7 +9938,7 @@ - + @@ -9814,6 +9952,7 @@ TComponent.Create + TWinControl.Create @@ -11468,11 +11607,14 @@ Const - - + + + Assign - if Source is of correct type, copies details directly, otherwise calls inherited Assign which probably raises an exception - + + TPersistent.Assign + @@ -12657,22 +12799,30 @@ the comparision is case sensitive. - - + + + Create - constructor for TTreeNodes: calls inherited Create + - + + TObject.Create + - - + + + Destroy - destructor for TTreeNodes: calls inherited Destroy + - + + TPersistent.Destroy + @@ -12851,11 +13001,14 @@ the comparision is case sensitive. - - + + + Assign - if Source is of correct type, copies properties directly, otherwise calls inherited Assign which probably raises an exception - + + TPersistent.Assign + @@ -14918,7 +15071,7 @@ the comparision is case sensitive. - + @@ -14990,7 +15143,7 @@ the comparision is case sensitive. - + @@ -16653,7 +16806,13 @@ the comparision is case sensitive. TCollectionItem.Create - + + + Assign - if Source is of correct type, copies properties directly, otherwise calls inherited Assign which probably raises an exception + + TPersistent.Assign + + The position of the left boundary of the section @@ -16688,7 +16847,13 @@ the comparision is case sensitive. OriginalIndex - index which doesn't change when the user reorders the sections - + + + Update checks if update is in fact required, then calls inherited method + + TCollection.Update + + @@ -16708,7 +16873,7 @@ the comparision is case sensitive. OnCreateSectionClass - event handler for creating a new section class - + ToolTips - whether Popup tool tips are to be shown @@ -16735,12 +16900,42 @@ the comparision is case sensitive. GetItemAt - find and return the list item at the specified coordinates - - - + + + GetControlClassDefaultSize returns its own defaults, overriding inherited values + + TControl.GetControlClassDefaultSize + + + + + GetControlClassDefaultSize returns its own defaults, overriding inherited values + + TControl.GetControlClassDefaultSize + + + + + GetControlClassDefaultSize - returns its own defaults, overriding the inherited values + + TControl.GetControlClassDefaultSize + + - - + + + GetControlClassDefaultSize returns its own defaults, overriding inherited values + + TControl.GetControlClassDefaultSize + + + + + GetOwner returns a HeaderControl, overriding inherited value + + TPersistent.GetOwner + + @@ -16789,7 +16984,13 @@ the comparision is case sensitive. - + + + CalculatePreferredSize calls inherited method then supplies its own values if any are missing + + TControl.CalculatePreferredSize + + @@ -16809,9 +17010,15 @@ the comparision is case sensitive. - DoHint - shows the hint and returns True if successful + DoHint - shows the hint and returns True if successful (uses OnHint event handler) + + + + ExecuteAction: if required action is a Hint-related, sets the Hint in place, otherwise calls inherited method + + TComponent.ExecuteAction + - SizeGripEnabled - returns True if the size-grip (an area at the bottom of the statusbar where a mouse can grip to change the size) is enabled @@ -16854,10 +17061,30 @@ the comparision is case sensitive. - - + + Client cannot be added to TPageControl itself but new TabSheet should be added and client placed onto it + + + DoAddDockClient creates a new TabSheet in the PageControl, places the client on it and aligns it + + TWinControl.DoAddDockClient + + + + + DoRemoveDockClient - frees the page which is being undocked + + TWinControl.DoRemoveDockClient + + - + + + PositionDockRect converts client coordinates to screen coordinates, then places the docking rectangle at the calculated position + + TControl.PositionDockRect + + DisplayRect - returns the coordinates of a rectangle for displaying the current item @@ -16882,11 +17109,23 @@ the comparision is case sensitive. WSCreateItems - instruction to the Widget Set to create Items - + + + FinalizeWnd stores the list origin then calls inherited method + + TWinControl.FinalizeWnd + + - + + + GetControlClassDefaultSize returns its own defaults, overriding inherited values + + TControl.GetControlClassDefaultSize + + GetButtonDrawDetail - find theme information for Windows XP inplementations @@ -16897,7 +17136,13 @@ the comparision is case sensitive. - + + + GetControlClassDefaultSize - returns its own defaults, overriding the inherited values + + Control.GetControlClassDefaultSize + + @@ -16974,7 +17219,13 @@ the comparision is case sensitive. UpdateState - bring the state of the control up-to-date - + + + GetControlClassDefaultSize - returns its own defaults, overriding inherited values + + TControl.GetControlClassDefaultSize + + DoDragMsg generates system message to indicate object and position for dragging and returns Result of action @@ -17164,6 +17415,18 @@ the comparision is case sensitive. TCustomHCCreateSectionClassEvent - generic event handler method for custom creation of header control + + + DrawPanel calls the OnDrawPanel event handler if assigned + + + + LMDrawItem - LCL message handler for drawing the item on the current canvas + + + + +