wx.TipProvider

Inheritance diagram for wx.TipProvider:



Description

This is the class used together with wx.ShowTip function. It must implement GetTip function and return the current tip from it (different tip each time it is called).

You will never use this class yourself, but you need it to show startup tips with wx.ShowTip. Also, if you want to get the tips text from elsewhere than a simple text file, you will want to derive a new class from wx.TipProvider and use it instead of the one returned by wx.CreateFileTipProvider.

See also

wx.ShowTip

Known Subclasses

wx.PyTipProvider

Properties Summary

Class API

Methods

__init__()
No docstrings available for this method.

GetCurrentTip()

Returns the index of the current tip (i.e. the one which would be returned by GetTip).

The program usually remembers the value returned by this function after calling wx.ShowTip.


Returns:

long

Note

Note that it is not the same as the value which was passed to wx.ShowTip + 1 because the user might have pressed the “Next” button in the tip dialog.


GetTip()

Return the text of the current tip and pass to the next one.

This function is pure virtual, it should be implemented in the derived classes.


Returns:

string


PreprocessTip(tip)

Returns a modified tip. This function will be called immediately after read, and before being check whether it is a comment, an empty string or a string to translate.

You can optionally override this in your custom user-derived class to optionally to modify the tip as soon as it is read. You can return any modification to the string. If you return “”, then this tip is skipped, and the next one is read.

Parameters:

  • tip (string)

Returns:

string


Properties

CurrentTip
See GetCurrentTip
Tip
See GetTip