Unit 'MUIClass.Area' Package
[Overview][Types][Classes][Procedures and functions][Index] [#MUIClass]

TMUIArea.CreateBubble

Create a MUI Bubble

Declaration

Source position: MUIClass.Area.pas line 123

public function TMUIArea.CreateBubble(

  x: Integer;

  y: Integer;

  Txt: string;

  Flags: Integer

):PBubble;

Arguments

x

  

window related x position to open the bubble

y

  

window related y position to open the bubble

Txt

  

Text to show inside the bubble

Flags

  

Flags for the bubble, see table

Function result

Bubble Handle use to close the bubble again with: DeleteBubble()

Description

Together with DeleteBubble(), this method provides an interface for MUIs bubble mechanism. Applications can use bubbles for their own purpose, e.g. for indicating error conditions on certain gadgets.

CreateBubble() creates a bubble at the specified coordinates with the specified (textual) contents. It returns a bubble "handle" that has to be passed to DeleteBubble() when the bubble shall disappear.

There's no limitation on the number of bubbles, you can create lots of them at a time if you wish. Also, these custom bubbles are completely independant of MUI's bubble help system and won't disappear automatically when the mouse is moved.

Note that bubbles will only show up when the object in question is visible. Otherwise CreateBubble() returns nil. You are responsible for deleting the bubble before the object get's invisible. Good place to remove a custom bubble is e.g. the Hide method of your object.

Defined flags:

MUIV_CreateBubble_DontHidePointer
prevents MUI from hiding the mouse pointer when displaying the help bubble. It is recommended that you always set this, unless your bubble is meant to disappear as soon as there is some user input.

See also

DeleteBubble()

  

Deletes a previously created Bubble

DeleteAllBubbles()

  

Delete all bubbles which are created with CreateBubble() for this object


Documentation generated on: 2021-06-18