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/ChannelControl.h hrev49977 10 * src/kits/interface/ChannelControl.cpp hrev49495 11 */ 12 13 14 15 16/*! 17 \file ChannelControl.h 18 \ingroup interface 19 \brief Undocumented file. 20 21 \since Haiku R1 22*/ 23 24 25/*! 26 \class BChannelControl 27 \ingroup interface 28 \ingroup libbe 29 \brief Undocumented class. 30 31 \since Haiku R1 32*/ 33 34 35/*! 36 \fn BChannelControl::BChannelControl(BRect frame, const char *name, const char *label, BMessage *model, int32 channelCount=1, uint32 resizingMode=B_FOLLOW_LEFT_TOP, uint32 flags=B_WILL_DRAW) 37 \brief Undocumented public method 38 39 \param frame Undocumented 40 \param name Undocumented 41 \param label Undocumented 42 \param model Undocumented 43 \param channelCount Undocumented 44 \param resizingMode Undocumented 45 \param flags Undocumented 46 47 \return Undocumented 48 \retval <value> Undocumented 49 50 \since Haiku R1 51*/ 52 53 54/*! 55 \fn BChannelControl::BChannelControl(const char *name, const char *label, BMessage *model, int32 channelCount=1, uint32 flags=B_WILL_DRAW) 56 \brief Undocumented public method 57 58 \param name Undocumented 59 \param label Undocumented 60 \param model Undocumented 61 \param channelCount Undocumented 62 \param flags Undocumented 63 64 \return Undocumented 65 \retval <value> Undocumented 66 67 \since Haiku R1 68*/ 69 70 71/*! 72 \fn BChannelControl::BChannelControl(BMessage *archive) 73 \brief Undocumented public method 74 75 \param archive Undocumented 76 77 \return Undocumented 78 \retval <value> Undocumented 79 80 \since Haiku R1 81*/ 82 83 84/*! 85 \fn virtual virtual BChannelControl::~BChannelControl() 86 \brief Undocumented public method 87 88 \return Undocumented 89 \retval <value> Undocumented 90 91 \since Haiku R1 92*/ 93 94 95/*! 96 \fn virtual virtual status_t BChannelControl::Archive(BMessage *data, bool deep=true) const 97 \brief Undocumented public method 98 99 \param data Undocumented 100 \param deep Undocumented 101 102 \return Undocumented 103 \retval <value> Undocumented 104 105 \since Haiku R1 106*/ 107 108 109/*! 110 \fn virtual void BChannelControl::Draw(BRect updateRect)=0 111 \brief Undocumented public method 112 113 \param updateRect Undocumented 114 115 \since Haiku R1 116*/ 117 118 119/*! 120 \fn virtual void BChannelControl::MouseDown(BPoint where)=0 121 \brief Undocumented public method 122 123 \param where Undocumented 124 125 \since Haiku R1 126*/ 127 128 129/*! 130 \fn virtual void BChannelControl::KeyDown(const char *bytes, int32 numBytes)=0 131 \brief Undocumented public method 132 133 \param bytes Undocumented 134 \param numBytes Undocumented 135 136 \since Haiku R1 137*/ 138 139 140/*! 141 \fn virtual virtual void BChannelControl::FrameResized(float newWidth, float newHeight) 142 \brief Undocumented public method 143 144 \param newWidth Undocumented 145 \param newHeight Undocumented 146 147 \since Haiku R1 148*/ 149 150 151/*! 152 \fn virtual virtual void BChannelControl::SetFont(const BFont *font, uint32 mask=B_FONT_ALL) 153 \brief Undocumented public method 154 155 \param font Undocumented 156 \param mask Undocumented 157 158 \since Haiku R1 159*/ 160 161 162/*! 163 \fn virtual virtual void BChannelControl::AttachedToWindow() 164 \brief Undocumented public method 165 166 \since Haiku R1 167*/ 168 169 170/*! 171 \fn virtual virtual void BChannelControl::DetachedFromWindow() 172 \brief Undocumented public method 173 174 \since Haiku R1 175*/ 176 177 178/*! 179 \fn virtual virtual void BChannelControl::ResizeToPreferred() 180 \brief Undocumented public method 181 182 \since Haiku R1 183*/ 184 185 186/*! 187 \fn virtual void BChannelControl::GetPreferredSize(float *width, float *height)=0 188 \brief Undocumented public method 189 190 \param width Undocumented 191 \param height Undocumented 192 193 \since Haiku R1 194*/ 195 196 197/*! 198 \fn virtual virtual void BChannelControl::MessageReceived(BMessage *message) 199 \brief Undocumented public method 200 201 \param message Undocumented 202 203 \since Haiku R1 204*/ 205 206 207/*! 208 \fn virtual virtual BHandler* BChannelControl::ResolveSpecifier(BMessage *message, int32 index, BMessage *specifier, int32 what, const char *property) 209 \brief Undocumented public method 210 211 \param message Undocumented 212 \param index Undocumented 213 \param specifier Undocumented 214 \param what Undocumented 215 \param property Undocumented 216 217 \return Undocumented 218 \retval <value> Undocumented 219 220 \since Haiku R1 221*/ 222 223 224/*! 225 \fn virtual virtual status_t BChannelControl::GetSupportedSuites(BMessage *data) 226 \brief Undocumented public method 227 228 \param data Undocumented 229 230 \return Undocumented 231 \retval <value> Undocumented 232 233 \since Haiku R1 234*/ 235 236 237/*! 238 \fn virtual virtual void BChannelControl::SetModificationMessage(BMessage *message) 239 \brief Undocumented public method 240 241 \param message Undocumented 242 243 \since Haiku R1 244*/ 245 246 247/*! 248 \fn BMessage* BChannelControl::ModificationMessage() const 249 \brief Undocumented public method 250 251 \return Undocumented 252 \retval <value> Undocumented 253 254 \since Haiku R1 255*/ 256 257 258/*! 259 \fn virtual virtual status_t BChannelControl::Invoke(BMessage *message=NULL) 260 \brief Undocumented public method 261 262 \param message Undocumented 263 264 \return Undocumented 265 \retval <value> Undocumented 266 267 \since Haiku R1 268*/ 269 270 271/*! 272 \fn virtual virtual status_t BChannelControl::InvokeChannel(BMessage *message=NULL, int32 fromChannel=0, int32 channelCount=-1, const bool *_mask=NULL) 273 \brief Undocumented public method 274 275 \param message Undocumented 276 \param fromChannel Undocumented 277 \param channelCount Undocumented 278 \param _mask Undocumented 279 280 \return Undocumented 281 \retval <value> Undocumented 282 283 \since Haiku R1 284*/ 285 286 287/*! 288 \fn status_t BChannelControl::InvokeNotifyChannel(BMessage *message=NULL, uint32 kind=B_CONTROL_INVOKED, int32 fromChannel=0, int32 channelCount=-1, const bool *_mask=NULL) 289 \brief Undocumented public method 290 291 \param message Undocumented 292 \param kind Undocumented 293 \param fromChannel Undocumented 294 \param channelCount Undocumented 295 \param _mask Undocumented 296 297 \return Undocumented 298 \retval <value> Undocumented 299 300 \since Haiku R1 301*/ 302 303 304/*! 305 \fn virtual virtual void BChannelControl::SetValue(int32 value) 306 \brief Undocumented public method 307 308 \param value Undocumented 309 310 \since Haiku R1 311*/ 312 313 314/*! 315 \fn virtual virtual status_t BChannelControl::SetCurrentChannel(int32 index) 316 \brief Undocumented public method 317 318 \param index Undocumented 319 320 \return Undocumented 321 \retval <value> Undocumented 322 323 \since Haiku R1 324*/ 325 326 327/*! 328 \fn int32 BChannelControl::CurrentChannel() const 329 \brief Undocumented public method 330 331 \return Undocumented 332 \retval <value> Undocumented 333 334 \since Haiku R1 335*/ 336 337 338/*! 339 \fn virtual virtual int32 BChannelControl::CountChannels() const 340 \brief Undocumented public method 341 342 \return Undocumented 343 \retval <value> Undocumented 344 345 \since Haiku R1 346*/ 347 348 349/*! 350 \fn virtual int32 BChannelControl::MaxChannelCount() const =0 351 \brief Undocumented public method 352 353 \return Undocumented 354 \retval <value> Undocumented 355 356 \since Haiku R1 357*/ 358 359 360/*! 361 \fn virtual virtual status_t BChannelControl::SetChannelCount(int32 count) 362 \brief Undocumented public method 363 364 \param count Undocumented 365 366 \return Undocumented 367 \retval <value> Undocumented 368 369 \since Haiku R1 370*/ 371 372 373/*! 374 \fn int32 BChannelControl::ValueFor(int32 channel) const 375 \brief Undocumented public method 376 377 \param channel Undocumented 378 379 \return Undocumented 380 \retval <value> Undocumented 381 382 \since Haiku R1 383*/ 384 385 386/*! 387 \fn virtual virtual int32 BChannelControl::GetValue(int32 *_values, int32 fromChannel, int32 channelCount) const 388 \brief Undocumented public method 389 390 \param _values Undocumented 391 \param fromChannel Undocumented 392 \param channelCount Undocumented 393 394 \return Undocumented 395 \retval <value> Undocumented 396 397 \since Haiku R1 398*/ 399 400 401/*! 402 \fn status_t BChannelControl::SetValueFor(int32 channel, int32 value) 403 \brief Undocumented public method 404 405 \param channel Undocumented 406 \param value Undocumented 407 408 \return Undocumented 409 \retval <value> Undocumented 410 411 \since Haiku R1 412*/ 413 414 415/*! 416 \fn virtual virtual status_t BChannelControl::SetValue(int32 fromChannel, int32 channelCount, const int32 *values) 417 \brief Undocumented public method 418 419 \param fromChannel Undocumented 420 \param channelCount Undocumented 421 \param values Undocumented 422 423 \return Undocumented 424 \retval <value> Undocumented 425 426 \since Haiku R1 427*/ 428 429 430/*! 431 \fn status_t BChannelControl::SetAllValue(int32 values) 432 \brief Undocumented public method 433 434 \param values Undocumented 435 436 \return Undocumented 437 \retval <value> Undocumented 438 439 \since Haiku R1 440*/ 441 442 443/*! 444 \fn status_t BChannelControl::SetLimitsFor(int32 channel, int32 minimum, int32 maximum) 445 \brief Undocumented public method 446 447 \param channel Undocumented 448 \param minimum Undocumented 449 \param maximum Undocumented 450 451 \return Undocumented 452 \retval <value> Undocumented 453 454 \since Haiku R1 455*/ 456 457 458/*! 459 \fn status_t BChannelControl::GetLimitsFor(int32 channel, int32 *_minimum, int32 *_maximum) const 460 \brief Undocumented public method 461 462 \param channel Undocumented 463 \param _minimum Undocumented 464 \param _maximum Undocumented 465 466 \return Undocumented 467 \retval <value> Undocumented 468 469 \since Haiku R1 470*/ 471 472 473/*! 474 \fn virtual virtual status_t BChannelControl::SetLimitsFor(int32 fromChannel, int32 channelCount, const int32 *minima, const int32 *maxima) 475 \brief Undocumented public method 476 477 \param fromChannel Undocumented 478 \param channelCount Undocumented 479 \param minima Undocumented 480 \param maxima Undocumented 481 482 \return Undocumented 483 \retval <value> Undocumented 484 485 \since Haiku R1 486*/ 487 488 489/*! 490 \fn virtual virtual status_t BChannelControl::GetLimitsFor(int32 fromChannel, int32 channelCount, int32 *minima, int32 *maxima) const 491 \brief Undocumented public method 492 493 \param fromChannel Undocumented 494 \param channelCount Undocumented 495 \param minima Undocumented 496 \param maxima Undocumented 497 498 \return Undocumented 499 \retval <value> Undocumented 500 501 \since Haiku R1 502*/ 503 504 505/*! 506 \fn status_t BChannelControl::SetLimits(int32 minimum, int32 maximum) 507 \brief Undocumented public method 508 509 \param minimum Undocumented 510 \param maximum Undocumented 511 512 \return Undocumented 513 \retval <value> Undocumented 514 515 \since Haiku R1 516*/ 517 518 519/*! 520 \fn status_t BChannelControl::GetLimits(int32 *_minimum, int32 *_maximum) const 521 \brief Undocumented public method 522 523 \param _minimum Undocumented 524 \param _maximum Undocumented 525 526 \return Undocumented 527 \retval <value> Undocumented 528 529 \since Haiku R1 530*/ 531 532 533/*! 534 \fn virtual bool BChannelControl::SupportsIndividualLimits() const =0 535 \brief Undocumented public method 536 537 \return Undocumented 538 \retval <value> Undocumented 539 540 \since Haiku R1 541*/ 542 543 544/*! 545 \fn virtual virtual status_t BChannelControl::SetLimitLabels(const char *minLabel, const char *maxLabel) 546 \brief Undocumented public method 547 548 \param minLabel Undocumented 549 \param maxLabel Undocumented 550 551 \return Undocumented 552 \retval <value> Undocumented 553 554 \since Haiku R1 555*/ 556 557 558/*! 559 \fn const char* BChannelControl::MinLimitLabel() const 560 \brief Undocumented public method 561 562 \return Undocumented 563 \retval <value> Undocumented 564 565 \since Haiku R1 566*/ 567 568 569/*! 570 \fn const char* BChannelControl::MaxLimitLabel() const 571 \brief Undocumented public method 572 573 \return Undocumented 574 \retval <value> Undocumented 575 576 \since Haiku R1 577*/ 578 579 580/*! 581 \fn virtual virtual status_t BChannelControl::SetLimitLabelsFor(int32 channel, const char *minLabel, const char *maxLabel) 582 \brief Undocumented public method 583 584 \param channel Undocumented 585 \param minLabel Undocumented 586 \param maxLabel Undocumented 587 588 \return Undocumented 589 \retval <value> Undocumented 590 591 \since Haiku R1 592*/ 593 594 595/*! 596 \fn virtual virtual status_t BChannelControl::SetLimitLabelsFor(int32 fromChannel, int32 channelCount, const char *minLabel, const char *maxLabel) 597 \brief Undocumented public method 598 599 \param fromChannel Undocumented 600 \param channelCount Undocumented 601 \param minLabel Undocumented 602 \param maxLabel Undocumented 603 604 \return Undocumented 605 \retval <value> Undocumented 606 607 \since Haiku R1 608*/ 609 610 611/*! 612 \fn const char* BChannelControl::MinLimitLabelFor(int32 channel) const 613 \brief Undocumented public method 614 615 \param channel Undocumented 616 617 \return Undocumented 618 \retval <value> Undocumented 619 620 \since Haiku R1 621*/ 622 623 624/*! 625 \fn const char* BChannelControl::MaxLimitLabelFor(int32 channel) const 626 \brief Undocumented public method 627 628 \param channel Undocumented 629 630 \return Undocumented 631 \retval <value> Undocumented 632 633 \since Haiku R1 634*/ 635 636 637/*! 638 \fn int32 *const & BChannelControl::MinLimitList() const 639 \brief Undocumented protected method 640 641 \return Undocumented 642 \retval <value> Undocumented 643 644 \since Haiku R1 645*/ 646 647 648/*! 649 \fn int32 *const & BChannelControl::MaxLimitList() const 650 \brief Undocumented protected method 651 652 \return Undocumented 653 \retval <value> Undocumented 654 655 \since Haiku R1 656*/ 657 658 659/*! 660 \fn int32 *const & BChannelControl::ValueList() const 661 \brief Undocumented protected method 662 663 \return Undocumented 664 \retval <value> Undocumented 665 666 \since Haiku R1 667*/ 668