1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Niels Sascha Reedijk, niels.reedijk@gmail.com 7 * 8 * Corresponds to: 9 * headers/os/app/Notification.h hrev51445 10 * src/kits/app/Notification.cpp hrev52287 11 */ 12 13 14 /*! 15 \file Notification.h 16 \ingroup app 17 \ingroup libbe 18 \brief Provides BNotification class and the notification_type enum. 19*/ 20 21 22///// notification_type enum ///// 23 24 25/*! 26 \enum notification_type 27 \brief Undocumented 28 29 \since Haiku R1 30*/ 31 32 33/*! 34 \var notification_type::B_INFORMATION_NOTIFICATION 35 \brief Undocumented 36 37 \since Haiku R1 38*/ 39 40 41/*! 42 \var notification_type::B_IMPORTANT_NOTIFICATION 43 \brief Undocumented 44 45 \since Haiku R1 46*/ 47 48 49/*! 50 \var notification_type::B_ERROR_NOTIFICATION 51 \brief Undocumented 52 53 \since Haiku R1 54*/ 55 56 57/*! 58 \var notification_type::B_PROGRESS_NOTIFICATION 59 \brief Undocumented 60 61 \since Haiku R1 62*/ 63 64 65///// BNotification class ///// 66 67 68/*! 69 \class BNotification 70 \brief Undocumented 71 72 \since Haiku R1 73*/ 74 75 76/*! 77 \fn BNotification::BNotification(notification_type type) 78 \brief Undocumented 79 80 \since Haiku R1 81*/ 82 83 84/*! 85 \fn BNotification::BNotification(BMessage* archive) 86 \brief Undocumented 87 88 \since Haiku R1 89*/ 90 91 92/*! 93 \fn virtual BNotification::~BNotification() 94 \brief Undocumented 95 96 \since Haiku R1 97*/ 98 99 100/*! 101 \fn status_t BNotification::InitCheck() const 102 \brief Undocumented 103 104 \since Haiku R1 105*/ 106 107 108/*! 109 \fn static BArchivable* BNotification::Instantiate(BMessage* archive) 110 \brief Undocumented 111 112 \since Haiku R1 113*/ 114 115 116/*! 117 \fn virtual status_t BNotification::Archive(BMessage* archive, 118 bool deep = true) const 119 \brief Undocumented 120 121 \since Haiku R1 122*/ 123 124 125/*! 126 \fn const char* BNotification::SourceSignature() const 127 \brief Undocumented 128 129 \since Haiku R1 130*/ 131 132 133/*! 134 \fn const char* BNotification::SourceName() const 135 \brief Undocumented 136 137 \since Haiku R1 138*/ 139 140 141/*! 142 \fn notification_type BNotification::Type() const 143 \brief Undocumented 144 145 \since Haiku R1 146*/ 147 148 149/*! 150 \fn const char* BNotification::Group() const 151 \brief Undocumented 152 153 \since Haiku R1 154*/ 155 156 157/*! 158 \fn void BNotification::SetGroup(const BString& group) 159 \brief Undocumented 160 161 \since Haiku R1 162*/ 163 164 165/*! 166 \fn const char* BNotification::Title() const 167 \brief Undocumented 168 169 \since Haiku R1 170*/ 171 172 173/*! 174 \fn void BNotification::SetTitle(const BString& title) 175 \brief Undocumented 176 177 \since Haiku R1 178*/ 179 180 181/*! 182 \fn const char* BNotification::Content() const 183 \brief Undocumented 184 185 \since Haiku R1 186*/ 187 188 189/*! 190 \fn void BNotification::SetContent(const BString& content) 191 \brief Undocumented 192 193 \since Haiku R1 194*/ 195 196 197/*! 198 \fn const char* BNotification::MessageID() const 199 \brief Undocumented 200 201 \since Haiku R1 202*/ 203 204 205/*! 206 \fn void BNotification::SetMessageID(const BString& id) 207 \brief Undocumented 208 209 \since Haiku R1 210*/ 211 212 213/*! 214 \fn float BNotification::Progress() const 215 \brief Undocumented 216 217 \since Haiku R1 218*/ 219 220 221/*! 222 \fn void BNotification::SetProgress(float progress) 223 \brief Undocumented 224 225 \since Haiku R1 226*/ 227 228 229/*! 230 \fn const char* BNotification::OnClickApp() const 231 \brief Undocumented 232 233 \since Haiku R1 234*/ 235 236 237/*! 238 \fn void BNotification::SetOnClickApp(const BString& app) 239 \brief Undocumented 240 241 \since Haiku R1 242*/ 243 244 245/*! 246 \fn const entry_ref* BNotification::OnClickFile() const 247 \brief Undocumented 248 249 \since Haiku R1 250*/ 251 252 253/*! 254 \fn status_t BNotification::SetOnClickFile(const entry_ref* file) 255 \brief Undocumented 256 257 \since Haiku R1 258*/ 259 260 261/*! 262 \fn status_t BNotification::AddOnClickRef(const entry_ref* ref) 263 \brief Undocumented 264 265 \since Haiku R1 266*/ 267 268 269/*! 270 \fn int32 BNotification::CountOnClickRefs() const 271 \brief Undocumented 272 273 \since Haiku R1 274*/ 275 276 277/*! 278 \fn const entry_ref* BNotification::OnClickRefAt(int32 index) const 279 \brief Undocumented 280 281 \since Haiku R1 282*/ 283 284 285/*! 286 \fn status_t BNotification::AddOnClickArg(const BString& arg) 287 \brief Undocumented 288 289 \since Haiku R1 290*/ 291 292 293/*! 294 \fn int32 BNotification::CountOnClickArgs() const 295 \brief Undocumented 296 297 \since Haiku R1 298*/ 299 300 301/*! 302 \fn const char* BNotification::OnClickArgAt(int32 index) const 303 \brief Undocumented 304 305 \since Haiku R1 306*/ 307 308 309/*! 310 \fn const BBitmap* BNotification::Icon() const 311 \brief Undocumented 312 313 \since Haiku R1 314*/ 315 316 317/*! 318 \fn status_t BNotification::SetIcon(const BBitmap* icon) 319 \brief Undocumented 320 321 \since Haiku R1 322*/ 323 324 325/*! 326 \fn status_t BNotification::Send(bigtime_t timeout = -1) 327 \brief Undocumented 328 329 \since Haiku R1 330*/ 331