The main class for SuperToolTip, which holds all the methods and setters/getters available to the user.
__init__ | Default class constructor. |
ApplyStyle | Applies none of the predefined styles. |
DoShowNow | Create the SuperToolTip immediately. |
EnableTip | Globally (application-wide) enables/disables SuperToolTip. |
GetBodyImage | Returns the main body bitmap used in SuperToolTip. |
GetBottomGradientColor | Returns the bottom gradient colour. |
GetBottomGradientColour | Returns the bottom gradient colour. |
GetDrawFooterLine | Returns whether the separator line before the footer is drawn or not. |
GetDrawHeaderLine | Returns whether the separator line after the header is drawn or not. |
GetDropShadow | Returns whether a shadow below SuperToolTip is drawn or not. |
GetEndDelay | Returns the delay time (in seconds) after which the SuperToolTip is destroyed. |
GetFooter | Returns the footer text. |
GetFooterBitmap | Returns the footer bitmap. |
GetFooterFont | Returns the font used for the footer text. |
GetHeader | Returns the header text. |
GetHeaderBitmap | Returns the header bitmap. |
GetHeaderFont | Returns the font used for the header text. |
GetHyperlinkFont | Returns the font used for the hyperlink text. |
GetMessage | Returns the main body message in SuperToolTip. |
GetMessageFont | Returns the font used in the main body message. |
GetMiddleGradientColor | Returns the middle gradient colour. |
GetMiddleGradientColour | Returns the middle gradient colour. |
GetStartDelay | Returns the tim delay (in seconds) after which the SuperToolTip is created. |
GetTarget | Returns the target window for SuperToolTip. |
GetTextColor | Returns the text colour. |
GetTextColour | Returns the text colour. |
GetTipWindow | Return the TipWindow, will return None if not yet created |
GetTopGradientColor | Returns the top gradient colour. |
GetTopGradientColour | Returns the top gradient colour. |
GetUseFade | Returns whether a fade in/fade out effect is used or not. |
InitFont | Initalizes the fonts for SuperToolTip. |
OnDestroy | Handles the SuperToolTip target destruction. |
OnEndTimer | The show time for SuperToolTip has expired, destroy the SuperToolTip. |
OnStartTimer | The creation time has expired, create the SuperToolTip. |
OnWidgetEnter | Starts the SuperToolTip timer for creation, handles the wx.EVT_ENTER_WINDOW event. |
OnWidgetLeave | Handles the wx.EVT_LEAVE_WINDOW event for the target widgets. |
SetBodyImage | Sets the main body bitmap for SuperToolTip. |
SetBottomGradientColor | Sets the bottom gradient colour for SuperToolTip. |
SetBottomGradientColour | Sets the bottom gradient colour for SuperToolTip. |
SetDrawFooterLine | Sets whether to draw a separator line before the footer or not. |
SetDrawHeaderLine | Sets whether to draw a separator line after the header or not. |
SetDropShadow | Whether to draw a shadow below SuperToolTip or not. |
SetEndDelay | Sets the delay time (in seconds) after which the SuperToolTip is destroyed. |
SetFooter | Sets the footer text. |
SetFooterBitmap | Sets the footer bitmap for SuperToolTip. |
SetFooterFont | Sets the font for the footer text. |
SetHeader | Sets the header text. |
SetHeaderBitmap | Sets the header bitmap for SuperToolTip. |
SetHeaderFont | Sets the font for the header text. |
SetHyperlinkFont | Sets the font for the hyperlink text. |
SetMessage | Sets the main body message for SuperToolTip. |
SetMessageFont | Sets the font for the main body message. |
SetMiddleGradientColor | Sets the middle gradient colour for SuperToolTip. |
SetMiddleGradientColour | Sets the middle gradient colour for SuperToolTip. |
SetStartDelay | Sets the time delay (in seconds) after which the SuperToolTip is created. |
SetTarget | Sets the target window for SuperToolTip. |
SetTextColor | Sets the text colour for SuperToolTip. |
SetTextColour | Sets the text colour for SuperToolTip. |
SetTopGradientColor | Sets the top gradient colour for SuperToolTip. |
SetTopGradientColour | Sets the top gradient colour for SuperToolTip. |
SetUseFade | Whether to use a fade in/fade out effect or not. |
The main class for SuperToolTip, which holds all the methods and setters/getters available to the user.
Default class constructor.
Parameters: |
|
---|
Applies none of the predefined styles.
Parameters: | style – one of the predefined styles available at the beginning of the module. |
---|
Create the SuperToolTip immediately.
Globally (application-wide) enables/disables SuperToolTip.
Parameters: | enable – True to enable SuperToolTip globally, False otherwise. |
---|
Returns the main body bitmap used in SuperToolTip.
Returns the bottom gradient colour.
Returns whether the separator line before the footer is drawn or not.
Returns whether a shadow below SuperToolTip is drawn or not.
Note
This method is available only on Windows and requires Mark Hammond’s pywin32 package.
Returns the delay time (in seconds) after which the SuperToolTip is destroyed.
Returns the footer text.
Returns the footer bitmap.
Returns the font used for the footer text.
Returns the main body message in SuperToolTip.
Returns the middle gradient colour.
Returns the tim delay (in seconds) after which the SuperToolTip is created.
Returns the target window for SuperToolTip.
Returns the text colour.
Returns the top gradient colour.
Returns whether a fade in/fade out effect is used or not.
Note
This method is available only on Windows and requires Mark Hammond’s pywin32 package.
Initalizes the fonts for SuperToolTip.
Handles the SuperToolTip target destruction.
The show time for SuperToolTip has expired, destroy the SuperToolTip.
The creation time has expired, create the SuperToolTip.
Starts the SuperToolTip timer for creation, handles the wx.EVT_ENTER_WINDOW event.
Parameters: | event – a wx.MouseEvent event to be processed. |
---|
Handles the wx.EVT_LEAVE_WINDOW event for the target widgets.
Parameters: | event – a wx.MouseEvent event to be processed. |
---|
Sets the main body bitmap for SuperToolTip.
Parameters: | bmp – the body bitmap, a valid wx.Bitmap object. |
---|
Sets the bottom gradient colour for SuperToolTip.
Parameters: | colour – the colour to use as bottom colour, a valid wx.Colour object. |
---|
Sets the bottom gradient colour for SuperToolTip.
Parameters: | colour – the colour to use as bottom colour, a valid wx.Colour object. |
---|
Sets whether to draw a separator line before the footer or not.
Parameters: | draw – True to draw a separator line before the footer, False otherwise. |
---|
Sets whether to draw a separator line after the header or not.
Parameters: | draw – True to draw a separator line after the header, False otherwise. |
---|
Whether to draw a shadow below SuperToolTip or not.
Parameters: | drop – True to drop a shadow below the control, False otherwise. |
---|
Note
This method is available only on Windows and requires Mark Hammond’s pywin32 package.
Sets the delay time (in seconds) after which the SuperToolTip is destroyed.
Parameters: | delay – the delay in seconds. |
---|
Sets the footer text.
Parameters: | footer – the footer text to display. |
---|
Sets the footer bitmap for SuperToolTip.
Parameters: | bmp – the footer bitmap, a valid wx.Bitmap object. |
---|
Sets the font for the footer text.
Parameters: | font – the font to use for the footer text, a valid wx.Font object. |
---|
Sets the header bitmap for SuperToolTip.
Parameters: | bmp – the header bitmap, a valid wx.Bitmap object. |
---|
Sets the font for the header text.
Parameters: | font – the font to use for the header text, a valid wx.Font object. |
---|
Sets the font for the hyperlink text.
Parameters: | font – the font to use for the hyperlink text, a valid wx.Font object. |
---|
Sets the main body message for SuperToolTip.
Parameters: | message – the message to display in the body. |
---|
Sets the font for the main body message.
Parameters: | font – the font to use for the main body message, a valid wx.Font object. |
---|
Sets the middle gradient colour for SuperToolTip.
Parameters: | colour – the colour to use as middle colour, a valid wx.Colour object. |
---|
Sets the middle gradient colour for SuperToolTip.
Parameters: | colour – the colour to use as middle colour, a valid wx.Colour object. |
---|
Sets the time delay (in seconds) after which the SuperToolTip is created.
Parameters: | delay – the delay in seconds. |
---|
Sets the target window for SuperToolTip.
Parameters: | widget – the widget to which SuperToolTip is associated. |
---|
Sets the text colour for SuperToolTip.
Parameters: | colour – the colour to use as text colour, a valid wx.Colour object. |
---|
Sets the text colour for SuperToolTip.
Parameters: | colour – the colour to use as text colour, a valid wx.Colour object. |
---|
Sets the top gradient colour for SuperToolTip.
Parameters: | colour – the colour to use as top colour, a valid wx.Colour object. |
---|
Sets the top gradient colour for SuperToolTip.
Parameters: | colour – the colour to use as top colour, a valid wx.Colour object. |
---|