Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.ToolTipManager Class Reference

Tracks desktop mouse pointer events to display tool tips. More...

Inheritance diagram for Dragengine.Gui.ToolTipManager:

Classes

class  ListenMousePointer
 

Public Member Functions

void dispose ()
 Dispose of tool tip manager. More...
 
Desktop getDesktop ()
 Desktop to listen on. More...
 
WindowToolTip getPopup ()
 Popup window. More...
 
Object getToolTip ()
 Shown tool tip or null. More...
 
ToolTipManager new (Desktop desktop)
 Create tool tip manager. More...
 
void onToolTipChanged ()
 Tool tip changed. More...
 
void update ()
 Update tool tip. More...
 

Public Attributes

Desktop pDesktop
 
WindowToolTip pPopup
 
Object pToolTip
 

Protected Member Functions

Point calculateToolTipPosition ()
 Calculate position to show tool tip at. More...
 
void setPopup (WindowToolTip popup)
 Set popup window. More...
 
void setToolTip (Object toolTip)
 Set tool tip to show or null. More...
 
void updatePopup ()
 Update popup window content. More...
 

Detailed Description

Tracks desktop mouse pointer events to display tool tips.

Version
1.7

Supports tool tips of type String and StyledTextDocument

Member Function Documentation

◆ calculateToolTipPosition()

Point Dragengine.Gui.ToolTipManager.calculateToolTipPosition ( )
protected

Calculate position to show tool tip at.

Position is located at lower left corner of mouse pointer. If mouse pointer is null the mouse pointer size is considered to be 0

◆ dispose()

void Dragengine.Gui.ToolTipManager.dispose ( )

Dispose of tool tip manager.

◆ getDesktop()

Desktop Dragengine.Gui.ToolTipManager.getDesktop ( )

Desktop to listen on.

◆ getPopup()

WindowToolTip Dragengine.Gui.ToolTipManager.getPopup ( )

Popup window.

◆ getToolTip()

Object Dragengine.Gui.ToolTipManager.getToolTip ( )

Shown tool tip or null.

◆ new()

ToolTipManager Dragengine.Gui.ToolTipManager.new ( Desktop  desktop)

Create tool tip manager.

Parameters
desktopDesktop widget to listen on.

◆ onToolTipChanged()

void Dragengine.Gui.ToolTipManager.onToolTipChanged ( )

Tool tip changed.

Version
1.14

◆ setPopup()

void Dragengine.Gui.ToolTipManager.setPopup ( WindowToolTip  popup)
protected

Set popup window.

Disposes of the previous popup window if present.

◆ setToolTip()

void Dragengine.Gui.ToolTipManager.setToolTip ( Object  toolTip)
protected

Set tool tip to show or null.

◆ update()

void Dragengine.Gui.ToolTipManager.update ( )

Update tool tip.

◆ updatePopup()

void Dragengine.Gui.ToolTipManager.updatePopup ( )
protected

Update popup window content.

Member Data Documentation

◆ pDesktop

Desktop Dragengine.Gui.ToolTipManager.pDesktop

◆ pPopup

WindowToolTip Dragengine.Gui.ToolTipManager.pPopup

◆ pToolTip

Object Dragengine.Gui.ToolTipManager.pToolTip

The documentation for this class was generated from the following file: