Sign in Join
FPDoc Onlineexperiment

TCustomTrayIcon.ShowBalloonHint procedure

Member of TCustomTrayIconpublicIn unit ExtCtrls

Displays a balloon hint window near the tray icon.

Declaration

pascal
procedure ShowBalloonHint

Description

ShowBalloonHint displays a small balloon-like window near the tray icon. It can be used to send notifications about the status of an action, or notify of a received message or any other event which doesn't require an immediate response.

The ShowBalloonHint method in the widgetset class is called to display the hint window. For platforms which do not provide native balloon hint support, an internal TPopupNotifier is used to display the values in BalloonTitle and BalloonHint. GetPosition is called to determine the coordinates for the balloon hint, and the ShowAtPos method in the pop-up notifier is called to display the values.

The balloon hint window disappears after the BalloonHintTimeout interval has elapsed, or when the user clicks on the close button for the balloon hint.

Native balloon hints are implemented for the Windows, QT4, and QT5 platforms. Other platforms use the pop-up notifier to emulate the capability.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.