diff --git a/docs/xml/lcl/buttons.xml b/docs/xml/lcl/buttons.xml index 8df0b4c335..c0952656e4 100644 --- a/docs/xml/lcl/buttons.xml +++ b/docs/xml/lcl/buttons.xml @@ -20,7 +20,7 @@ in the Lazarus IDE component palette:
  • TSpeedButton

    • -buttons.pp is part of the LCL (Lazarus Component Library). +buttons.pp is part of the Lazarus Component Library (LCL).

    @@ -558,10 +558,11 @@ notification, and normally receives a reference to the current TButtonGlyph class instance.

    -GlyphChanged ensures that the internal ImagesCache member is set to Nil, and -the ClearImages methods is called to remove images stored in the Images -property. When CanShow returns True, the internal ImagesCache member -is re-populated and registered to listen for changes to the Glyph property. +GlyphChanged ensures that the internal ImagesCache member is set to +Nil, and the ClearImages methods is called to remove images stored in +the Images property. When CanShow returns True, the internal +ImagesCache member is re-populated and registered to listen for changes to +the Glyph property.

    GlyphChanged is assigned to the OnChange event handler when the class @@ -730,22 +731,30 @@ specified button State. - +Drawing state for the button glyph. - + +Pixels per inch for the image resolution with the button glyphs. + - +Canvas scaling factor applied to the image resolution. - +Returns the scaled image resolution with the button glyphs. - + +Returns the index for the glyph image selected from Images or LCL glyph +resources + - + +Returns the drawing effect needed for the glyph image with the specified +state. + @@ -1722,7 +1731,7 @@ updated. Value for the ImageIndex property. - +Drawing state for the requested button glyph. @@ -1736,7 +1745,7 @@ updated. New value for the ImageIndex property. - +Identifies the drawing State for the specified image index. @@ -1793,8 +1802,8 @@ when a new value is assigned to the Action property, or when the control is loaded using LCL component streaming.

    -Sender is the new action instance for the event, or Nil when the value in -Action has been removed (set to Nil). +Sender is the new action instance for the event, or Nil when the value +in Action has been removed (set to Nil).

    CheckDefaults indicates whether existing properties values in the control are @@ -1922,9 +1931,7 @@ value has been assigned for the Caption property. - - - + Handles the CM_APPSHOWBTNGLYPHCHANGED message for the control. @@ -2671,20 +2678,35 @@ visibility for a control in its parent container. - - - + -SetGroupIndex - stores the value of the index within the list of -links. +Sets the group index for the speed button in the action link. - - + +

    +SetGroupIndex is an overridden method in +TSpeedButtonActionLink. It implements the empty virtual method +from the ancestor class. SetGroupIndex call IsGroupIndexLinked to determine +if the action link has an assigned speed button instance. When assigned, the +GroupIndex property in the client control is set to Value. +

    +

    +SetGroupIndex is called when a TCustomAction instance notifies each of its +client controls of a new value for the group index property in the class +instance. +

    + + +TCustomAction.GroupIndex +TCustomActionList + - + +New value for the group index in the linked speed button. + @@ -2732,14 +2754,10 @@ Ordinal position for the image selected in the speed button control. - - - + - - - + @@ -2822,11 +2840,22 @@ Selected, Disabled). Performs actions needed when the value in Images is changed. - - + +

    +ImageListChange implements a handler routine assigned to the +OnChange event handler in the internal image change link for the speed +button. It is assigned in the Create method when the TChangeLink is created +for the control. +

    +     + + + +TChangeLink.OnChange +     - +Object for the event notification. @@ -2960,12 +2989,26 @@ have the same GroupIndex value. -Handles the Control message passed when the control is enabled. - - + +Handles the Control message passed when the Enabled state is changed. + + +

    +CMEnabledChanged is a method used to handle the CM_ENABLEDCHANGED +control message. It re-implements the method from the ancestor class, and +does not call the inherited method. CMEnabledChanged calls UpdateState to +(re-)create the glyph using the new state for the speed button and to +invalidate the drawing area for the control. +

    +     + + + +TControl.CMEnabledChanged +     - +Message handled in the method. @@ -3010,7 +3053,7 @@ have the same GroupIndex value. Value for the property. - +Drawing state for the requested glyph image. @@ -3021,7 +3064,7 @@ have the same GroupIndex value. - +Drawing state for the specified glyph image. New value for the property. @@ -3083,8 +3126,19 @@ Internal member used to store the TButtonState for the control. Performs actions needed when the value in the Glyph property has been changed. - - + +

    +GlyphChanged implements the handler routine used for the OnChange +event handler in the Glyph for the control. It is assigned in the Create +constructor. GlyphChanged calls Invalidate to request the control to be +redrawn when the glyph image is updated. +

    +     + + + +TControl.Invalidate +     TObject instance for the change notification. @@ -3131,16 +3185,25 @@ Used in the implementation of the CalculatePreferredSize and Paint methods. - + +True if the background and content for the control are drawn. +False to calculate the preferred width and height only. + - + +Drawing area on the canvas where the content is positioned. + - + +Returns the preferred width calculated for the control. + - + +Returns the preferred height calculated for the control. + @@ -3398,7 +3461,6 @@ whether or not button was pressed) -

    Used by SetTextBuf to store a text string rather than performing read/write @@ -3527,8 +3589,8 @@ OnChange event handler for the ActionLink in the control. It is signalled the control is loaded using LCL component streaming.

    -Sender is the new action instance for the event, or Nil when the value in -Action has been removed (set to Nil). +Sender is the new action instance for the event, or Nil when the value +in Action has been removed (set to Nil).

    CheckDefaults indicates whether existing properties values in the control are @@ -3559,9 +3621,7 @@ properties from the new action. - - - + @@ -3795,10 +3855,14 @@ instance. - + +Handle for the resource with the specified glyph. + - + +Name of the glyph image resource loaded for the control. + @@ -3810,7 +3874,9 @@ Lazarus Resource file (.lrs). - + +Name of the glyph image loaded from the Lazarus resource. + @@ -4775,10 +4841,14 @@ GetButtonIcon is used in the implementation of the - + +Bitmap instance with the glyph for the specified button. + - + +Numeric button identifier for the glyph loaded in the routine. + @@ -4895,8 +4965,9 @@ method in TCustomBitBtn. Registers components for use in the Lazarus IDE.

    -Register is the procedure used to register components for use in the Lazarus -IDE. The following components are added to the Lazarus IDE component palette: +Register is the procedure used to register components for use in +the Lazarus IDE. The following components are added to the Lazarus IDE +component palette:

    Additional Tab