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

123 lines
2.5 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/CardView.h hrev49943
* src/kits/interface/CardView.cpp hrev49977
*/
/*!
\file CardView.h
\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 BCardView 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 BCardView
\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 Container view for a stack of alternating child views.
This class is a convencience class, that creates a BView with a BCardLayout
set up by default.
The card container holds zero or more child views and organizes them like a
stack of cards. Each child view is a card, and only one card can be on top,
meaning that it is visible and available for interaction by the user. When
there are no cards, or no card is on top, then the system's default gray
background is displayed.
\see BCardLayout for more information on how and when to use this
type of container.
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 BCardView::BCardView()
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 Creates a new card view.
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 BCardView::BCardView(const char *name)
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 Creates a new card view with the given \a name.
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 name The name for the card view.
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 BCardView::BCardView(BMessage *from)
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 Constructs a BCardView \a from an archive message.
This method is usually not called directly, if you want to build a
card view from an archived message you should call Instantiate() instead
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 view.
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 BCardView::~BCardView()
\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
*/
/*!
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 BCardView::SetLayout(BLayout *layout)
\brief Adopt a given card \a 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
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 layout The layout to set to. This must be a BCardLayout, or a
derivative. Any other layout types will be ignored.
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* BCardView::CardLayout() 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 underlying BCardLayout.
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 A pointer to the underlying 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
*/
/*!
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 BCardView::Perform(perform_code d, void *arg)
\brief Perform some action. (Internal Method)
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
Reimplemented from BView::Perform()
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
\fn static BArchivable* BCardView::Instantiate(BMessage *from)
\brief Instantiate the view from the 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
*/
Reference in New Issue Copy Permalink