Module SuperToolTip :: Class SuperToolTip
[hide private]
[frames] | no frames]

Class SuperToolTip

source code

object --+
         |
        SuperToolTip

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

Instance Methods [hide private]
 
__init__(self, message, bodyImage=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap *' at..., header='', headerBmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap *' at..., footer='', footerBmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap *' at...)
Default class constructor.
source code
 
SetTarget(self, widget)
Sets the target window for SuperToolTip.
source code
 
GetTarget(self)
Returns the target window for SuperToolTip.
source code
 
SetStartDelay(self, delay=1)
Sets the time delay (in seconds) after which the SuperToolTip is created.
source code
 
GetStartDelay(self)
Returns the tim delay (in seconds) after which the SuperToolTip is created.
source code
 
SetEndDelay(self, delay=1000000.0)
Sets the delay time (in seconds) after which the SuperToolTip is destroyed.
source code
 
GetEndDelay(self)
Returns the delay time (in seconds) after which the SuperToolTip is destroyed.
source code
 
OnWidgetEnter(self, event)
Starts the SuperToolTip timer for creation, handles the wx.EVT_ENTER_WINDOW event.
source code
 
OnWidgetLeave(self, event)
Handles the wx.EVT_LEAVE_WINDOW for the target widgets.
source code
 
OnStartTimer(self)
The creation time has expired, create the SuperToolTip.
source code
 
OnEndTimer(self)
The show time for SuperToolTip has expired, destroy the SuperToolTip.
source code
 
OnDestroy(self, event)
Handles the SuperToolTip target destruction.
source code
 
SetHeaderBitmap(self, bmp)
Sets the header bitmap for SuperToolTip.
source code
 
GetHeaderBitmap(self)
Returns the header bitmap.
source code
 
SetHeader(self, header)
Sets the header text.
source code
 
GetHeader(self)
Returns the header text.
source code
 
SetDrawHeaderLine(self, draw)
Whether to draw a separator line after the header or not.
source code
 
GetDrawHeaderLine(self)
Returns whether the separator line after the header is drawn or not.
source code
 
SetBodyImage(self, bmp)
Sets the main body bitmap for SuperToolTip.
source code
 
GetBodyImage(self)
Returns the main body bitmap used in SuperToolTip.
source code
 
SetDrawFooterLine(self, draw)
Whether to draw a separator line before the footer or not.
source code
 
GetDrawFooterLine(self)
Returns whether the separator line before the footer is drawn or not.
source code
 
SetFooterBitmap(self, bmp)
Sets the footer bitmap for SuperToolTip.
source code
 
GetFooterBitmap(self)
Returns the footer bitmap.
source code
 
SetFooter(self, footer)
Sets the footer text.
source code
 
GetFooter(self)
Returns the footer text.
source code
 
SetMessage(self, message)
Sets the main body message for SuperToolTip.
source code
 
GetMessage(self)
Returns the main body message in SuperToolTip.
source code
 
SetTopGradientColour(self, colour)
Sets the top gradient colour for SuperToolTip.
source code
 
SetMiddleGradientColour(self, colour)
Sets the middle gradient colour for SuperToolTip.
source code
 
SetBottomGradientColour(self, colour)
Sets the bottom gradient colour for SuperToolTip.
source code
 
SetTextColour(self, colour)
Sets the text colour for SuperToolTip.
source code
 
GetTopGradientColour(self)
Returns the top gradient colour.
source code
 
GetMiddleGradientColour(self)
Returns the middle gradient colour.
source code
 
GetBottomGradientColour(self)
Returns the bottom gradient colour.
source code
 
GetTextColour(self)
Returns the text colour.
source code
 
SetTopGradientColor(self, colour)
Sets the top gradient colour for SuperToolTip.
source code
 
SetMiddleGradientColor(self, colour)
Sets the middle gradient colour for SuperToolTip.
source code
 
SetBottomGradientColor(self, colour)
Sets the bottom gradient colour for SuperToolTip.
source code
 
GetTopGradientColor(self)
Returns the top gradient colour.
source code
 
GetMiddleGradientColor(self)
Returns the middle gradient colour.
source code
 
GetBottomGradientColor(self)
Returns the bottom gradient colour.
source code
 
SetTextColor(self, colour)
Sets the text colour for SuperToolTip.
source code
 
GetTextColor(self)
Returns the text colour.
source code
 
SetMessageFont(self, font)
Sets the font for the main body message.
source code
 
SetHeaderFont(self, font)
Sets the font for the header text.
source code
 
SetFooterFont(self, font)
Sets the font for the footer text.
source code
 
GetMessageFont(self)
Returns the font used in the main body message.
source code
 
GetHeaderFont(self)
Returns the font used for the header text.
source code
 
GetFooterFont(self)
Returns the font used for the footer text.
source code
 
SetDropShadow(self, drop)
Whether to draw a shadow below SuperToolTip or not.
source code
 
GetDropShadow(self)
Returns whether a shadow below SuperToolTip is drawn or not.
source code
 
SetUseFade(self, fade)
Whether to use a fade in/fade out effect or not.
source code
 
GetUseFade(self)
Returns whether a fade in/fade out effect is used or not.
source code
 
ApplyStyle(self, style)
Applies none of the predefined styles.
source code
 
EnableTip(self, enable=True)
Globally (application-wide) enables/disables SuperToolTip.
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, message, bodyImage=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap *' at..., header='', headerBmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap *' at..., footer='', footerBmp=<wx._gdi.Bitmap; proxy of <Swig Object of type 'wxBitmap *' at...)
(Constructor)

source code 

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.
Overrides: object.__init__

SetTarget(self, widget)

source code 

Sets the target window for SuperToolTip.

Parameters:

SetStartDelay(self, delay=1)

source code 

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

Parameters:
  • delay - the delay in seconds.

SetEndDelay(self, delay=1000000.0)

source code 

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

Parameters:
  • delay - the delay in seconds.

SetHeaderBitmap(self, bmp)

source code 

Sets the header bitmap for SuperToolTip.

Parameters:
  • bmp - the bitmap to use.

SetHeader(self, header)

source code 

Sets the header text.

Parameters:
  • header - the header text to display.

SetDrawHeaderLine(self, draw)

source code 

Whether to draw a separator line after the header or not.

Parameters:
  • draw - bool value.

SetBodyImage(self, bmp)

source code 

Sets the main body bitmap for SuperToolTip.

Parameters:
  • bmp - the bitmap to use.

SetDrawFooterLine(self, draw)

source code 

Whether to draw a separator line before the footer or not.

Parameters:
  • draw - bool value.

SetFooterBitmap(self, bmp)

source code 

Sets the footer bitmap for SuperToolTip.

Parameters:
  • bmp - the bitmap to use.

SetFooter(self, footer)

source code 

Sets the footer text.

Parameters:
  • footer - the footer text to display.

SetMessage(self, message)

source code 

Sets the main body message for SuperToolTip.

Parameters:
  • message - the message to display in the body.

SetTopGradientColour(self, colour)

source code 

Sets the top gradient colour for SuperToolTip.

Parameters:
  • colour - the colour to use as top colour.

SetMiddleGradientColour(self, colour)

source code 

Sets the middle gradient colour for SuperToolTip.

Parameters:
  • colour - the colour to use as middle colour.

SetBottomGradientColour(self, colour)

source code 

Sets the bottom gradient colour for SuperToolTip.

Parameters:
  • colour - the colour to use as bottom colour.

SetTextColour(self, colour)

source code 

Sets the text colour for SuperToolTip.

Parameters:
  • colour - the colour to use as text colour.

SetTopGradientColor(self, colour)

source code 

Sets the top gradient colour for SuperToolTip.

Parameters:
  • colour - the colour to use as top colour.

SetMiddleGradientColor(self, colour)

source code 

Sets the middle gradient colour for SuperToolTip.

Parameters:
  • colour - the colour to use as middle colour.

SetBottomGradientColor(self, colour)

source code 

Sets the bottom gradient colour for SuperToolTip.

Parameters:
  • colour - the colour to use as bottom colour.

SetTextColor(self, colour)

source code 

Sets the text colour for SuperToolTip.

Parameters:
  • colour - the colour to use as text colour.

SetMessageFont(self, font)

source code 

Sets the font for the main body message.

Parameters:
  • font - the font to use for the main body message.

SetHeaderFont(self, font)

source code 

Sets the font for the header text.

Parameters:
  • font - the font to use for the header text.

SetFooterFont(self, font)

source code 

Sets the font for the footer text.

Parameters:
  • font - the font to use for the footer text.

SetDropShadow(self, drop)

source code 

Whether to draw a shadow below SuperToolTip or not.

Parameters:
  • drop - boolean value.

Note: this functionality is available only in Windows XP with Mark Hammond win32all extensions installed.

GetDropShadow(self)

source code 

Returns whether a shadow below SuperToolTip is drawn or not.

Note: this functionality is available only in Windows XP with Mark Hammond win32all extensions installed.

SetUseFade(self, fade)

source code 

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

Parameters:
  • fade - boolean value.

Note: this functionality is available only in Windows XP with Mark Hammond win32all extensions installed.

GetUseFade(self)

source code 

Returns whether a fade in/fade out effect is used or not.

Note: this functionality is available only in Windows XP with Mark Hammond win32all extensions installed.

ApplyStyle(self, style)

source code 

Applies none of the predefined styles.

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

EnableTip(self, enable=True)

source code 

Globally (application-wide) enables/disables SuperToolTip.

Parameters: