user/app/Notification.dox

18 	\brief Provides BNotification class and the notification_type enum.
81 ///// BNotification class /////
85 	\class BNotification
94 	 - The \link BNotification::BNotification() type of notification\endlink,
97 	 - The \link BNotification::SetGroup() group\endlink, which allows you to
99 	 - A \link BNotification::SetTitle() title\endlink, which is a distinct
101 	 - The \link BNotification::SetContent() content\endlink, which is the text
103 	 - A \link BNotification::SetMessageID() message identifier\endlink that
107 	   \link BNotification::SetProgress() percentage of completion\endlink can be
110 	   set an \link BNotification::SetIcon() alternative icon\endlink.
117 	BNotification notification(B_PROGRESS_NOTIFICATION);
129 	\link BNotification::SetMessageID message identifier\endlink, which will
142 	you want to \link BNotification::SetOnClickApp() open a specific
144 	\link BNotification::SetOnClickFile() open a specific file\endlink and have
146 	specify \link BNotification::AddOnClickArg() command line arguments\endlink
147 	or pass additional \link BNotification::AddOnClickRef() file
155 	running. This impacts the \link BNotification::SetGroup() grouping\endlink
156 	functionality and the \link BNotification::SetMessageID() message
166 	\fn BNotification::BNotification(notification_type type)
177 	\fn BNotification::BNotification(BMessage* archive)
185 	\fn virtual BNotification::~BNotification()
193 	\fn status_t BNotification::InitCheck() const
201 	\fn static BArchivable* BNotification::Instantiate(BMessage* archive)
202 	\brief Returns a new BNotification object from \a archive.
205 	build a new BNotification object from a previously created
207 	for a BNotification object, this method returns \c NULL.
209 	\returns BNotification object from \a archive or \c NULL if it doesn't
210 	         contain a valid BNotification object.
217 	\fn virtual status_t BNotification::Archive(BMessage* archive,
219 	\brief Archives the BNotification in the \c archive.
230 	\fn const char* BNotification::SourceSignature() const
245 	\fn const char* BNotification::SourceName() const
260 	\fn notification_type BNotification::Type() const
271 	\fn const char* BNotification::Group() const
274 	\see BNotification::SetGroup() for more information about groups.
283 	\fn void BNotification::SetGroup(const BString& group)
300 	\fn const char* BNotification::Title() const
310 	\fn void BNotification::SetTitle(const BString& title)
318 	\fn const char* BNotification::Content() const
328 	\fn void BNotification::SetContent(const BString& content)
336 	\fn const char* BNotification::MessageID() const
339 	\see BNotification::SetMessageID() for the purpose of having an identifier.
348 	\fn void BNotification::SetMessageID(const BString& id)
364 	\fn float BNotification::Progress() const
367 	\see BNotification::SetProgress() for more information about this value.
377 	\fn void BNotification::SetProgress(float progress)
394 	\fn const char* BNotification::OnClickApp() const
398 	\see More information about this property in BNotification::SetOnClickApp().
405 	\fn void BNotification::SetOnClickApp(const BString& app)
412 	Using this property has precedence on when BNotification::SetOnClickFile()
415 	BNotification::AddOnClickRef().
418 	     BNotification::SetOnClickFile(), BNotification::AddOnClickRef()
419 		 and BNotification::AddOnClickArg().
426 	\fn const entry_ref* BNotification::OnClickFile() const
430 	\see More information about this property in BNotification::SetOnClickFile().
437 	\fn status_t BNotification::SetOnClickFile(const entry_ref* file)
444 	BNotification::SetOnClickApp(). If you use this way of setting an action,
448 	     BNotification::SetOnClickApp(), BNotification::AddOnClickRef()
449 		 and BNotification::AddOnClickArg().
456 	\fn status_t BNotification::AddOnClickRef(const entry_ref* ref)
461 	the application specified by BNotification::AddOnClickApp(), or the one
462 	that is associated with BNotification::AddOnClickFile(). The refs will be
470 	\fn int32 BNotification::CountOnClickRefs() const
474 	\see BNotification::AddOnClickRef()
481 	\fn const entry_ref* BNotification::OnClickRefAt(int32 index) const
484 	\see BNotification::AddOnClickRef()
491 	\fn status_t BNotification::AddOnClickArg(const BString& arg)
496 	to the application specified by BNotification::AddOnClickApp(), or the one
497 	that is associated with BNotification::AddOnClickFile(). The args will be
505 	\fn int32 BNotification::CountOnClickArgs() const
509 	\see BNotification::AddOnClickArg()
516 	\fn const char* BNotification::OnClickArgAt(int32 index) const
519 	\see BNotification::AddOnClickArg()
525 	\fn const BBitmap* BNotification::Icon() const
528 	\see BNotification::SetIcon() for more information on this property.
537 	\fn status_t BNotification::SetIcon(const BBitmap* icon)
553 	\fn status_t BNotification::Send(bigtime_t timeout = -1)
561 	update the notification. See BNotification::SetMessageID() about updating