Add more detail to the docstring for ShowBalloon()

This commit is contained in:
Robin Dunn
2017-09-13 15:06:11 -07:00
parent 9effaa0580
commit 05d3fe255a

View File

@@ -74,6 +74,15 @@ def run():
doc="""\
Show a balloon notification (the icon must have been already
initialized using SetIcon). Only implemented for Windows.
The ``title`` and ``text`` parameters are limited to 63 and 255
characters respectively, ``msec`` is the timeout, in milliseconds,
before the balloon disappears (will be clamped down to the allowed
10-30s range by Windows if it's outside it) and ``flags`` can
include wxICON_ERROR/INFO/WARNING to show a corresponding icon.
Returns ``True`` if balloon was shown, ``False`` on error (incorrect
parameters or function unsupported by OS).
""",
body="""\
#ifdef __WXMSW__