Wx::TipWindow

Shows simple text in a popup tip window on creation. This is used by SimpleHelpProvider to show popup help. The window automatically destroys itself when the user clicks on it or it loses the focus.

You may also use this class to emulate the tooltips when you need finer control over them than what the standard tooltips provide.

Derived from

PopupTransientWindow

PopupWindow\\ Window

EvtHandler

Object

TipWindow.new

TipWindow.new(Window parent,  String text, 
              Integer maxLength = 100, 
              TipWindow windowPtr)

Constructor. The tip is shown immediately the window is constructed.

Parameters

• parent The parent window, must be non NULL
• text The text to show, may contain the new line characters
• windowPtr Simply passed to set_tip_window_ptr below, please see its documentation for the description of this parameter
• rectBounds If non NULL, passed to set_bounding_rect below, please see its documentation for the description of this parameter

TipWindow#set_tip_window_ptr

set_tip_window_ptr(TipWindow windowPtr)

When the tip window closes itself (which may happen at any moment and unexpectedly to the caller) it may NULL out the pointer pointed to by windowPtr. This is helpful to avoid dereferencing the tip window which had been already closed and deleted.

TipWindow#set_bounding_rect

set_bounding_rect(Rect rectBound)

By default, the tip window disappears when the user clicks the mouse or presses a keyboard key or if it loses focus in any other way – for example because the user switched to another application window.

Additionally, if a non empty rectBound is provided, the tip window will also automatically close if the mouse leaves this area. This is useful to dismiss the tip mouse when the mouse leaves the object it is associated with.

Parameters

• rectBound The bounding rectangle for the mouse in the screen coordinates

[This page automatically generated from the Textile source at Thu May 01 00:50:47 +0100 2008]