1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/interface/Deskbar.h hrev52499 10 * src/kits/interface/Deskbar.cpp hrev52499 11 */ 12 13 14/*! 15 \file Deskbar.h 16 \ingroup interface 17 \brief Undocumented file. 18 19 \since Haiku R1 20*/ 21 22 23/*! 24 \class BDeskbar 25 \ingroup interface 26 \ingroup libbe 27 \brief Undocumented class. 28 29 \since Haiku R1 30*/ 31 32 33/*! 34 \fn BDeskbar::BDeskbar() 35 \brief Undocumented public method 36 37 \return Undocumented 38 \retval <value> Undocumented 39 40 \since Haiku R1 41*/ 42 43 44/*! 45 \fn BDeskbar::~BDeskbar() 46 \brief Undocumented public method 47 48 \return Undocumented 49 \retval <value> Undocumented 50 51 \since Haiku R1 52*/ 53 54 55/*! 56 \fn bool BDeskbar::IsRunning() const 57 \brief Undocumented public method 58 59 \return Undocumented 60 \retval <value> Undocumented 61 62 \since Haiku R1 63*/ 64 65 66/*! 67 \fn BRect BDeskbar::Frame() const 68 \brief Undocumented public method 69 70 \return Undocumented 71 \retval <value> Undocumented 72 73 \since Haiku R1 74*/ 75 76 77/*! 78 \fn deskbar_location BDeskbar::Location(bool *_isExpanded=NULL) const 79 \brief Undocumented public method 80 81 \param _isExpanded Undocumented 82 83 \return Undocumented 84 \retval <value> Undocumented 85 86 \since Haiku R1 87*/ 88 89 90/*! 91 \fn status_t BDeskbar::SetLocation(deskbar_location location, bool expanded=false) 92 \brief Undocumented public method 93 94 \param location Undocumented 95 \param expanded Undocumented 96 97 \return Undocumented 98 \retval <value> Undocumented 99 100 \since Haiku R1 101*/ 102 103 104/*! 105 \fn bool BDeskbar::IsExpanded() const 106 \brief Undocumented public method 107 108 \return Undocumented 109 \retval <value> Undocumented 110 111 \since Haiku R1 112*/ 113 114 115/*! 116 \fn status_t BDeskbar::Expand(bool expand) 117 \brief Undocumented public method 118 119 \param expand Undocumented 120 121 \return Undocumented 122 \retval <value> Undocumented 123 124 \since Haiku R1 125*/ 126 127 128/*! 129 \fn bool BDeskbar::IsAlwaysOnTop() const 130 \brief Undocumented public method 131 132 \return Undocumented 133 \retval <value> Undocumented 134 135 \since Haiku R1 136*/ 137 138 139/*! 140 \fn status_t BDeskbar::SetAlwaysOnTop(bool alwaysOnTop) 141 \brief Undocumented public method 142 143 \param alwaysOnTop Undocumented 144 145 \return Undocumented 146 \retval <value> Undocumented 147 148 \since Haiku R1 149*/ 150 151 152/*! 153 \fn bool BDeskbar::IsAutoRaise() const 154 \brief Undocumented public method 155 156 \return Undocumented 157 \retval <value> Undocumented 158 159 \since Haiku R1 160*/ 161 162 163/*! 164 \fn status_t BDeskbar::SetAutoRaise(bool autoRaise) 165 \brief Undocumented public method 166 167 \param autoRaise Undocumented 168 169 \return Undocumented 170 \retval <value> Undocumented 171 172 \since Haiku R1 173*/ 174 175 176/*! 177 \fn bool BDeskbar::IsAutoHide() const 178 \brief Undocumented public method 179 180 \return Undocumented 181 \retval <value> Undocumented 182 183 \since Haiku R1 184*/ 185 186 187/*! 188 \fn status_t BDeskbar::SetAutoHide(bool autoHide) 189 \brief Undocumented public method 190 191 \param autoHide Undocumented 192 193 \return Undocumented 194 \retval <value> Undocumented 195 196 \since Haiku R1 197*/ 198 199 200/*! 201 \fn status_t BDeskbar::GetItemInfo(int32 id, const char **_name) const 202 \brief Undocumented public method 203 204 \param id Undocumented 205 \param _name Undocumented 206 207 \return Undocumented 208 \retval <value> Undocumented 209 210 \since Haiku R1 211*/ 212 213 214/*! 215 \fn status_t BDeskbar::GetItemInfo(const char *name, int32 *_id) const 216 \brief Undocumented public method 217 218 \param name Undocumented 219 \param _id Undocumented 220 221 \return Undocumented 222 \retval <value> Undocumented 223 224 \since Haiku R1 225*/ 226 227 228/*! 229 \fn bool BDeskbar::HasItem(int32 id) const 230 \brief Undocumented public method 231 232 \param id Undocumented 233 234 \return Undocumented 235 \retval <value> Undocumented 236 237 \since Haiku R1 238*/ 239 240 241/*! 242 \fn bool BDeskbar::HasItem(const char *name) const 243 \brief Undocumented public method 244 245 \param name Undocumented 246 247 \return Undocumented 248 \retval <value> Undocumented 249 250 \since Haiku R1 251*/ 252 253 254/*! 255 \fn uint32 BDeskbar::CountItems() const 256 \brief Undocumented public method 257 258 \return Undocumented 259 \retval <value> Undocumented 260 261 \since Haiku R1 262*/ 263 264 265/*! 266 \fn float BDeskbar::MaxItemWidth() const 267 \brief Undocumented public method 268 269 \return Undocumented 270 \retval <value> Undocumented 271 272 \since Haiku R1 273*/ 274 275 276/*! 277 \fn float BDeskbar::MaxItemHeight() const 278 \brief Undocumented public method 279 280 \return Undocumented 281 \retval <value> Undocumented 282 283 \since Haiku R1 284*/ 285 286 287/*! 288 \fn status_t BDeskbar::AddItem(BView *archivableView, int32 *_id=NULL) 289 \brief Undocumented public method 290 291 \param archivableView Undocumented 292 \param _id Undocumented 293 294 \return Undocumented 295 \retval <value> Undocumented 296 297 \since Haiku R1 298*/ 299 300 301/*! 302 \fn status_t BDeskbar::AddItem(entry_ref *addOn, int32 *_id=NULL) 303 \brief Undocumented public method 304 305 \param addOn Undocumented 306 \param _id Undocumented 307 308 \return Undocumented 309 \retval <value> Undocumented 310 311 \since Haiku R1 312*/ 313 314 315/*! 316 \fn status_t BDeskbar::RemoveItem(int32 id) 317 \brief Undocumented public method 318 319 \param id Undocumented 320 321 \return Undocumented 322 \retval <value> Undocumented 323 324 \since Haiku R1 325*/ 326 327 328/*! 329 \fn status_t BDeskbar::RemoveItem(const char *name) 330 \brief Undocumented public method 331 332 \param name Undocumented 333 334 \return Undocumented 335 \retval <value> Undocumented 336 337 \since Haiku R1 338*/ 339 340 341/*! 342 \enum deskbar_location 343 \ingroup <kit name> 344 \brief Undocumented enum. 345 346 \since Haiku R1 347*/ 348 349 350/*! 351 \var deskbar_location B_DESKBAR_TOP 352 \brief Undocumented enum value. 353 354 \since Haiku R1 355*/ 356 357 358/*! 359 \var deskbar_location B_DESKBAR_BOTTOM 360 \brief Undocumented enum value. 361 362 \since Haiku R1 363*/ 364 365 366/*! 367 \var deskbar_location B_DESKBAR_LEFT_TOP 368 \brief Undocumented enum value. 369 370 \since Haiku R1 371*/ 372 373 374/*! 375 \var deskbar_location B_DESKBAR_RIGHT_TOP 376 \brief Undocumented enum value. 377 378 \since Haiku R1 379*/ 380 381 382/*! 383 \var deskbar_location B_DESKBAR_LEFT_BOTTOM 384 \brief Undocumented enum value. 385 386 \since Haiku R1 387*/ 388 389 390/*! 391 \var deskbar_location B_DESKBAR_RIGHT_BOTTOM 392 \brief Undocumented enum value. 393 394 \since Haiku R1 395*/ 396