**************
wx.TipProvider
**************

Inheritance diagram for `wx.TipProvider`:

|

.. inheritance-diagram:: wx.TipProvider

|

Description
===========

This is the class used together with `wx.ShowTip <../wxFunctions.html#ShowTip>`_ function. It must implement `GetTip <#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 <../wxFunctions.html#CreateFileTipProvider>`_.


.. seealso:: `wx.ShowTip <../wxFunctions.html#ShowTip>`_


Known Subclasses
^^^^^^^^^^^^^^^^

`wx.PyTipProvider <wx.PyTipProvider.html>`_


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetCurrentTip <#GetCurrentTip>`_ 
* `GetTip <#GetTip>`_ 
* `PreprocessTip <#PreprocessTip>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `CurrentTip <#CurrentTip>`_ 
* `Tip <#Tip>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `No docstrings available for this method.` 

--------


.. method:: GetCurrentTip()

   Returns the index of the current tip (i.e. the one which would be returned by `GetTip <#GetTip>`_).

   The program usually remembers the value returned by this function after calling `wx.ShowTip <../wxFunctions.html#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.

--------

.. method:: 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` 

--------

.. method:: 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
^^^^^^^^^^


.. attribute:: CurrentTip

   See `GetCurrentTip <#GetCurrentTip>`_

.. attribute:: Tip

   See `GetTip <#GetTip>`_