From 676c618ad78eebd7d3d2cd62598117886e7d431b Mon Sep 17 00:00:00 2001 From: Alex Wilson Date: Fri, 9 Sep 2011 14:37:41 -0600 Subject: [PATCH] Add a little info to the BLayout docs. --- docs/user/interface/Layout.dox | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/user/interface/Layout.dox b/docs/user/interface/Layout.dox index 4345797137..a364396627 100644 --- a/docs/user/interface/Layout.dox +++ b/docs/user/interface/Layout.dox @@ -211,6 +211,8 @@ topLayout->AddItem(nestedLayoutWithView); \warning \a item is not deleted, you must delete it manually, or add it to another BLayout. + \warning \a item->View(), even when it is removed from the target view, + is not deleted. If you want it deleted, you must delete it yourself! \retval true success \retval false failure @@ -501,6 +503,11 @@ topLayout->AddItem(nestedLayoutWithView); \param item The BLayoutItem being removed. \param fromIndex The index where \a item used to reside. + When this hook is called, \a item is not yet completely removed. It can + no longer be accessed with LayoutItemAt(), nor does it contribute to the + value of CountItems(), but the item has not yet had its ItemDetached() + hook called. + \note This is a good time to delete the data you've attached to \a item via BLayoutItem::SetLayoutData(). */