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/SplitView.h hrev49977 10 * src/kits/interface/SplitView.cpp hrev43279 11 */ 12 13 14/*! 15 \file SplitView.h 16 \ingroup layout 17 \brief Undocumented file. 18 19 \since Haiku R1 20*/ 21 22 23/*! 24 \class BSplitView 25 \ingroup layout 26 \ingroup libbe 27 \brief Undocumented class. 28 29 \since Haiku R1 30*/ 31 32 33/*! 34 \fn BSplitView::BSplitView(orientation orientation=B_HORIZONTAL, float spacing=B_USE_DEFAULT_SPACING) 35 \brief Undocumented public method 36 37 \param orientation Undocumented 38 \param spacing Undocumented 39 40 \return Undocumented 41 \retval <value> Undocumented 42 43 \since Haiku R1 44*/ 45 46 47/*! 48 \fn BSplitView::BSplitView(BMessage *from) 49 \brief Undocumented public method 50 51 \param from Undocumented 52 53 \return Undocumented 54 \retval <value> Undocumented 55 56 \since Haiku R1 57*/ 58 59 60/*! 61 \fn virtual virtual BSplitView::~BSplitView() 62 \brief Undocumented public method 63 64 \return Undocumented 65 \retval <value> Undocumented 66 67 \since Haiku R1 68*/ 69 70 71/*! 72 \fn void BSplitView::SetInsets(float left, float top, float right, float bottom) 73 \brief Undocumented public method 74 75 \param left Undocumented 76 \param top Undocumented 77 \param right Undocumented 78 \param bottom Undocumented 79 80 \since Haiku R1 81*/ 82 83 84/*! 85 \fn void BSplitView::SetInsets(float horizontal, float vertical) 86 \brief Undocumented public method 87 88 \param horizontal Undocumented 89 \param vertical Undocumented 90 91 \since Haiku R1 92*/ 93 94 95/*! 96 \fn void BSplitView::SetInsets(float insets) 97 \brief Undocumented public method 98 99 \param insets Undocumented 100 101 \since Haiku R1 102*/ 103 104 105/*! 106 \fn void BSplitView::GetInsets(float *left, float *top, float *right, float *bottom) const 107 \brief Undocumented public method 108 109 \param left Undocumented 110 \param top Undocumented 111 \param right Undocumented 112 \param bottom Undocumented 113 114 \since Haiku R1 115*/ 116 117 118/*! 119 \fn float BSplitView::Spacing() const 120 \brief Undocumented public method 121 122 \return Undocumented 123 \retval <value> Undocumented 124 125 \since Haiku R1 126*/ 127 128 129/*! 130 \fn void BSplitView::SetSpacing(float spacing) 131 \brief Undocumented public method 132 133 \param spacing Undocumented 134 135 \since Haiku R1 136*/ 137 138 139/*! 140 \fn orientation BSplitView::Orientation() const 141 \brief Undocumented public method 142 143 \return Undocumented 144 \retval <value> Undocumented 145 146 \since Haiku R1 147*/ 148 149 150/*! 151 \fn void BSplitView::SetOrientation(orientation orientation) 152 \brief Undocumented public method 153 154 \param orientation Undocumented 155 156 \since Haiku R1 157*/ 158 159 160/*! 161 \fn float BSplitView::SplitterSize() const 162 \brief Undocumented public method 163 164 \return Undocumented 165 \retval <value> Undocumented 166 167 \since Haiku R1 168*/ 169 170 171/*! 172 \fn void BSplitView::SetSplitterSize(float size) 173 \brief Undocumented public method 174 175 \param size Undocumented 176 177 \since Haiku R1 178*/ 179 180 181/*! 182 \fn int32 BSplitView::CountItems() const 183 \brief Undocumented public method 184 185 \return Undocumented 186 \retval <value> Undocumented 187 188 \since Haiku R1 189*/ 190 191 192/*! 193 \fn float BSplitView::ItemWeight(int32 index) const 194 \brief Undocumented public method 195 196 \param index Undocumented 197 198 \return Undocumented 199 \retval <value> Undocumented 200 201 \since Haiku R1 202*/ 203 204 205/*! 206 \fn float BSplitView::ItemWeight(BLayoutItem *item) const 207 \brief Undocumented public method 208 209 \param item Undocumented 210 211 \return Undocumented 212 \retval <value> Undocumented 213 214 \since Haiku R1 215*/ 216 217 218/*! 219 \fn void BSplitView::SetItemWeight(int32 index, float weight, bool invalidateLayout) 220 \brief Undocumented public method 221 222 \param index Undocumented 223 \param weight Undocumented 224 \param invalidateLayout Undocumented 225 226 \since Haiku R1 227*/ 228 229 230/*! 231 \fn void BSplitView::SetItemWeight(BLayoutItem *item, float weight) 232 \brief Undocumented public method 233 234 \param item Undocumented 235 \param weight Undocumented 236 237 \since Haiku R1 238*/ 239 240 241/*! 242 \fn bool BSplitView::IsCollapsible(int32 index) const 243 \brief Undocumented public method 244 245 \param index Undocumented 246 247 \return Undocumented 248 \retval <value> Undocumented 249 250 \since Haiku R1 251*/ 252 253 254/*! 255 \fn void BSplitView::SetCollapsible(bool collapsible) 256 \brief Undocumented public method 257 258 \param collapsible Undocumented 259 260 \since Haiku R1 261*/ 262 263 264/*! 265 \fn void BSplitView::SetCollapsible(int32 index, bool collapsible) 266 \brief Undocumented public method 267 268 \param index Undocumented 269 \param collapsible Undocumented 270 271 \since Haiku R1 272*/ 273 274 275/*! 276 \fn void BSplitView::SetCollapsible(int32 first, int32 last, bool collapsible) 277 \brief Undocumented public method 278 279 \param first Undocumented 280 \param last Undocumented 281 \param collapsible Undocumented 282 283 \since Haiku R1 284*/ 285 286 287/*! 288 \fn bool BSplitView::IsItemCollapsed(int32 index) const 289 \brief Undocumented public method 290 291 \param index Undocumented 292 293 \return Undocumented 294 \retval <value> Undocumented 295 296 \since Haiku R1 297*/ 298 299 300/*! 301 \fn void BSplitView::SetItemCollapsed(int32 index, bool collapsed) 302 \brief Undocumented public method 303 304 \param index Undocumented 305 \param collapsed Undocumented 306 307 \since Haiku R1 308*/ 309 310 311/*! 312 \fn void BSplitView::AddChild(BView *child, BView *sibling=NULL) 313 \brief Undocumented public method 314 315 \param child Undocumented 316 \param sibling Undocumented 317 318 \since Haiku R1 319*/ 320 321 322/*! 323 \fn bool BSplitView::AddChild(BView *child, float weight) 324 \brief Undocumented public method 325 326 \param child Undocumented 327 \param weight Undocumented 328 329 \return Undocumented 330 \retval <value> Undocumented 331 332 \since Haiku R1 333*/ 334 335 336/*! 337 \fn bool BSplitView::AddChild(int32 index, BView *child, float weight) 338 \brief Undocumented public method 339 340 \param index Undocumented 341 \param child Undocumented 342 \param weight Undocumented 343 344 \return Undocumented 345 \retval <value> Undocumented 346 347 \since Haiku R1 348*/ 349 350 351/*! 352 \fn bool BSplitView::AddChild(BLayoutItem *child) 353 \brief Undocumented public method 354 355 \param child Undocumented 356 357 \return Undocumented 358 \retval <value> Undocumented 359 360 \since Haiku R1 361*/ 362 363 364/*! 365 \fn bool BSplitView::AddChild(BLayoutItem *child, float weight) 366 \brief Undocumented public method 367 368 \param child Undocumented 369 \param weight Undocumented 370 371 \return Undocumented 372 \retval <value> Undocumented 373 374 \since Haiku R1 375*/ 376 377 378/*! 379 \fn bool BSplitView::AddChild(int32 index, BLayoutItem *child, float weight) 380 \brief Undocumented public method 381 382 \param index Undocumented 383 \param child Undocumented 384 \param weight Undocumented 385 386 \return Undocumented 387 \retval <value> Undocumented 388 389 \since Haiku R1 390*/ 391 392 393/*! 394 \fn virtual virtual void BSplitView::AttachedToWindow() 395 \brief Undocumented public method 396 397 \since Haiku R1 398*/ 399 400 401/*! 402 \fn virtual virtual void BSplitView::Draw(BRect updateRect) 403 \brief Undocumented public method 404 405 \param updateRect Undocumented 406 407 \since Haiku R1 408*/ 409 410 411/*! 412 \fn virtual virtual void BSplitView::DrawAfterChildren(BRect updateRect) 413 \brief Undocumented public method 414 415 \param updateRect Undocumented 416 417 \since Haiku R1 418*/ 419 420 421/*! 422 \fn virtual virtual void BSplitView::MouseDown(BPoint where) 423 \brief Undocumented public method 424 425 \param where Undocumented 426 427 \since Haiku R1 428*/ 429 430 431/*! 432 \fn virtual virtual void BSplitView::MouseUp(BPoint where) 433 \brief Undocumented public method 434 435 \param where Undocumented 436 437 \since Haiku R1 438*/ 439 440 441/*! 442 \fn virtual virtual void BSplitView::MouseMoved(BPoint where, uint32 transit, const BMessage *message) 443 \brief Undocumented public method 444 445 \param where Undocumented 446 \param transit Undocumented 447 \param message Undocumented 448 449 \since Haiku R1 450*/ 451 452 453/*! 454 \fn virtual virtual void BSplitView::MessageReceived(BMessage *message) 455 \brief Undocumented public method 456 457 \param message Undocumented 458 459 \since Haiku R1 460*/ 461 462 463/*! 464 \fn virtual virtual void BSplitView::SetLayout(BLayout *layout) 465 \brief Undocumented public method 466 467 \param layout Undocumented 468 469 \since Haiku R1 470*/ 471 472 473/*! 474 \fn virtual virtual status_t BSplitView::Archive(BMessage *into, bool deep=true) const 475 \brief Undocumented public method 476 477 \param into Undocumented 478 \param deep Undocumented 479 480 \return Undocumented 481 \retval <value> Undocumented 482 483 \since Haiku R1 484*/ 485 486 487/*! 488 \fn virtual virtual status_t BSplitView::Perform(perform_code d, void *arg) 489 \brief Undocumented public method 490 491 \param d Undocumented 492 \param arg Undocumented 493 494 \return Undocumented 495 \retval <value> Undocumented 496 497 \since Haiku R1 498*/ 499 500 501/*! 502 \fn static static BArchivable* BSplitView::Instantiate(BMessage *from) 503 \brief Undocumented public method 504 505 \param from Undocumented 506 507 \return Undocumented 508 \retval <value> Undocumented 509 510 \since Haiku R1 511*/ 512 513 514/*! 515 \fn virtual virtual status_t BSplitView::AllArchived(BMessage *into) const 516 \brief Undocumented protected method 517 518 \param into Undocumented 519 520 \return Undocumented 521 \retval <value> Undocumented 522 523 \since Haiku R1 524*/ 525 526 527/*! 528 \fn virtual virtual status_t BSplitView::AllUnarchived(const BMessage *from) 529 \brief Undocumented protected method 530 531 \param from Undocumented 532 533 \return Undocumented 534 \retval <value> Undocumented 535 536 \since Haiku R1 537*/ 538 539 540/*! 541 \fn virtual virtual void BSplitView::DrawSplitter(BRect frame, const BRect &updateRect, orientation orientation, bool pressed) 542 \brief Undocumented protected method 543 544 \param frame Undocumented 545 \param updateRect Undocumented 546 \param orientation Undocumented 547 \param pressed Undocumented 548 549 \since Haiku R1 550*/ 551