1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _adv.sip
8//
9//---------------------------------------------------------------------------
10
11%ModuleHeaderCode
12#include <wx/tipdlg.h>
13%End
14
15
16//---------------------------------------------------------------------------
17
18class wxTipProvider
19{
20    %Docstring
21        TipProvider(currentTip)
22
23        This is the class used together with wxShowTip() function.
24    %End
25    %TypeHeaderCode
26        #include <wx/tipdlg.h>
27    %End
28
29public:
30    wxTipProvider(
31        size_t currentTip
32    );
33
34    virtual
35    ~wxTipProvider();
36
37    size_t GetCurrentTip() const;
38    %Docstring
39        GetCurrentTip() -> size_t
40
41        Returns the index of the current tip (i.e. the one which would be
42        returned by GetTip()).
43    %End
44
45    virtual
46    wxString GetTip() = 0;
47    %Docstring
48        GetTip() -> String
49
50        Return the text of the current tip and pass to the next one.
51    %End
52
53    virtual
54    wxString PreprocessTip(
55        const wxString & tip
56    );
57    %Docstring
58        PreprocessTip(tip) -> String
59
60        Returns a modified tip.
61    %End
62
63    public:
64
65
66    %Property(name=CurrentTip, get=GetCurrentTip)
67    %Property(name=Tip, get=GetTip)
68};  // end of class wxTipProvider
69
70
71wxTipProvider * wxCreateFileTipProvider(
72    const wxString & filename,
73    size_t currentTip
74)   /Factory/;
75%Docstring
76    CreateFileTipProvider(filename, currentTip) -> TipProvider
77
78    This function creates a wxTipProvider which may be used with
79    wxShowTip().
80%End
81%PreMethodCode
82    if (!wxPyCheckForApp()) return NULL;
83%End
84
85bool wxShowTip(
86    wxWindow * parent,
87    wxTipProvider * tipProvider,
88    bool showAtStartup = true
89);
90%Docstring
91    ShowTip(parent, tipProvider, showAtStartup=True) -> bool
92
93    This function shows a "startup tip" to the user.
94%End
95%PreMethodCode
96    if (!wxPyCheckForApp()) return NULL;
97%End
98
99
100//---------------------------------------------------------------------------
101
102