docstrings and other minor tweaks

[wxWidgets.git] / wxPython / src / _tipdlg.i

diff --git a/wxPython/src/_tipdlg.i b/wxPython/src/_tipdlg.i
index f0ddbcd9225cc0f24d92fd3269f960fcc802fa44..37ac6959b2eaaaf95bbff77f8e1330f514e9559f 100644 (file)
--- a/wxPython/src/_tipdlg.i
+++ b/wxPython/src/_tipdlg.i
@@ -43,6 +43,9 @@ public:
     // modify the tip as soon as it is read. If return wxEmptyString, then 
     // the tip is skipped, and the next one is read.
     virtual wxString PreprocessTip(const wxString& tip);
     // modify the tip as soon as it is read. If return wxEmptyString, then 
     // the tip is skipped, and the next one is read.
     virtual wxString PreprocessTip(const wxString& tip);

+
+    %property(CurrentTip, GetCurrentTip, doc="See `GetCurrentTip`");
+    %property(Tip, GetTip, doc="See `GetTip`");

 };
 
 
 };
 
 


@@ -66,10 +69,10 @@ IMP_PYCALLBACK_STRING_STRING(wxPyTipProvider, wxTipProvider, PreprocessTip);
 // Now let SWIG know about it
 class wxPyTipProvider : public wxTipProvider {
 public:
 // Now let SWIG know about it
 class wxPyTipProvider : public wxTipProvider {
 public:

+    %pythonAppend wxPyTipProvider "self._setCallbackInfo(self, PyTipProvider)"

     wxPyTipProvider(size_t currentTip);
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
     wxPyTipProvider(size_t currentTip);
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);

-    %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxPyTipProvider)"

 };
 
 
 };
 
 


@@ -80,12 +83,14 @@ public:
 // the user to disable this (however, it's the program which should show, or
 // not, the dialog on startup depending on its value, not this class).
 //
 // the user to disable this (however, it's the program which should show, or
 // not, the dialog on startup depending on its value, not this class).
 //

-// The function returns TRUE if this checkbox is checked, FALSE otherwise.
-bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = TRUE);
+// The function returns True if this checkbox is checked, False otherwise.
+MustHaveApp(wxShowTip);
+bool wxShowTip(wxWindow *parent, wxTipProvider *tipProvider, bool showAtStartup = true);

 
 // a function which returns an implementation of wxTipProvider using the
 // specified text file as the source of tips (each line is a tip).
 %newobject wxCreateFileTipProvider;
 
 // a function which returns an implementation of wxTipProvider using the
 // specified text file as the source of tips (each line is a tip).
 %newobject wxCreateFileTipProvider;

+MustHaveApp(wxCreateFileTipProvider);

 wxTipProvider* wxCreateFileTipProvider(const wxString& filename, size_t currentTip);
 
 
 wxTipProvider* wxCreateFileTipProvider(const wxString& filename, size_t currentTip);