Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5b1ae51c6b
haiku/docs/user/interface/AbstractLayoutItem.dox

295 lines
4.8 KiB
Plaintext
Raw Normal View History

HaikuBook: fix accidental UTF16 encoding of AbstractLayoutItem.dox
2019-09-21 18:13:06 +03:00
/*
HaikuBook: add remaining layout class documentation This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-18 09:27:42 +03:00
* Copyright 2020 Haiku, Inc. All rights reserved.
HaikuBook: fix accidental UTF16 encoding of AbstractLayoutItem.dox
2019-09-21 18:13:06 +03:00
* Distributed under the terms of the MIT License.
*
* Authors:
HaikuBook: add remaining layout class documentation This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-18 09:27:42 +03:00
* Niels Sascha Reedijk, niels.reedijk@gmail.com
HaikuBook: fix accidental UTF16 encoding of AbstractLayoutItem.dox
2019-09-21 18:13:06 +03:00
*
* Corresponds to:
* headers/os/interface/AbstractLayoutItem.h hrev43514
* src/kits/interface/AbstractLayoutItem.cpp hrev43514
*/
HaikuBook: add remaining layout class documentation This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-18 09:27:42 +03:00
// The AbstractLayoutItem.h and its BAbstractLayoutItem is considered entirely
// internal, and as such should not appear in the documentation.
//! \cond INTERNAL
HaikuBook: fix accidental UTF16 encoding of AbstractLayoutItem.dox
2019-09-21 18:13:06 +03:00
/*!
\file AbstractLayoutItem.h
\ingroup layout
HaikuBook: add remaining layout class documentation This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-18 09:27:42 +03:00
\brief Provides the BAbstractLayoutItem class.
HaikuBook: fix accidental UTF16 encoding of AbstractLayoutItem.dox
2019-09-21 18:13:06 +03:00
\since Haiku R1
*/
/*!
\class BAbstractLayoutItem
\ingroup layout
\ingroup libbe
HaikuBook: add remaining layout class documentation This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-18 09:27:42 +03:00
\brief Internal base class for various layouts.
HaikuBook: fix accidental UTF16 encoding of AbstractLayoutItem.dox
2019-09-21 18:13:06 +03:00
\since Haiku R1
*/
/*!
\fn BAbstractLayoutItem::BAbstractLayoutItem()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn BAbstractLayoutItem::BAbstractLayoutItem(BMessage *from)
\brief Undocumented public method
\param from Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BAbstractLayoutItem::~BAbstractLayoutItem()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BSize BAbstractLayoutItem::MinSize()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BSize BAbstractLayoutItem::MaxSize()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BSize BAbstractLayoutItem::PreferredSize()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BAlignment BAbstractLayoutItem::Alignment()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::SetExplicitMinSize(BSize size)
\brief Undocumented public method
\param size Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::SetExplicitMaxSize(BSize size)
\brief Undocumented public method
\param size Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::SetExplicitPreferredSize(BSize size)
\brief Undocumented public method
\param size Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::SetExplicitAlignment(BAlignment alignment)
\brief Undocumented public method
\param alignment Undocumented
\since Haiku R1
*/
/*!
\fn virtual BSize BAbstractLayoutItem::BaseMinSize()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BSize BAbstractLayoutItem::BaseMaxSize()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BSize BAbstractLayoutItem::BasePreferredSize()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual BAlignment BAbstractLayoutItem::BaseAlignment()
\brief Undocumented public method
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual status_t BAbstractLayoutItem::Archive(BMessage *into, bool deep=true) const
\brief Undocumented public method
\param into Undocumented
\param deep Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual status_t BAbstractLayoutItem::Perform(perform_code d, void *arg)
\brief Undocumented public method
\param d Undocumented
\param arg Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual status_t BAbstractLayoutItem::AllUnarchived(const BMessage *archive)
\brief Undocumented protected method
\param archive Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual status_t BAbstractLayoutItem::AllArchived(BMessage *archive) const
\brief Undocumented protected method
\param archive Undocumented
\return Undocumented
\retval <value> Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::LayoutInvalidated(bool children)
\brief Undocumented protected method
\param children Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::AttachedToLayout()
\brief Undocumented protected method
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::DetachedFromLayout(BLayout *layout)
\brief Undocumented protected method
\param layout Undocumented
\since Haiku R1
*/
/*!
\fn virtual void BAbstractLayoutItem::AncestorVisibilityChanged(bool shown)
\brief Undocumented protected method
\param shown Undocumented
\since Haiku R1
*/
HaikuBook: add remaining layout class documentation This is the final contribution to #15368 * Tried to share more documentation in the various BLayoutBuilder classes * Add missing GridView, GroupView, SpaceLayoutItem * Also added AbstractLayoutItem, but hide the actual documentation behind an `INTERNAL` conditional block. This block identifier can be used to document parts of the API, to then hide them during a regular Doxygen run. * Do some cleanup on other layout classes; add missing members, etc. * The actual generated BLayoutBuilder::* html is a mess. I should investigate this at a later time. Especially the copied members seem to mix type definitions with member documentation. It is odd. Not unlikely to be a Doxygen bug. * The general documentation for the layout system could use an overhaul as well, but this is for later. Change-Id: I6db9ef105b4ae6de0f1ebb917f86f8b1c0d4ea2e Reviewed-on: https://review.haiku-os.org/c/haiku/+/2491 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-18 09:27:42 +03:00
//! \endcond INTERNAL
Reference in New Issue Copy Permalink