phoenix_title wx.adv.TipProvider

This is the class used together with wx.adv.ShowTip function.

It must implement wx.adv.TipProvider.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 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.adv.TipProvider and use it instead of the one returned by wx.adv.CreateFileTipProvider .

See also

TipProvider Overview, wx.adv.ShowTip


class_hierarchy Class Hierarchy

Inheritance diagram for class TipProvider:

method_summary Methods Summary

__init__

Constructor.

GetCurrentTip

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

GetTip

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


property_summary Properties Summary

CurrentTip

See GetCurrentTip

Tip

See GetTip


api Class API

class wx.adv.TipProvider(object)

Possible constructors:

TipProvider(currentTip)

This is the class used together with ShowTip() function.


Methods

__init__(self, currentTip)

Constructor.

Parameters:

currentTip (int) – The starting tip index.



GetCurrentTip(self)

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.adv.ShowTip . Note that it is not the same as the value which was passed to ShowTip + 1 because the user might have pressed the “Next” button in the tip dialog.

Return type:

int



GetTip(self)

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.

Return type:

string


Properties

CurrentTip

See GetCurrentTip



Tip

See GetTip