i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

IK documentation update

Browse Source 
* 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:
John Scipione
2014-06-13 17:44:22 -04:00
parent 1f424632be
commit 47852bff02
43 changed files with 5320 additions and 1277 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/interface/LayoutItem.dox
+78 -18
View File
@@ -34,6 +34,8 @@
\warning This class is not yet finalized, if you use it in your software
assume that it will break some time in the future.
\since Haiku R1
*/
@@ -42,12 +44,16 @@
\brief Archive constructor.
Creates a BLayoutItem from the \a archive message.
\since Haiku R1
*/
/*!
\fn BLayout* BLayoutItem::Layout() const
\brief Returns the BLayout this BLayoutItem resides in.
\since Haiku R1
*/
@@ -56,11 +62,13 @@
\brief Destructor method.
Standard Destructor.
\since Haiku R1
*/
/*!
\name Reporting size and alignment constraints to a BLayout
\name Reporting Size and Alignment Constraints to a BLayout
*/
@@ -70,18 +78,24 @@
/*!
\fn BSize BLayoutItem::MinSize() = 0
\brief Returns the minimum desirable size for this item.
\since Haiku R1
*/
/*!
\fn BSize BLayoutItem::MaxSize() = 0
\brief Returns the maximum desirable size for this item.
\since Haiku R1
*/
/*!
\fn BSize BLayoutItem::PreferredSize() = 0
\brief Returns the preferred size for this item.
\since Haiku R1
*/
@@ -94,6 +108,8 @@
for example, although each item recieves the same horizontal area, each item
can use that area differently, aligning to the left, right or center for
example.
\since Haiku R1
*/
@@ -103,6 +119,8 @@
dependent on its width.
\note By default, this method returns \c false.
\since Haiku R1
*/
@@ -117,6 +135,8 @@
\note It is prudent to compare \a min, \a max, \a preferred to \c NULL
before dereferencing them.
\since Haiku R1
*/
@@ -124,7 +144,7 @@
/*!
\name Overriding size constraints and alignment.
\name Overriding Size and Alignment Constraints
Although the explicit constraints placed on an item are not enforced by the
BLayoutItem class, all Haiku BLayoutItem subclasses will use the
@@ -132,6 +152,8 @@
in when reporting these constraints. It is recommended that all subclasses
do this as well, the BAbstractLayoutItem class provides any easy way to
include this behaviour in your class.
\since Haiku R1
*/
@@ -141,12 +163,16 @@
/*!
\fn void BLayoutItem::SetExplicitMinSize(BSize size) = 0
\brief Set this item's explicit min size, to be used in MinSize().
\since Haiku R1
*/
/*!
\fn void BLayoutItem::SetExplicitMaxSize(BSize size) = 0
\brief Set this item's explicit max size, to be used in MaxSize().
\since Haiku R1
*/
@@ -154,12 +180,16 @@
\fn void BLayoutItem::SetExplicitPreferredSize(BSize size) = 0
\brief Set this item's explicit preferred size, to be used in
PreferredSize().
\since Haiku R1
*/
/*!
\fn void BLayoutItem::SetExplicitAlignment(BAlignment alignment) = 0
\brief Set this item's explicit alignment, to be used in Alignment().
\since Haiku R1
*/
@@ -167,7 +197,7 @@
/*!
\name Getting and setting the visiblity of a BLayoutItem.
\name Getting/Setting the Visibility of a BLayoutItem
These methods take into account only the local visibility of this
item, not the visibility of its ancestors. \n
@@ -185,12 +215,16 @@
A simple implementation would return the last thing passed to SetVisible().
A more complex implementation may deal with a BView that could
be hidden in any number of ways.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::SetVisible(bool visible) = 0
\brief Set the local visibility of this item.
\since Haiku R1
*/
@@ -198,7 +232,7 @@
/*!
\name Getting and setting the current on-screen positioning of a BLayoutItem.
\name Getting/Setting Current On-Screen Positioning of a BLayoutItem
*/
@@ -208,7 +242,9 @@
/*!
\fn void BLayoutItem::AlignInFrame(BRect frame)
\brief Position this BLayoutItem within \a frame, given the value returned
by Alignment(), and the size constraints for this item.
by Alignment(), and the size constraints for this item.
\since Haiku R1
*/
@@ -218,6 +254,8 @@
The returned BRect is in the coordinate system of the target view of the
BLayout this item belongs to.
\since Haiku R1
*/
@@ -226,7 +264,9 @@
\brief Set the bounding frame of this item.
\a frame is in the coordinate system of the target view of the BLayout
that this item belongs to.
that this item belongs to.
\since Haiku R1
*/
@@ -236,17 +276,19 @@
/*!
\fn BView* BLayoutItem::View()
\brief Return the BView this item is representing, or \c NULL if it does not
represent any view.
represent any view.
When a BLayoutItem is added to a BLayout, this method is called, and the
returned BView will be added to the BLayout's target view.
\since Haiku R1
*/
/*!
\name Layout events and requests.
\name Layout Events and Requests
\brief These methods represent events or requests originating from a
These methods represent events or requests originating from a
BLayout. In some implementations they may be handled directly by this
BLayoutItem, but many implementations will forward these events to
another object.
@@ -259,7 +301,6 @@
/*!
\fn void BLayoutItem::InvalidateLayout(bool children = false)
\brief Invalidate the layout of this item, or the object it represents.
\param children Whether or not to invalidate children of this object.
Although this method is virtual, you should not override it in your classes,
override LayoutInvalidated() instead. This method will take care of calling
@@ -267,6 +308,10 @@
there is an object that is somehow connected to this one by means other than
the standard mechanisms provided by the Haiku API, you should use
the LayoutInvalidated() hook to do this.
\param children Whether or not to invalidate children of this object.
\since Haiku R1
*/
@@ -279,6 +324,8 @@
most cases. Assuming \c this->View() doesn't return \c NULL, the default
implementation calls Relayout() or Layout() on the value returned
by View().
\since Haiku R1
*/
@@ -286,9 +333,10 @@
/*!
\name Utility methods for BLayout subclasses
\brief Utility methods for the BLayout class to attach and retrieve
arbitrary data for a BLayoutItem.
\name Utility Methods for BLayout Subclasses
Utility methods for the BLayout class to attach and retrieve
arbitrary data for a BLayoutItem.
*/
@@ -300,6 +348,8 @@
\brief Retrieve arbitrary data attached to this BLayoutItem.
\note This method should only be called by a BLayout subclass.
\since Haiku R1
*/
@@ -308,6 +358,8 @@
\brief Attach arbitrary data to this BLayoutItem.
\note This method should only be called by a BLayout subclass.
\since Haiku R1
*/
@@ -332,35 +384,41 @@
If \a children is \c true, then you should invalidate any information on
child objects as well, and propagate the invalidation to them.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::AttachedToLayout()
\brief Hook called when this object is attached to a BLayout (via
BLayout::AddItem())
BLayout::AddItem())
\note You can find the BLayout you've been attached to with the Layout()
method.
method.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::DetachedFromLayout(BLayout* layout)
\brief Hook called when this object is attached to a BLayout (via
BLayout::RemoveItem())
BLayout::RemoveItem())
\warning You should not use this hook to reattach \c this to \a BLayout,
doing so will cause undefined behaviour (probably a crash).
doing so will cause undefined behaviour (probably a crash).
\param layout The BLayout you were previously attached to.
\since Haiku R1
*/
/*!
\fn void BLayoutItem::AncestorVisibilityChanged(bool shown)
\brief Hook called when this BLayoutItem's ancestors change visibility,
effectively hiding or showing this item.
effectively hiding or showing this item.
Implementations of this method should alter the onscreen visibility of this
item. I.E. if \a shown is \c false, nothing should be drawn to represent
@@ -370,6 +428,8 @@
IsVisible() method.
\param shown \c true to show, \c false to hide.
\since Haiku R1
*/