Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
856721d9fe
haiku/docs/user/interface/CardLayout.dox

272 lines
6.0 KiB
Plaintext
Raw Normal View History

HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
/*
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
* Copyright 2020 Haiku, Inc. All rights reserved.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
* Distributed under the terms of the MIT License.
*
* Authors:
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
* Niels Sascha Reedijk, niels.reedijk@gmail.com
*
* Reviewers:
* Adrien Destugues, pulkomandy@pulkomandy.tk
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
*
* Corresponds to:
* headers/os/interface/CardLayout.h hrev43514
* src/kits/interface/CardLayout.cpp hrev49019
*/
/*!
\file CardLayout.h
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\ingroup interface
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\ingroup layout
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Provides the BCardLayout class.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\class BCardLayout
\ingroup layout
\ingroup libbe
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief The BCardLayout class is a simple BLayout subclass that
arranges the items as a stack of cards with only one card being on top
and visible to the user.
Once you have set up the items in the container, you can select which one
is visible using the SetVisibleItem() methods on this class. When there is
no item on top, the system's default grey background is shown.
This view is useful when you have a number of pre-loaded UI elements, and
you want to be able to swap between them quickly, while retaining the
underlying state. The container itself will retain a fixed size, so from a
visual perspective, it is imperative that the items in the stack have
comparable dimensions.
An example usage is for a configuration wizard, where the user will need to
complete a number of steps to perform an action. Because you want to the
user to experience all these steps as a smooth flow within one window, you
can set up the individual pages as views, and add these as cards to the
card layout. Then you tie the \em Next and \em Previous buttons to switch
between the visible cards using the BCardLayout::SetVisible() methods.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn BCardLayout::BCardLayout()
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Create a new card layout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn BCardLayout::BCardLayout(BMessage *from)
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Constructs a BCardLayout \a from an archive message.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
This method is usually not called directly, if you want to build a
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
card layout from an archived message you should call Instantiate() instead
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
because it can handle errors properly.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\param from The \ref BMessage that contains the card layout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn virtual virtual BCardLayout::~BCardLayout()
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Destructor.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn BLayoutItem* BCardLayout::VisibleItem() const
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Get a pointer to the currently visible item.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\return This method returns a pointer to the currently visible
layout item, or \c NULL if there is no card visible.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn int32 BCardLayout::VisibleIndex() const
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Get the index of the currently visible item.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\return Returns the zero-based index, or -1 if there is no item visible.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn void BCardLayout::SetVisibleItem(int32 index)
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Set the current visible item to the item at \a index.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\param index This is a zero-based index for the item you want to display.
If the item does not exist (it is lower than 0 or it is higher than
the number of items), no item will be displayed and the view will reset
to the default grey background.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
\fn void BCardLayout::SetVisibleItem(BLayoutItem *item)
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\brief Set the current visible item to \a item.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\param item A pointer to an item that is already added to this
layout. When a reference to an item not on the stack, or \c NULL is
passed, then no item will be displayed and the view will reset to the
default grey background.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual BSize BCardLayout::BaseMinSize()
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual BSize BCardLayout::BaseMaxSize()
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual BSize BCardLayout::BasePreferredSize()
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual BAlignment BCardLayout::BaseAlignment()
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual bool BCardLayout::HasHeightForWidth()
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual void BCardLayout::GetHeightForWidth(float width, float *min, float *max, float *preferred)
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual status_t BCardLayout::Archive(BMessage *into, bool deep=true) const
\brief Archive this layout \a into a BMessage.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\param into The message to which to archive into.
\param deep When \c true, the children of this layout will also be added.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual status_t BCardLayout::Perform(perform_code d, void *arg)
\brief Overridden hook method from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn static BArchivable* BCardLayout::Instantiate(BMessage *from)
\brief Instantiate a BCardLayout object from message \a from.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual status_t BCardLayout::AllArchived(BMessage *archive) const
\brief Hook method overridden from BArchivable.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual status_t BCardLayout::AllUnarchived(const BMessage *from)
\brief Hook method overridden from BArchivable.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual status_t BCardLayout::ItemArchived(BMessage *into,
BLayoutItem *item, int32 index) const
\brief Hook method overridden from BArchivable.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual status_t BCardLayout::ItemUnarchived(const BMessage *from,
BLayoutItem *item, int32 index)
\brief Hook method overridden from BArchivable.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual void BCardLayout::LayoutInvalidated(bool children=false)
\brief Hook method overridden from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual void BCardLayout::DoLayout()
\brief Hook method overridden from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual bool BCardLayout::ItemAdded(BLayoutItem *item, int32 atIndex)
\brief Hook method overridden from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
/*!
HaikuBook: Add documentation for BCardLayout This adds documentation for BCardView, BCardLayout and BLayoutBuilder::Cards. There is also a bit of cleanup for the BSplitView documentation. It also makes explicit when a developer passes an invalid argument to BCardLayout::SetVisibleItem(), by making that a debugger() call. Change-Id: I17ac52cc773bb76c4f81beaa76f72af62a9e10f4 Reviewed-on: https://review.haiku-os.org/c/haiku/+/2460 Reviewed-by: waddlesplash <waddlesplash@gmail.com>
2020-04-06 23:05:24 +03:00
\fn virtual void BCardLayout::ItemRemoved(BLayoutItem *item, int32 fromIndex)
\brief Hook method overridden from BAbstractLayout.
HaikuBook: Add skeletons for various undocumented interface kit classes * BAbstractLayoutItem * BAffineTransform * BCardLayout * BCardView * BChannelControl * BChannelSlider * BDeskbar * BGridLayoutBuilder * BGridView * BGroupLayoutBuilder * BGroupView * BInput * BOptionControl * BSeparatorView * BSpaceLayoutItem * BSplitLayoutBuilder * BSplitView * BStatusBar
2019-09-20 09:34:29 +03:00
\since Haiku R1
*/
Reference in New Issue Copy Permalink