haiku/headers/os/app/Notification.h
Stephan Aßmus f33637d9a8 * Improved BNotification API.
- No more manual memory management.
   - Make it clear who keeps or releases ownership of arguments passed.
   - Copy icon, arguments and entry_refs.
   - Do not expose implementation details (What do the BLists contain?!).
   - BRoster takes const BNotification& and bigtime_t timeout.

 * BRoster::Notify():
   - Proper error handling.
   - Fixed documentation.

 * Adjusted notify:
   - Renamed fOk to fHasGoodArguments.
   - The "const char*" members were really "char*" members (self-managed).
   - free() is NULL-safe.
   - fRefs contains BEntries, so passing void* to delete does no good.
   - Adjustments to the changed API.
   - Coding style fixes.

 * notification_server:
   - Adjustment to the new type for timeout.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@36952 a95241bf-73f2-0310-859d-f6bbb57e9c96
2010-05-27 17:50:12 +00:00

82 lines
1.7 KiB
C++

/*
* Copyright 2010, Haiku, Inc. All Rights Reserved.
* Distributed under the terms of the MIT License.
*/
#ifndef _NOTIFICATION_H
#define _NOTIFICATION_H
#include <Entry.h>
#include <List.h>
#include <String.h>
// notification types
enum notification_type {
B_INFORMATION_NOTIFICATION,
B_IMPORTANT_NOTIFICATION,
B_ERROR_NOTIFICATION,
B_PROGRESS_NOTIFICATION
};
class BBitmap;
class BNotification {
public:
BNotification(notification_type type);
~BNotification();
notification_type Type() const;
const char* Application() const;
void SetApplication(const char* app);
const char* Title() const;
void SetTitle(const char* title);
const char* Content() const;
void SetContent(const char* content);
const char* MessageID() const;
void SetMessageID(const char* id);
float Progress() const;
void SetProgress(float progress);
const char* OnClickApp() const;
void SetOnClickApp(const char* app);
const entry_ref* OnClickFile() const;
status_t SetOnClickFile(const entry_ref* file);
status_t AddOnClickRef(const entry_ref* ref);
status_t AddOnClickRef(const entry_ref& ref);
int32 CountOnClickRefs() const;
const entry_ref* OnClickRefAt(int32 index) const;
status_t AddOnClickArg(const char* arg);
int32 CountOnClickArgs() const;
const char* OnClickArgAt(int32 index) const;
const BBitmap* Icon() const;
status_t SetIcon(const BBitmap* icon);
private:
notification_type fType;
BString fAppName;
BString fTitle;
BString fContent;
BString fID;
float fProgress;
BString fApp;
entry_ref* fFile;
BList fRefs;
BList fArgv;
BBitmap* fBitmap;
};
#endif // _NOTIFICATION_H