spinetoolbox.widgets.notification

Contains a notification widget.

author

16. Savolainen (VTT)

date

12.12.2019

Module Contents

Classes

Notification	Custom pop-up notification widget with fade-in and fade-out effect.
InteractiveNotification	A notification that doesn’t dissapear when the cursor is on it.
ButtonNotification	A notification with a button.
LinkNotification	A notification that may have a link.
NotificationStack
ChangeNotifier	param parent

class spinetoolbox.widgets.notification.Notification(parent, txt, anim_duration=500, life_span=None, word_wrap=True, corner=Qt.TopRightCorner)

Bases: PySide2.QtWidgets.QFrame

Custom pop-up notification widget with fade-in and fade-out effect.

Parameters

• parent (QWidget) – Parent widget

• txt (str) – Text to display in notification

• anim_duration (int) – Duration of the animation in msecs

• life_span (int) – How long does the notification stays in place in msecs

• word_wrap (bool) –

• corner (Qt.Corner) –

opacity

show(self)

get_opacity(self)

opacity getter.

set_opacity(self, op)

opacity setter.

update_opacity(self, value)

Updates graphics effect opacity.

start_self_destruction(self)

Starts fade-out animation and closing of the notification.

enterEvent(self, e)

dragEnterEvent(self, e)

remaining_time(self)

class spinetoolbox.widgets.notification.InteractiveNotification(parent, txt, anim_duration=500, life_span=None, word_wrap=True, corner=Qt.TopRightCorner)

Bases: Notification

A notification that doesn’t dissapear when the cursor is on it.

Parameters

• parent (QWidget) – Parent widget

• txt (str) – Text to display in notification

• anim_duration (int) – Duration of the animation in msecs

• life_span (int) – How long does the notification stays in place in msecs

• word_wrap (bool) –

• corner (Qt.Corner) –

enterEvent(self, e)

Pauses timer as the mouse hovers the notification.

leaveEvent(self, e)

Starts self destruction after the mouse leaves the notification.

class spinetoolbox.widgets.notification.ButtonNotification(*args, button_text='', button_slot=None, **kwargs)

Bases: InteractiveNotification

A notification with a button.

Parameters

• parent (QWidget) – Parent widget

• txt (str) – Text to display in notification

• anim_duration (int) – Duration of the animation in msecs

• life_span (int) – How long does the notification stays in place in msecs

• word_wrap (bool) –

• corner (Qt.Corner) –

class spinetoolbox.widgets.notification.LinkNotification(*args, open_link=None, **kwargs)

Bases: InteractiveNotification

A notification that may have a link.

Parameters

• parent (QWidget) – Parent widget

• txt (str) – Text to display in notification

• anim_duration (int) – Duration of the animation in msecs

• life_span (int) – How long does the notification stays in place in msecs

• word_wrap (bool) –

• corner (Qt.Corner) –

class spinetoolbox.widgets.notification.NotificationStack(parent, anim_duration=500, life_span=None)

Bases: PySide2.QtCore.QObject

push_notification(self, notification)

Pushes a notification to the stack with the given text.

push(self, txt)

push_link(self, txt, open_link=None)

handle_notification_destroyed(self, notification, height)

Removes from the stack the given notification and move up subsequent ones.

class spinetoolbox.widgets.notification.ChangeNotifier(parent, undo_stack, settings, settings_key, corner=Qt.BottomLeftCorner)

Bases: PySide2.QtCore.QObject

Parameters

• parent (QWidget) –

• undo_stack (QUndoStack) –

• settings (QSettings) –

• settings_key (str) –

_push_notification(self, index)