--- a/ProgressNotification.st Fri Nov 04 16:31:14 2016 +0100
+++ b/ProgressNotification.st Sun Nov 06 11:49:22 2016 +0100
@@ -14,7 +14,7 @@
"{ NameSpace: Smalltalk }"
ActivityNotification subclass:#ProgressNotification
- instanceVariableNames:''
+ instanceVariableNames:'statusInfo'
classVariableNames:''
poolDictionaries:''
category:'Kernel-Exceptions-Notifications'
@@ -34,6 +34,20 @@
other person. No title to or ownership of the software is
hereby transferred.
"
+!
+
+documentation
+"
+ This should be used in long-going activites to tell the caller about any
+ progress (percentage).
+ Being a notification, it will be ignored if no one is interested.
+ If someone is interested, the caller may present this information as a progress-bar,
+ percentage display or whatever is useful in the UI.
+ Examples are:
+ http-requests, ftp requests, long lint checks etc.
+
+ See examples on how this is used by searching for references to me.
+"
! !
!ProgressNotification class methodsFor:'notification'!
@@ -55,6 +69,18 @@
progressValue
^ parameter
+!
+
+statusInfo
+ "any additional info (opaque to me)"
+
+ ^ statusInfo
+!
+
+statusInfo:something
+ "any additional info (opaque to me)"
+
+ statusInfo := something.
! !
!ProgressNotification class methodsFor:'documentation'!