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/StatusBar.h hrev49977 10 * src/kits/interface/StatusBar.cpp hrev51409 11 */ 12 13 14/*! 15 \file StatusBar.h 16 \ingroup interface 17 \brief Undocumented file. 18 19 \since Haiku R1 20*/ 21 22 23/*! 24 \class BStatusBar 25 \ingroup interface 26 \ingroup libbe 27 \brief Undocumented class. 28 29 \since Haiku R1 30*/ 31 32 33/*! 34 \fn BStatusBar::BStatusBar(BRect frame, const char *name, const char *label=NULL, const char *trailingLabel=NULL) 35 \brief Undocumented public method 36 37 \param frame Undocumented 38 \param name Undocumented 39 \param label Undocumented 40 \param trailingLabel Undocumented 41 42 \return Undocumented 43 \retval <value> Undocumented 44 45 \since Haiku R1 46*/ 47 48 49/*! 50 \fn BStatusBar::BStatusBar(const char *name, const char *label=NULL, const char *trailingLabel=NULL) 51 \brief Undocumented public method 52 53 \param name Undocumented 54 \param label Undocumented 55 \param trailingLabel Undocumented 56 57 \return Undocumented 58 \retval <value> Undocumented 59 60 \since Haiku R1 61*/ 62 63 64/*! 65 \fn BStatusBar::BStatusBar(BMessage *archive) 66 \brief Undocumented public method 67 68 \param archive Undocumented 69 70 \return Undocumented 71 \retval <value> Undocumented 72 73 \since Haiku R1 74*/ 75 76 77/*! 78 \fn virtual virtual BStatusBar::~BStatusBar() 79 \brief Undocumented public method 80 81 \return Undocumented 82 \retval <value> Undocumented 83 84 \since Haiku R1 85*/ 86 87 88/*! 89 \fn virtual virtual status_t BStatusBar::Archive(BMessage *archive, bool deep=true) const 90 \brief Undocumented public method 91 92 \param archive Undocumented 93 \param deep Undocumented 94 95 \return Undocumented 96 \retval <value> Undocumented 97 98 \since Haiku R1 99*/ 100 101 102/*! 103 \fn virtual virtual void BStatusBar::AttachedToWindow() 104 \brief Undocumented public method 105 106 \since Haiku R1 107*/ 108 109 110/*! 111 \fn virtual virtual void BStatusBar::DetachedFromWindow() 112 \brief Undocumented public method 113 114 \since Haiku R1 115*/ 116 117 118/*! 119 \fn virtual virtual void BStatusBar::AllAttached() 120 \brief Undocumented public method 121 122 \since Haiku R1 123*/ 124 125 126/*! 127 \fn virtual virtual void BStatusBar::AllDetached() 128 \brief Undocumented public method 129 130 \since Haiku R1 131*/ 132 133 134/*! 135 \fn virtual virtual void BStatusBar::WindowActivated(bool state) 136 \brief Undocumented public method 137 138 \param state Undocumented 139 140 \since Haiku R1 141*/ 142 143 144/*! 145 \fn virtual virtual void BStatusBar::MakeFocus(bool focus=true) 146 \brief Undocumented public method 147 148 \param focus Undocumented 149 150 \since Haiku R1 151*/ 152 153 154/*! 155 \fn virtual virtual void BStatusBar::GetPreferredSize(float *_width, float *_height) 156 \brief Undocumented public method 157 158 \param _width Undocumented 159 \param _height Undocumented 160 161 \since Haiku R1 162*/ 163 164 165/*! 166 \fn virtual virtual BSize BStatusBar::MinSize() 167 \brief Undocumented public method 168 169 \return Undocumented 170 \retval <value> Undocumented 171 172 \since Haiku R1 173*/ 174 175 176/*! 177 \fn virtual virtual BSize BStatusBar::MaxSize() 178 \brief Undocumented public method 179 180 \return Undocumented 181 \retval <value> Undocumented 182 183 \since Haiku R1 184*/ 185 186 187/*! 188 \fn virtual virtual BSize BStatusBar::PreferredSize() 189 \brief Undocumented public method 190 191 \return Undocumented 192 \retval <value> Undocumented 193 194 \since Haiku R1 195*/ 196 197 198/*! 199 \fn virtual virtual void BStatusBar::ResizeToPreferred() 200 \brief Undocumented public method 201 202 \since Haiku R1 203*/ 204 205 206/*! 207 \fn virtual virtual void BStatusBar::FrameMoved(BPoint newPosition) 208 \brief Undocumented public method 209 210 \param newPosition Undocumented 211 212 \since Haiku R1 213*/ 214 215 216/*! 217 \fn virtual virtual void BStatusBar::FrameResized(float newWidth, float newHeight) 218 \brief Undocumented public method 219 220 \param newWidth Undocumented 221 \param newHeight Undocumented 222 223 \since Haiku R1 224*/ 225 226 227/*! 228 \fn virtual virtual void BStatusBar::Draw(BRect updateRect) 229 \brief Undocumented public method 230 231 \param updateRect Undocumented 232 233 \since Haiku R1 234*/ 235 236 237/*! 238 \fn virtual virtual void BStatusBar::MessageReceived(BMessage *message) 239 \brief Undocumented public method 240 241 \param message Undocumented 242 243 \since Haiku R1 244*/ 245 246 247/*! 248 \fn virtual virtual void BStatusBar::MouseDown(BPoint where) 249 \brief Undocumented public method 250 251 \param where Undocumented 252 253 \since Haiku R1 254*/ 255 256 257/*! 258 \fn virtual virtual void BStatusBar::MouseUp(BPoint where) 259 \brief Undocumented public method 260 261 \param where Undocumented 262 263 \since Haiku R1 264*/ 265 266 267/*! 268 \fn virtual virtual void BStatusBar::MouseMoved(BPoint where, uint32 transit, const BMessage *dragMessage) 269 \brief Undocumented public method 270 271 \param where Undocumented 272 \param transit Undocumented 273 \param dragMessage Undocumented 274 275 \since Haiku R1 276*/ 277 278 279/*! 280 \fn virtual virtual void BStatusBar::SetBarColor(rgb_color color) 281 \brief Undocumented public method 282 283 \param color Undocumented 284 285 \since Haiku R1 286*/ 287 288 289/*! 290 \fn virtual virtual void BStatusBar::SetBarHeight(float height) 291 \brief Undocumented public method 292 293 \param height Undocumented 294 295 \since Haiku R1 296*/ 297 298 299/*! 300 \fn virtual virtual void BStatusBar::SetText(const char *string) 301 \brief Undocumented public method 302 303 \param string Undocumented 304 305 \since Haiku R1 306*/ 307 308 309/*! 310 \fn virtual virtual void BStatusBar::SetTrailingText(const char *string) 311 \brief Undocumented public method 312 313 \param string Undocumented 314 315 \since Haiku R1 316*/ 317 318 319/*! 320 \fn virtual virtual void BStatusBar::SetMaxValue(float max) 321 \brief Undocumented public method 322 323 \param max Undocumented 324 325 \since Haiku R1 326*/ 327 328 329/*! 330 \fn virtual virtual void BStatusBar::Update(float delta, const char *text=NULL, const char *trailingText=NULL) 331 \brief Undocumented public method 332 333 \param delta Undocumented 334 \param text Undocumented 335 \param trailingText Undocumented 336 337 \since Haiku R1 338*/ 339 340 341/*! 342 \fn virtual virtual void BStatusBar::Reset(const char *label=NULL, const char *trailingLabel=NULL) 343 \brief Undocumented public method 344 345 \param label Undocumented 346 \param trailingLabel Undocumented 347 348 \since Haiku R1 349*/ 350 351 352/*! 353 \fn virtual virtual void BStatusBar::SetTo(float value, const char *text=NULL, const char *trailingText=NULL) 354 \brief Undocumented public method 355 356 \param value Undocumented 357 \param text Undocumented 358 \param trailingText Undocumented 359 360 \since Haiku R1 361*/ 362 363 364/*! 365 \fn float BStatusBar::CurrentValue() const 366 \brief Undocumented public method 367 368 \return Undocumented 369 \retval <value> Undocumented 370 371 \since Haiku R1 372*/ 373 374 375/*! 376 \fn float BStatusBar::MaxValue() const 377 \brief Undocumented public method 378 379 \return Undocumented 380 \retval <value> Undocumented 381 382 \since Haiku R1 383*/ 384 385 386/*! 387 \fn rgb_color BStatusBar::BarColor() const 388 \brief Undocumented public method 389 390 \return Undocumented 391 \retval <value> Undocumented 392 393 \since Haiku R1 394*/ 395 396 397/*! 398 \fn float BStatusBar::BarHeight() const 399 \brief Undocumented public method 400 401 \return Undocumented 402 \retval <value> Undocumented 403 404 \since Haiku R1 405*/ 406 407 408/*! 409 \fn const char* BStatusBar::Text() const 410 \brief Undocumented public method 411 412 \return Undocumented 413 \retval <value> Undocumented 414 415 \since Haiku R1 416*/ 417 418 419/*! 420 \fn const char* BStatusBar::TrailingText() const 421 \brief Undocumented public method 422 423 \return Undocumented 424 \retval <value> Undocumented 425 426 \since Haiku R1 427*/ 428 429 430/*! 431 \fn const char* BStatusBar::Label() const 432 \brief Undocumented public method 433 434 \return Undocumented 435 \retval <value> Undocumented 436 437 \since Haiku R1 438*/ 439 440 441/*! 442 \fn const char* BStatusBar::TrailingLabel() const 443 \brief Undocumented public method 444 445 \return Undocumented 446 \retval <value> Undocumented 447 448 \since Haiku R1 449*/ 450 451 452/*! 453 \fn virtual virtual BHandler* BStatusBar::ResolveSpecifier(BMessage *message, int32 index, BMessage *specifier, int32 what, const char *property) 454 \brief Undocumented public method 455 456 \param message Undocumented 457 \param index Undocumented 458 \param specifier Undocumented 459 \param what Undocumented 460 \param property Undocumented 461 462 \return Undocumented 463 \retval <value> Undocumented 464 465 \since Haiku R1 466*/ 467 468 469/*! 470 \fn virtual virtual status_t BStatusBar::GetSupportedSuites(BMessage *data) 471 \brief Undocumented public method 472 473 \param data Undocumented 474 475 \return Undocumented 476 \retval <value> Undocumented 477 478 \since Haiku R1 479*/ 480 481 482/*! 483 \fn virtual virtual status_t BStatusBar::Perform(perform_code d, void *arg) 484 \brief Undocumented public method 485 486 \param d Undocumented 487 \param arg Undocumented 488 489 \return Undocumented 490 \retval <value> Undocumented 491 492 \since Haiku R1 493*/ 494 495 496/*! 497 \fn static static BArchivable* BStatusBar::Instantiate(BMessage *archive) 498 \brief Undocumented public method 499 500 \param archive Undocumented 501 502 \return Undocumented 503 \retval <value> Undocumented 504 505 \since Haiku R1 506*/ 507