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