IK documentation update
* Add \since directive to each method. * Add documentation for BScrollBar and BScrollView classes. * Title Case group titles. * Some other minor documentation updates.
This commit is contained in:
@@ -20,7 +20,8 @@
|
||||
*/
|
||||
|
||||
|
||||
/*! \class BGroupLayout
|
||||
/*!
|
||||
\class BGroupLayout
|
||||
\ingroup interface
|
||||
\ingroup layout
|
||||
\ingroup libbe
|
||||
@@ -47,7 +48,9 @@
|
||||
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.
|
||||
assume that it will break some time in the future.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
@@ -57,6 +60,8 @@
|
||||
|
||||
\param orientation The orientation of this BGroupLayout.
|
||||
\param spacing The spacing between BLayoutItems in this BGroupLayout.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
@@ -65,6 +70,8 @@
|
||||
\brief Destructor method.
|
||||
|
||||
Standard Destructor.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
@@ -73,53 +80,70 @@
|
||||
\brief Archive constructor.
|
||||
|
||||
\param from The message to construct the BGroupLayout from.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn float BGroupLayout::Spacing() const
|
||||
\brief Get the amount of spacing (in pixels) between each item.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BGroupLayout::SetSpacing(float spacing)
|
||||
\brief Set the amount of spacing (in pixels) between each item.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn orientation BGroupLayout::Orientation() const
|
||||
\brief Get the #orientation of this BGroupLayout.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BGroupLayout::SetOrientation(orientation orientation)
|
||||
\brief Set the #orientation of this BGroupLayout.
|
||||
|
||||
\param orientation The new #orientation of this BGroupLayout.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn float BGroupLayout::ItemWeight(int32 index) const
|
||||
\brief Get the weight of the item at \a index.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn void BGroupLayout::SetItemWeight(int32 index, float weight)
|
||||
\brief Set the weight of the item at \a index.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\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.
|
||||
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.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
@@ -128,6 +152,8 @@
|
||||
\brief Adds \a child to this layout at \a index.
|
||||
|
||||
\a child will have a weight of \c 1.0f.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
@@ -135,24 +161,30 @@
|
||||
\fn BLayoutItem* BGroupLayout::AddView(BView* child, float weight)
|
||||
\brief Adds \a child to the end of this layout with a weight of
|
||||
\a weight.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn BLayoutItem* BGroupLayout::AddView(int32 index, BView* child,
|
||||
\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.
|
||||
\a weight.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\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.
|
||||
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.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
@@ -161,18 +193,25 @@
|
||||
\brief Adds \a item to this layout at \a index.
|
||||
|
||||
\a item will have a weight of \c 1.0f.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BGroupLayout::AddItem(BLayoutItem* item, float weight)
|
||||
\brief Adds \a item to the end of this layout with a weight of
|
||||
\a weight.
|
||||
\a weight.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
|
||||
/*!
|
||||
\fn bool BGroupLayout::AddItem(int32 index, BLayoutItem* item, float 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.
|
||||
\a weight.
|
||||
|
||||
\since Haiku R1
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user