Aren/haiku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update layout docs for LayoutInvalidated() changes.

Browse Source
This commit is contained in:
Alex Wilson 2011-10-22 22:30:52 -06:00
parent 9e9698bcd8
commit 7ab5610ba9
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/user/interface/Layout.dox
View File

@ -386,7 +386,7 @@ topLayout->AddItem(nestedLayoutWithView);
is given more or less space than it previously had, or an object in this
layout has had its InvalidateLayout() method called.
\see BView::InvalidateLayout() BLayoutItem::InvalidateLayout()
\sa BView::InvalidateLayout(), BLayoutItem::InvalidateLayout()
*/

22
docs/user/interface/LayoutItem.dox
View File

@ -256,9 +256,14 @@
/*!
\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.
If \a children is \c true, then you should also invalidate any child
objects.
Although this method is virtual, you should not override it in your classes,
override LayoutInvalidated() instead. This method will take care of calling
the InvalidateLayout() methods of affected views/layouts/items. However, if
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.
*/
@ -309,6 +314,19 @@
//! @{
/*!
\fn void BLayoutItem::LayoutInvalidated(bool children)
\brief Hook called from InvalidateLayout().
Override this method to clean out an cached layout info. It is good
practice to recreate such info only on demand, eg when MinSize() or friends
are called.
If \a children is \c true, then you should invalidate any information on
child objects as well, and propagate the invalidation to them.
*/
/*!
\fn void BLayoutItem::AttachedToLayout()
\brief Hook called when this object is attached to a BLayout (via