interface/tipdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        tipdlg.h
   3 // Purpose:     documentation for wxTipProvider class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxTipProvider
  11     @wxheader{tipdlg.h}
  12
  13     This is the class used together with wxShowTip function.
  14     It must implement wxTipProvider::GetTip function and return the
  15     current tip from it (different tip each time it is called).
  16
  17     You will never use this class yourself, but you need it to show startup tips
  18     with wxShowTip. Also, if you want to get the tips text from elsewhere than a
  19     simple text file, you will want to derive a new class from wxTipProvider and
  20     use it instead of the one returned by wxCreateFileTipProvider.
  21
  22     @library{wxadv}
  23     @category{FIXME}
  24
  25     @seealso
  26     @ref overview_tipsoverview "Startup tips overview", ::wxShowTip
  27 */
  28 class wxTipProvider
  29 {
  30 public:
  31     /**
  32         Constructor.
  33
  34         @param currentTip
  35         The starting tip index.
  36     */
  37     wxTipProvider(size_t currentTip);
  38
  39     /**
  40         Returns the index of the current tip (i.e. the one which would be returned by
  41         GetTip).
  42
  43         The program usually remembers the value returned by this function after calling
  44         wxShowTip. Note that it is not the same as the value which
  45         was passed to wxShowTip + 1 because the user might have pressed the "Next"
  46         button in the tip dialog.
  47     */
  48     size_t GetCurrentTip();
  49
  50     /**
  51         Return the text of the current tip and pass to the next one. This function is
  52         pure virtual, it should be implemented in the derived classes.
  53     */
  54     wxString GetTip();
  55
  56     /**
  57         Returns a modified tip. This function will be called immediately after read,
  58         and before being check whether it is a comment, an empty string or a string
  59         to translate. You can optionally override this in your custom user-derived
  60         class
  61         to optionally to modify the tip as soon as it is read. You can return any
  62         modification to the string. If you return wxEmptyString, then this tip is
  63         skipped, and the next one is read.
  64     */
  65     virtual wxString PreProcessTip(const wxString& tip);
  66 };
  67
  68
  69 // ============================================================================
  70 // Global functions/macros
  71 // ============================================================================
  72
  73 /**
  74     This function creates a wxTipProvider which may be
  75     used with wxShowTip.
  76
  77     @param filename
  78     The name of the file containing the tips, one per line
  79
  80     @param currentTip
  81     The index of the first tip to show - normally this index
  82     is remembered between the 2 program runs.
  83
  84     @sa @ref overview_tipsoverview "Tips overview"
  85 */
  86 wxTipProvider * wxCreateFileTipProvider(const wxString& filename,
  87                                         size_t currentTip);
  88