a33f8fbdec
* Some new classes documented * Screenshots for the interface kit controls * A lot of typo fixes * Some css tweaks This has some backporting to the current version of Doxygen, since there are experiments to get coloring similar to the one in the Be Book that will hopefully be upstreamed in Doxygen. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@42608 a95241bf-73f2-0310-859d-f6bbb57e9c96
157 lines
4.6 KiB
Plaintext
157 lines
4.6 KiB
Plaintext
/*
|
|
* Copyright 2010, Haiku, Inc. All Rights Reserved.
|
|
* Distributed under the terms of the MIT License.
|
|
*
|
|
* Documentation by:
|
|
* Alex Wilson <yourpalal2@gmail.com>
|
|
* Corresponds to:
|
|
* /trunk/headers/os/interface/GroupLayout.h rev 38207
|
|
* /trunk/src/kits/interface/GroupLayout.cpp rev 38207
|
|
*/
|
|
|
|
|
|
/*! \file GroupLayout.h
|
|
Describes the BGroupLayout class
|
|
*/
|
|
|
|
|
|
/*! \class BGroupLayout
|
|
\ingroup interface
|
|
\ingroup layout
|
|
\ingroup libbe
|
|
\brief The BGroupLayout class is a simple BLayout subclass that
|
|
arranges the items it holds within a vertical or horizontal box.
|
|
|
|
In a horizontal BGroupLayout, each BLayoutItem is given the same vertical
|
|
area, but different horizontal areas. In a vertical BGroupLayout, each
|
|
BLayoutItem is given the same horizontal area, but different vertical areas.
|
|
Despite this, because of alignment and size constraints, the items in a
|
|
BGroupLayout may not all use the same vertical or horizontal area on screen.
|
|
Some BLayoutItems may have alignments that cause them to sit at the bottom
|
|
of the area they are given, for example. This is not a flaw or bug, but
|
|
something that you may come across when using this class.
|
|
|
|
In a BGroupLayout, each BLayoutItem or BView has a weight, the default
|
|
weight is \c 1.0f. When a BGroupLayout is not given enough space to satisfy
|
|
the minimum sizes of all items, then space is distributed according to
|
|
weight, while still attempting to satisfy minimum size constraints.
|
|
Weighting is scaled over the sum weight of all the items in this layout.
|
|
If a particular item has half of the sum weight of all items, it
|
|
will get half of the total space, unless this exceeds that item's maximum
|
|
size. If the space for an item exceeds the items maximum size, the excess
|
|
will be distributed to other items.
|
|
|
|
\warning This class is not yet finalized, if you use it in your software
|
|
assume that it will break some time in the future.
|
|
*/
|
|
|
|
|
|
/*! \fn BGroupLayout::BGroupLayout(enum orientation orientation, float spacing)
|
|
\brief Creates a new BGroupLayout.
|
|
|
|
\param orientation The #orientation of this BGroupLayout.
|
|
\param spacing The spacing between BLayoutItems in this BGroupLayout.
|
|
*/
|
|
|
|
|
|
/*! \fn BGroupLayout::~BGroupLayout()
|
|
\brief Destructor method.
|
|
|
|
Standard Destructor.
|
|
*/
|
|
|
|
|
|
/*! \fn BGroupLayout::BGroupLayout(BMessage* from)
|
|
\brief Archive constructor.
|
|
|
|
\param from The message to construct the BGroupLayout from.
|
|
*/
|
|
|
|
|
|
/*! \fn float BGroupLayout::Spacing() const
|
|
\brief Get the amount of spacing (in pixels) between each item.
|
|
*/
|
|
|
|
|
|
/*! \fn void BGroupLayout::SetSpacing(float spacing)
|
|
\brief Set the amount of spacing (in pixels) between each item.
|
|
*/
|
|
|
|
|
|
/*! \fn orientation BGroupLayout::Orientation() const
|
|
\brief Get the #orientation of this BGroupLayout.
|
|
*/
|
|
|
|
|
|
/*! \fn void BGroupLayout::SetOrientation(enum orientation orientation)
|
|
\brief Set the #orientation of this BGroupLayout.
|
|
\param orientation The new #orientation of this BGroupLayout.
|
|
*/
|
|
|
|
|
|
/*! \fn float BGroupLayout::ItemWeight(int32 index) const
|
|
\brief Get the weight of the item at \a index.
|
|
*/
|
|
|
|
|
|
/*! \fn void BGroupLayout::SetItemWeight(int32 index, float weight)
|
|
\brief Set the weight of the item at \a index.
|
|
*/
|
|
|
|
|
|
/*! \fn BLayoutItem* BGroupLayout::AddView(BView* child)
|
|
\brief Adds \a child to this layout as the last item. In a vertical
|
|
BGroupLayout, \a child will be on the right, in a horizontal
|
|
BGroupLayout, \a child will be at the bottom.
|
|
|
|
\a child will have a weight of \c 1.0f.
|
|
*/
|
|
|
|
|
|
/*! \fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child)
|
|
\brief Adds \a child to this layout at \a index.
|
|
|
|
\a child will have a weight of \c 1.0f.
|
|
*/
|
|
|
|
|
|
/*! \fn BLayoutItem* BGroupLayout::AddView(BView* child, float weight)
|
|
\brief Adds \a child to the end of this layout with a weight of
|
|
\a weight.
|
|
*/
|
|
|
|
|
|
/*! \fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child,
|
|
float weight)
|
|
\brief Adds \a child this layout at \a index with a weight of
|
|
\a weight.
|
|
*/
|
|
|
|
|
|
/*! \fn bool BGroupLayout::AddItem(BLayoutItem* item)
|
|
\brief Adds \a item to this layout as the last item. In a vertical
|
|
BGroupLayout, \a item will be on the right, in a horizontal
|
|
BGroupLayout, \a item will be at the bottom.
|
|
|
|
\a item will have a weight of \c 1.0f.
|
|
*/
|
|
|
|
|
|
/*! \fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item)
|
|
\brief Adds \a item to this layout at \a index.
|
|
|
|
\a item will have a weight of \c 1.0f.
|
|
*/
|
|
|
|
|
|
/*! \fn bool BGroupLayout::AddItem(BLayoutItem* item, float weight)
|
|
\brief Adds \a item to the end of this layout with a weight of
|
|
\a weight.
|
|
*/
|
|
|
|
|
|
/*! \fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item, float weight)
|
|
\brief Adds \a item this layout at \a index with a weight of
|
|
\a weight.
|
|
*/
|