FMX.StdCtrls.TCustomButton.MouseDown

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Single); override;

C++

virtual void __fastcall MouseDown(System::Uitypes::TMouseButton Button, System::Classes::TShiftState Shift, float X, float Y);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
FMX.StdCtrls.pas
FMX.StdCtrls.hpp
FMX.StdCtrls TCustomButton

Description

OnMouseDown event dispatcher.

FMX.StdCtrls.TCustomButton.MouseDown inherits from FMX.Controls.TControl.MouseDown. All content below this line refers to FMX.Controls.TControl.MouseDown.

OnMouseDown event dispatcher.

A control calls MouseDown in response to any of mouse-down messages, decoding the message parameters into the shift-key state and position, which it passes in the Shift, X, and Y parameters, respectively:

  • Button determines which mouse button is pressed: left, right, or middle.
  • Shift indicates which shift keys--SHIFT, CTRL, ALT, and CMD (only for Mac)--were down when the user pressed the mouse button.
  • X and Y are the pixel coordinates of the mouse pointer within the client area of the control. If Button is mbLeft, MouseDown sets PressedPosition as a TPointF(X,Y).

Override the protected MouseDown method to provide other responses when a mouse button is down while the cursor is over the control.


See Also