1e9f38ccaSNiels Sascha Reedijk/* 2*6758018aSNiels Sascha Reedijk * Copyright 2020 Haiku, Inc. All rights reserved. 3e9f38ccaSNiels Sascha Reedijk * Distributed under the terms of the MIT License. 4e9f38ccaSNiels Sascha Reedijk * 5e9f38ccaSNiels Sascha Reedijk * Authors: 6*6758018aSNiels Sascha Reedijk * Niels Sascha Reedijk, niels.reedijk@gmail.com 7e9f38ccaSNiels Sascha Reedijk * 8e9f38ccaSNiels Sascha Reedijk * Corresponds to: 9e9f38ccaSNiels Sascha Reedijk * headers/os/interface/AbstractLayoutItem.h hrev43514 10e9f38ccaSNiels Sascha Reedijk * src/kits/interface/AbstractLayoutItem.cpp hrev43514 11e9f38ccaSNiels Sascha Reedijk */ 12e9f38ccaSNiels Sascha Reedijk 13e9f38ccaSNiels Sascha Reedijk 14*6758018aSNiels Sascha Reedijk// The AbstractLayoutItem.h and its BAbstractLayoutItem is considered entirely 15*6758018aSNiels Sascha Reedijk// internal, and as such should not appear in the documentation. 16*6758018aSNiels Sascha Reedijk 17*6758018aSNiels Sascha Reedijk 18*6758018aSNiels Sascha Reedijk//! \cond INTERNAL 19*6758018aSNiels Sascha Reedijk 20*6758018aSNiels Sascha Reedijk 21e9f38ccaSNiels Sascha Reedijk/*! 22e9f38ccaSNiels Sascha Reedijk \file AbstractLayoutItem.h 23e9f38ccaSNiels Sascha Reedijk \ingroup layout 24*6758018aSNiels Sascha Reedijk \brief Provides the BAbstractLayoutItem class. 25e9f38ccaSNiels Sascha Reedijk 26e9f38ccaSNiels Sascha Reedijk \since Haiku R1 27e9f38ccaSNiels Sascha Reedijk*/ 28e9f38ccaSNiels Sascha Reedijk 29e9f38ccaSNiels Sascha Reedijk 30e9f38ccaSNiels Sascha Reedijk/*! 31e9f38ccaSNiels Sascha Reedijk \class BAbstractLayoutItem 32e9f38ccaSNiels Sascha Reedijk \ingroup layout 33e9f38ccaSNiels Sascha Reedijk \ingroup libbe 34*6758018aSNiels Sascha Reedijk \brief Internal base class for various layouts. 35e9f38ccaSNiels Sascha Reedijk 36e9f38ccaSNiels Sascha Reedijk \since Haiku R1 37e9f38ccaSNiels Sascha Reedijk*/ 38e9f38ccaSNiels Sascha Reedijk 39e9f38ccaSNiels Sascha Reedijk 40e9f38ccaSNiels Sascha Reedijk/*! 41e9f38ccaSNiels Sascha Reedijk \fn BAbstractLayoutItem::BAbstractLayoutItem() 42e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 43e9f38ccaSNiels Sascha Reedijk 44e9f38ccaSNiels Sascha Reedijk \return Undocumented 45e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 46e9f38ccaSNiels Sascha Reedijk 47e9f38ccaSNiels Sascha Reedijk \since Haiku R1 48e9f38ccaSNiels Sascha Reedijk*/ 49e9f38ccaSNiels Sascha Reedijk 50e9f38ccaSNiels Sascha Reedijk 51e9f38ccaSNiels Sascha Reedijk/*! 52e9f38ccaSNiels Sascha Reedijk \fn BAbstractLayoutItem::BAbstractLayoutItem(BMessage *from) 53e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 54e9f38ccaSNiels Sascha Reedijk 55e9f38ccaSNiels Sascha Reedijk \param from Undocumented 56e9f38ccaSNiels Sascha Reedijk 57e9f38ccaSNiels Sascha Reedijk \return Undocumented 58e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 59e9f38ccaSNiels Sascha Reedijk 60e9f38ccaSNiels Sascha Reedijk \since Haiku R1 61e9f38ccaSNiels Sascha Reedijk*/ 62e9f38ccaSNiels Sascha Reedijk 63e9f38ccaSNiels Sascha Reedijk 64e9f38ccaSNiels Sascha Reedijk/*! 65e9f38ccaSNiels Sascha Reedijk \fn virtual BAbstractLayoutItem::~BAbstractLayoutItem() 66e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 67e9f38ccaSNiels Sascha Reedijk 68e9f38ccaSNiels Sascha Reedijk \return Undocumented 69e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 70e9f38ccaSNiels Sascha Reedijk 71e9f38ccaSNiels Sascha Reedijk \since Haiku R1 72e9f38ccaSNiels Sascha Reedijk*/ 73e9f38ccaSNiels Sascha Reedijk 74e9f38ccaSNiels Sascha Reedijk 75e9f38ccaSNiels Sascha Reedijk/*! 76e9f38ccaSNiels Sascha Reedijk \fn virtual BSize BAbstractLayoutItem::MinSize() 77e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 78e9f38ccaSNiels Sascha Reedijk 79e9f38ccaSNiels Sascha Reedijk \return Undocumented 80e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 81e9f38ccaSNiels Sascha Reedijk 82e9f38ccaSNiels Sascha Reedijk \since Haiku R1 83e9f38ccaSNiels Sascha Reedijk*/ 84e9f38ccaSNiels Sascha Reedijk 85e9f38ccaSNiels Sascha Reedijk 86e9f38ccaSNiels Sascha Reedijk/*! 87e9f38ccaSNiels Sascha Reedijk \fn virtual BSize BAbstractLayoutItem::MaxSize() 88e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 89e9f38ccaSNiels Sascha Reedijk 90e9f38ccaSNiels Sascha Reedijk \return Undocumented 91e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 92e9f38ccaSNiels Sascha Reedijk 93e9f38ccaSNiels Sascha Reedijk \since Haiku R1 94e9f38ccaSNiels Sascha Reedijk*/ 95e9f38ccaSNiels Sascha Reedijk 96e9f38ccaSNiels Sascha Reedijk 97e9f38ccaSNiels Sascha Reedijk/*! 98e9f38ccaSNiels Sascha Reedijk \fn virtual BSize BAbstractLayoutItem::PreferredSize() 99e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 100e9f38ccaSNiels Sascha Reedijk 101e9f38ccaSNiels Sascha Reedijk \return Undocumented 102e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 103e9f38ccaSNiels Sascha Reedijk 104e9f38ccaSNiels Sascha Reedijk \since Haiku R1 105e9f38ccaSNiels Sascha Reedijk*/ 106e9f38ccaSNiels Sascha Reedijk 107e9f38ccaSNiels Sascha Reedijk 108e9f38ccaSNiels Sascha Reedijk/*! 109e9f38ccaSNiels Sascha Reedijk \fn virtual BAlignment BAbstractLayoutItem::Alignment() 110e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 111e9f38ccaSNiels Sascha Reedijk 112e9f38ccaSNiels Sascha Reedijk \return Undocumented 113e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 114e9f38ccaSNiels Sascha Reedijk 115e9f38ccaSNiels Sascha Reedijk \since Haiku R1 116e9f38ccaSNiels Sascha Reedijk*/ 117e9f38ccaSNiels Sascha Reedijk 118e9f38ccaSNiels Sascha Reedijk 119e9f38ccaSNiels Sascha Reedijk/*! 120e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::SetExplicitMinSize(BSize size) 121e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 122e9f38ccaSNiels Sascha Reedijk 123e9f38ccaSNiels Sascha Reedijk \param size Undocumented 124e9f38ccaSNiels Sascha Reedijk 125e9f38ccaSNiels Sascha Reedijk \since Haiku R1 126e9f38ccaSNiels Sascha Reedijk*/ 127e9f38ccaSNiels Sascha Reedijk 128e9f38ccaSNiels Sascha Reedijk 129e9f38ccaSNiels Sascha Reedijk/*! 130e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::SetExplicitMaxSize(BSize size) 131e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 132e9f38ccaSNiels Sascha Reedijk 133e9f38ccaSNiels Sascha Reedijk \param size Undocumented 134e9f38ccaSNiels Sascha Reedijk 135e9f38ccaSNiels Sascha Reedijk \since Haiku R1 136e9f38ccaSNiels Sascha Reedijk*/ 137e9f38ccaSNiels Sascha Reedijk 138e9f38ccaSNiels Sascha Reedijk 139e9f38ccaSNiels Sascha Reedijk/*! 140e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::SetExplicitPreferredSize(BSize size) 141e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 142e9f38ccaSNiels Sascha Reedijk 143e9f38ccaSNiels Sascha Reedijk \param size Undocumented 144e9f38ccaSNiels Sascha Reedijk 145e9f38ccaSNiels Sascha Reedijk \since Haiku R1 146e9f38ccaSNiels Sascha Reedijk*/ 147e9f38ccaSNiels Sascha Reedijk 148e9f38ccaSNiels Sascha Reedijk 149e9f38ccaSNiels Sascha Reedijk/*! 150e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::SetExplicitAlignment(BAlignment alignment) 151e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 152e9f38ccaSNiels Sascha Reedijk 153e9f38ccaSNiels Sascha Reedijk \param alignment Undocumented 154e9f38ccaSNiels Sascha Reedijk 155e9f38ccaSNiels Sascha Reedijk \since Haiku R1 156e9f38ccaSNiels Sascha Reedijk*/ 157e9f38ccaSNiels Sascha Reedijk 158e9f38ccaSNiels Sascha Reedijk 159e9f38ccaSNiels Sascha Reedijk/*! 160e9f38ccaSNiels Sascha Reedijk \fn virtual BSize BAbstractLayoutItem::BaseMinSize() 161e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 162e9f38ccaSNiels Sascha Reedijk 163e9f38ccaSNiels Sascha Reedijk \return Undocumented 164e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 165e9f38ccaSNiels Sascha Reedijk 166e9f38ccaSNiels Sascha Reedijk \since Haiku R1 167e9f38ccaSNiels Sascha Reedijk*/ 168e9f38ccaSNiels Sascha Reedijk 169e9f38ccaSNiels Sascha Reedijk 170e9f38ccaSNiels Sascha Reedijk/*! 171e9f38ccaSNiels Sascha Reedijk \fn virtual BSize BAbstractLayoutItem::BaseMaxSize() 172e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 173e9f38ccaSNiels Sascha Reedijk 174e9f38ccaSNiels Sascha Reedijk \return Undocumented 175e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 176e9f38ccaSNiels Sascha Reedijk 177e9f38ccaSNiels Sascha Reedijk \since Haiku R1 178e9f38ccaSNiels Sascha Reedijk*/ 179e9f38ccaSNiels Sascha Reedijk 180e9f38ccaSNiels Sascha Reedijk 181e9f38ccaSNiels Sascha Reedijk/*! 182e9f38ccaSNiels Sascha Reedijk \fn virtual BSize BAbstractLayoutItem::BasePreferredSize() 183e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 184e9f38ccaSNiels Sascha Reedijk 185e9f38ccaSNiels Sascha Reedijk \return Undocumented 186e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 187e9f38ccaSNiels Sascha Reedijk 188e9f38ccaSNiels Sascha Reedijk \since Haiku R1 189e9f38ccaSNiels Sascha Reedijk*/ 190e9f38ccaSNiels Sascha Reedijk 191e9f38ccaSNiels Sascha Reedijk 192e9f38ccaSNiels Sascha Reedijk/*! 193e9f38ccaSNiels Sascha Reedijk \fn virtual BAlignment BAbstractLayoutItem::BaseAlignment() 194e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 195e9f38ccaSNiels Sascha Reedijk 196e9f38ccaSNiels Sascha Reedijk \return Undocumented 197e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 198e9f38ccaSNiels Sascha Reedijk 199e9f38ccaSNiels Sascha Reedijk \since Haiku R1 200e9f38ccaSNiels Sascha Reedijk*/ 201e9f38ccaSNiels Sascha Reedijk 202e9f38ccaSNiels Sascha Reedijk 203e9f38ccaSNiels Sascha Reedijk/*! 204e9f38ccaSNiels Sascha Reedijk \fn virtual status_t BAbstractLayoutItem::Archive(BMessage *into, bool deep=true) const 205e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 206e9f38ccaSNiels Sascha Reedijk 207e9f38ccaSNiels Sascha Reedijk \param into Undocumented 208e9f38ccaSNiels Sascha Reedijk \param deep Undocumented 209e9f38ccaSNiels Sascha Reedijk 210e9f38ccaSNiels Sascha Reedijk \return Undocumented 211e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 212e9f38ccaSNiels Sascha Reedijk 213e9f38ccaSNiels Sascha Reedijk \since Haiku R1 214e9f38ccaSNiels Sascha Reedijk*/ 215e9f38ccaSNiels Sascha Reedijk 216e9f38ccaSNiels Sascha Reedijk 217e9f38ccaSNiels Sascha Reedijk/*! 218e9f38ccaSNiels Sascha Reedijk \fn virtual status_t BAbstractLayoutItem::Perform(perform_code d, void *arg) 219e9f38ccaSNiels Sascha Reedijk \brief Undocumented public method 220e9f38ccaSNiels Sascha Reedijk 221e9f38ccaSNiels Sascha Reedijk \param d Undocumented 222e9f38ccaSNiels Sascha Reedijk \param arg Undocumented 223e9f38ccaSNiels Sascha Reedijk 224e9f38ccaSNiels Sascha Reedijk \return Undocumented 225e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 226e9f38ccaSNiels Sascha Reedijk 227e9f38ccaSNiels Sascha Reedijk \since Haiku R1 228e9f38ccaSNiels Sascha Reedijk*/ 229e9f38ccaSNiels Sascha Reedijk 230e9f38ccaSNiels Sascha Reedijk 231e9f38ccaSNiels Sascha Reedijk/*! 232e9f38ccaSNiels Sascha Reedijk \fn virtual status_t BAbstractLayoutItem::AllUnarchived(const BMessage *archive) 233e9f38ccaSNiels Sascha Reedijk \brief Undocumented protected method 234e9f38ccaSNiels Sascha Reedijk 235e9f38ccaSNiels Sascha Reedijk \param archive Undocumented 236e9f38ccaSNiels Sascha Reedijk 237e9f38ccaSNiels Sascha Reedijk \return Undocumented 238e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 239e9f38ccaSNiels Sascha Reedijk 240e9f38ccaSNiels Sascha Reedijk \since Haiku R1 241e9f38ccaSNiels Sascha Reedijk*/ 242e9f38ccaSNiels Sascha Reedijk 243e9f38ccaSNiels Sascha Reedijk 244e9f38ccaSNiels Sascha Reedijk/*! 245e9f38ccaSNiels Sascha Reedijk \fn virtual status_t BAbstractLayoutItem::AllArchived(BMessage *archive) const 246e9f38ccaSNiels Sascha Reedijk \brief Undocumented protected method 247e9f38ccaSNiels Sascha Reedijk 248e9f38ccaSNiels Sascha Reedijk \param archive Undocumented 249e9f38ccaSNiels Sascha Reedijk 250e9f38ccaSNiels Sascha Reedijk \return Undocumented 251e9f38ccaSNiels Sascha Reedijk \retval <value> Undocumented 252e9f38ccaSNiels Sascha Reedijk 253e9f38ccaSNiels Sascha Reedijk \since Haiku R1 254e9f38ccaSNiels Sascha Reedijk*/ 255e9f38ccaSNiels Sascha Reedijk 256e9f38ccaSNiels Sascha Reedijk 257e9f38ccaSNiels Sascha Reedijk/*! 258e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::LayoutInvalidated(bool children) 259e9f38ccaSNiels Sascha Reedijk \brief Undocumented protected method 260e9f38ccaSNiels Sascha Reedijk 261e9f38ccaSNiels Sascha Reedijk \param children Undocumented 262e9f38ccaSNiels Sascha Reedijk 263e9f38ccaSNiels Sascha Reedijk \since Haiku R1 264e9f38ccaSNiels Sascha Reedijk*/ 265e9f38ccaSNiels Sascha Reedijk 266e9f38ccaSNiels Sascha Reedijk 267e9f38ccaSNiels Sascha Reedijk/*! 268e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::AttachedToLayout() 269e9f38ccaSNiels Sascha Reedijk \brief Undocumented protected method 270e9f38ccaSNiels Sascha Reedijk 271e9f38ccaSNiels Sascha Reedijk \since Haiku R1 272e9f38ccaSNiels Sascha Reedijk*/ 273e9f38ccaSNiels Sascha Reedijk 274e9f38ccaSNiels Sascha Reedijk 275e9f38ccaSNiels Sascha Reedijk/*! 276e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::DetachedFromLayout(BLayout *layout) 277e9f38ccaSNiels Sascha Reedijk \brief Undocumented protected method 278e9f38ccaSNiels Sascha Reedijk 279e9f38ccaSNiels Sascha Reedijk \param layout Undocumented 280e9f38ccaSNiels Sascha Reedijk 281e9f38ccaSNiels Sascha Reedijk \since Haiku R1 282e9f38ccaSNiels Sascha Reedijk*/ 283e9f38ccaSNiels Sascha Reedijk 284e9f38ccaSNiels Sascha Reedijk 285e9f38ccaSNiels Sascha Reedijk/*! 286e9f38ccaSNiels Sascha Reedijk \fn virtual void BAbstractLayoutItem::AncestorVisibilityChanged(bool shown) 287e9f38ccaSNiels Sascha Reedijk \brief Undocumented protected method 288e9f38ccaSNiels Sascha Reedijk 289e9f38ccaSNiels Sascha Reedijk \param shown Undocumented 290e9f38ccaSNiels Sascha Reedijk 291e9f38ccaSNiels Sascha Reedijk \since Haiku R1 292e9f38ccaSNiels Sascha Reedijk*/ 293*6758018aSNiels Sascha Reedijk 294*6758018aSNiels Sascha Reedijk//! \endcond INTERNAL 295