Navigation

Phoenix Logo

phoenix_title wx.adv.NotificationMessage

This class allows to show the user a message non intrusively.

Currently it is implemented natively for Windows and GTK and uses (non-modal) dialogs for the display of the notifications under the other platforms.

Notice that this class is not a window and so doesn’t derive from wx.Window.


class_hierarchy Class Hierarchy

Inheritance diagram for class NotificationMessage:

method_summary Methods Summary

__init__ Default constructor, use SetParent , SetTitle and SetMessage to initialize the object before showing it.
Close Hides the notification.
SetFlags This parameter can be currently used to specify the icon to show in the notification.
SetMessage Set the main text of the notification.
SetParent Set the parent for this notification: the notification will be associated with the top level parent of this window or, if this method is not called, with the main application window by default.
SetTitle Set the title, it must be a concise string (not more than 64 characters), use SetMessage to give the user more details.
Show Show the notification to the user and hides it after timeout seconds are elapsed.

api Class API


class wx.adv.NotificationMessage(EvtHandler)

Possible constructors:

NotificationMessage()

NotificationMessage(title, message="", parent=None,
                    flags=ICON_INFORMATION)

This class allows to show the user a message non intrusively.


Methods


__init__(self, *args, **kw)

overload Overloaded Implementations:


__init__ (self)

Default constructor, use SetParent , SetTitle and SetMessage to initialize the object before showing it.


__init__ (self, title, message=””, parent=None, flags=ICON_INFORMATION)

Create a notification object with the given attributes.

See SetTitle , SetMessage , SetParent and SetFlags for the description of the corresponding parameters.

Parameters:
  • title (string) –
  • message (string) –
  • parent (wx.Window) –
  • flags (int) –



Close(self)

Hides the notification.

Returns True if it was hidden or False if it couldn’t be done (e.g. on some systems automatically hidden notifications can’t be hidden manually).

Return type:bool

SetFlags(self, flags)

This parameter can be currently used to specify the icon to show in the notification.

Valid values are ICON_INFORMATION , ICON_WARNING and ICON_ERROR (notice that ICON_QUESTION is not allowed here). Some implementations of this class may not support the icons.

Parameters:flags (int) –

SetMessage(self, message)

Set the main text of the notification.

This should be a more detailed description than the title but still limited to reasonable length (not more than 256 characters).

Parameters:message (string) –

SetParent(self, parent)

Set the parent for this notification: the notification will be associated with the top level parent of this window or, if this method is not called, with the main application window by default.

Parameters:parent (wx.Window) –

SetTitle(self, title)

Set the title, it must be a concise string (not more than 64 characters), use SetMessage to give the user more details.

Parameters:title (string) –

Show(self, timeout=Timeout_Auto)

Show the notification to the user and hides it after timeout seconds are elapsed.

Special values Timeout_Auto and Timeout_Never can be used here, notice that you shouldn’t rely on timeout being exactly respected because the current platform may only support default timeout value and also because the user may be able to close the notification.

Parameters:timeout (int) –
Return type:bool
Returns:False if an error occurred.

Note

When using native notifications in wxGTK, the timeout is ignored for the notifications with ICON_WARNING or ICON_ERROR flags, they always remain shown unless they’re explicitly hidden by the user, i.e. behave as if Timeout_Auto were given.