AGW Logo

agw_title SuperToolTip

The main class for SuperToolTip, which holds all the methods and setters/getters available to the user.

hierarchy Inheritance Diagram

Inheritance diagram for: SuperToolTip

Inheritance diagram of SuperToolTip


subclasses Known Subclasses


appearance Control Appearance


SuperToolTip

SuperToolTip


method_summary Methods Summary

__init__Default class constructor.
ApplyStyleApplies none of the predefined styles.
DoShowNowCreate the SuperToolTip immediately.
EnableTipGlobally (application-wide) enables/disables SuperToolTip.
GetBodyImageReturns the main body bitmap used in SuperToolTip.
GetBottomGradientColorReturns the bottom gradient colour.
GetBottomGradientColourReturns the bottom gradient colour.
GetDrawFooterLineReturns whether the separator line before the footer is drawn or not.
GetDrawHeaderLineReturns whether the separator line after the header is drawn or not.
GetDropShadowReturns whether a shadow below SuperToolTip is drawn or not.
GetEndDelayReturns the delay time (in seconds) after which the SuperToolTip is destroyed.
GetFooterReturns the footer text.
GetFooterBitmapReturns the footer bitmap.
GetFooterFontReturns the font used for the footer text.
GetHeaderReturns the header text.
GetHeaderBitmapReturns the header bitmap.
GetHeaderFontReturns the font used for the header text.
GetHyperlinkFontReturns the font used for the hyperlink text.
GetMessageReturns the main body message in SuperToolTip.
GetMessageFontReturns the font used in the main body message.
GetMiddleGradientColorReturns the middle gradient colour.
GetMiddleGradientColourReturns the middle gradient colour.
GetStartDelayReturns the tim delay (in seconds) after which the SuperToolTip is created.
GetTargetReturns the target window for SuperToolTip.
GetTextColorReturns the text colour.
GetTextColourReturns the text colour.
GetTipWindowReturn the TipWindow, will return None if not yet created
GetTopGradientColorReturns the top gradient colour.
GetTopGradientColourReturns the top gradient colour.
GetUseFadeReturns whether a fade in/fade out effect is used or not.
InitFontInitalizes the fonts for SuperToolTip.
OnDestroyHandles the SuperToolTip target destruction.
OnEndTimerThe show time for SuperToolTip has expired, destroy the SuperToolTip.
OnStartTimerThe creation time has expired, create the SuperToolTip.
OnWidgetEnterStarts the SuperToolTip timer for creation, handles the wx.EVT_ENTER_WINDOW event.
OnWidgetLeaveHandles the wx.EVT_LEAVE_WINDOW event for the target widgets.
SetBodyImageSets the main body bitmap for SuperToolTip.
SetBottomGradientColorSets the bottom gradient colour for SuperToolTip.
SetBottomGradientColourSets the bottom gradient colour for SuperToolTip.
SetDrawFooterLineSets whether to draw a separator line before the footer or not.
SetDrawHeaderLineSets whether to draw a separator line after the header or not.
SetDropShadowWhether to draw a shadow below SuperToolTip or not.
SetEndDelaySets the delay time (in seconds) after which the SuperToolTip is destroyed.
SetFooterSets the footer text.
SetFooterBitmapSets the footer bitmap for SuperToolTip.
SetFooterFontSets the font for the footer text.
SetHeaderSets the header text.
SetHeaderBitmapSets the header bitmap for SuperToolTip.
SetHeaderFontSets the font for the header text.
SetHyperlinkFontSets the font for the hyperlink text.
SetMessageSets the main body message for SuperToolTip.
SetMessageFontSets the font for the main body message.
SetMiddleGradientColorSets the middle gradient colour for SuperToolTip.
SetMiddleGradientColourSets the middle gradient colour for SuperToolTip.
SetStartDelaySets the time delay (in seconds) after which the SuperToolTip is created.
SetTargetSets the target window for SuperToolTip.
SetTextColorSets the text colour for SuperToolTip.
SetTextColourSets the text colour for SuperToolTip.
SetTopGradientColorSets the top gradient colour for SuperToolTip.
SetTopGradientColourSets the top gradient colour for SuperToolTip.
SetUseFadeWhether to use a fade in/fade out effect or not.

API Class API

class SuperToolTip(object)[source]

The main class for SuperToolTip, which holds all the methods and setters/getters available to the user.



__init__(message, bodyImage=wx.NullBitmap, header="", headerBmp=wx.NullBitmap, footer="", footerBmp=wx.NullBitmap)[source]

Default class constructor.

Parameters:
  • message – the main message in SuperToolTip body;
  • bodyImage – the image in the SuperToolTip body;
  • header – the header text;
  • headerBmp – the header bitmap;
  • footer – the footer text;
  • footerBmp – the footer bitmap.


ApplyStyle(style)[source]

Applies none of the predefined styles.

Parameters:style – one of the predefined styles available at the beginning of the module.


DoShowNow()[source]

Create the SuperToolTip immediately.



EnableTip(enable=True)[source]

Globally (application-wide) enables/disables SuperToolTip.

Parameters:enableTrue to enable SuperToolTip globally, False otherwise.


GetBodyImage()[source]

Returns the main body bitmap used in SuperToolTip.



GetBottomGradientColor()

Returns the bottom gradient colour.



GetBottomGradientColour()[source]

Returns the bottom gradient colour.



GetDrawFooterLine()[source]

Returns whether the separator line before the footer is drawn or not.



GetDrawHeaderLine()[source]

Returns whether the separator line after the header is drawn or not.



GetDropShadow()[source]

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.



GetEndDelay()[source]

Returns the delay time (in seconds) after which the SuperToolTip is destroyed.



GetFooter()[source]

Returns the footer text.



GetFooterBitmap()[source]

Returns the footer bitmap.



GetFooterFont()[source]

Returns the font used for the footer text.



GetHeader()[source]

Returns the header text.



GetHeaderBitmap()[source]

Returns the header bitmap.



GetHeaderFont()[source]

Returns the font used for the header text.



GetHyperlinkFont()[source]

Returns the font used for the hyperlink text.



GetMessage()[source]

Returns the main body message in SuperToolTip.



GetMessageFont()[source]

Returns the font used in the main body message.



GetMiddleGradientColor()

Returns the middle gradient colour.



GetMiddleGradientColour()[source]

Returns the middle gradient colour.



GetStartDelay()[source]

Returns the tim delay (in seconds) after which the SuperToolTip is created.



GetTarget()[source]

Returns the target window for SuperToolTip.



GetTextColor()

Returns the text colour.



GetTextColour()[source]

Returns the text colour.



GetTipWindow()[source]

Return the TipWindow, will return None if not yet created



GetTopGradientColor()

Returns the top gradient colour.



GetTopGradientColour()[source]

Returns the top gradient colour.



GetUseFade()[source]

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.



InitFont()[source]

Initalizes the fonts for SuperToolTip.



OnDestroy(event)[source]

Handles the SuperToolTip target destruction.



OnEndTimer()[source]

The show time for SuperToolTip has expired, destroy the SuperToolTip.



OnStartTimer()[source]

The creation time has expired, create the SuperToolTip.



OnWidgetEnter(event)[source]

Starts the SuperToolTip timer for creation, handles the wx.EVT_ENTER_WINDOW event.

Parameters:event – a wx.MouseEvent event to be processed.


OnWidgetLeave(event)[source]

Handles the wx.EVT_LEAVE_WINDOW event for the target widgets.

Parameters:event – a wx.MouseEvent event to be processed.



SetBodyImage(bmp)[source]

Sets the main body bitmap for SuperToolTip.

Parameters:bmp – the body bitmap, a valid wx.Bitmap object.


SetBottomGradientColor(colour)

Sets the bottom gradient colour for SuperToolTip.

Parameters:colour – the colour to use as bottom colour, a valid wx.Colour object.


SetBottomGradientColour(colour)[source]

Sets the bottom gradient colour for SuperToolTip.

Parameters:colour – the colour to use as bottom colour, a valid wx.Colour object.



SetDrawFooterLine(draw)[source]

Sets whether to draw a separator line before the footer or not.

Parameters:drawTrue to draw a separator line before the footer, False otherwise.


SetDrawHeaderLine(draw)[source]

Sets whether to draw a separator line after the header or not.

Parameters:drawTrue to draw a separator line after the header, False otherwise.


SetDropShadow(drop)[source]

Whether to draw a shadow below SuperToolTip or not.

Parameters:dropTrue to drop a shadow below the control, False otherwise.

Note

This method is available only on Windows and requires Mark Hammond’s pywin32 package.



SetEndDelay(delay=1000000.0)[source]

Sets the delay time (in seconds) after which the SuperToolTip is destroyed.

Parameters:delay – the delay in seconds.


SetFooter(footer)[source]

Sets the footer text.

Parameters:footer – the footer text to display.


SetFooterBitmap(bmp)[source]

Sets the footer bitmap for SuperToolTip.

Parameters:bmp – the footer bitmap, a valid wx.Bitmap object.



SetFooterFont(font)[source]

Sets the font for the footer text.

Parameters:font – the font to use for the footer text, a valid wx.Font object.


SetHeader(header)[source]

Sets the header text.

Parameters:header – the header text to display.


SetHeaderBitmap(bmp)[source]

Sets the header bitmap for SuperToolTip.

Parameters:bmp – the header bitmap, a valid wx.Bitmap object.



SetHeaderFont(font)[source]

Sets the font for the header text.

Parameters:font – the font to use for the header text, a valid wx.Font object.



SetHyperlinkFont(font)[source]

Sets the font for the hyperlink text.

Parameters:font – the font to use for the hyperlink text, a valid wx.Font object.



SetMessage(message)[source]

Sets the main body message for SuperToolTip.

Parameters:message – the message to display in the body.


SetMessageFont(font)[source]

Sets the font for the main body message.

Parameters:font – the font to use for the main body message, a valid wx.Font object.



SetMiddleGradientColor(colour)

Sets the middle gradient colour for SuperToolTip.

Parameters:colour – the colour to use as middle colour, a valid wx.Colour object.



SetMiddleGradientColour(colour)[source]

Sets the middle gradient colour for SuperToolTip.

Parameters:colour – the colour to use as middle colour, a valid wx.Colour object.



SetStartDelay(delay=1)[source]

Sets the time delay (in seconds) after which the SuperToolTip is created.

Parameters:delay – the delay in seconds.


SetTarget(widget)[source]

Sets the target window for SuperToolTip.

Parameters:widget – the widget to which SuperToolTip is associated.


SetTextColor(colour)

Sets the text colour for SuperToolTip.

Parameters:colour – the colour to use as text colour, a valid wx.Colour object.



SetTextColour(colour)[source]

Sets the text colour for SuperToolTip.

Parameters:colour – the colour to use as text colour, a valid wx.Colour object.



SetTopGradientColor(colour)

Sets the top gradient colour for SuperToolTip.

Parameters:colour – the colour to use as top colour, a valid wx.Colour object.



SetTopGradientColour(colour)[source]

Sets the top gradient colour for SuperToolTip.

Parameters:colour – the colour to use as top colour, a valid wx.Colour object.



SetUseFade(fade)[source]

Whether to use a fade in/fade out effect or not.

Parameters:fadeTrue to use a fade in/fade out effect, False otherwise.

Note

This method is available only on Windows and requires Mark Hammond’s pywin32 package.

Tree

Table Of Contents

Previous topic

supertooltip

Next topic

ToolTipWindow