A few updates to the BView docs (needed for BStringView)

This commit is contained in:
John Scipione
2014-12-04 17:56:53 -05:00
parent 5ae0cde363
commit 13c789f6c0
+52 -13
View File
@@ -1454,8 +1454,7 @@ SetViewColor(Parent()->ViewColor());
\brief Resizes the view to its preferred size keeping the position of the \brief Resizes the view to its preferred size keeping the position of the
left top corner constant. left top corner constant.
\warning It is not recommended to use this method for views that are part of It is not recommended to use this method for views that are part of a BLayout.
a BLayout.
\since BeOS R3 \since BeOS R3
*/ */
@@ -2175,16 +2174,20 @@ SetViewColor(Parent()->ViewColor());
By passing \c B_FONT_ALL to the \a mask parameter as is the default all font By passing \c B_FONT_ALL to the \a mask parameter as is the default all font
properties from \a font are set on the view. properties from \a font are set on the view.
\param font A pointer to a BFont object to set. \param font A pointer to a BFont object to set. Choices include:
\param mask A mask of the following values to determine what font properties to set: - \c be_plain_font
- \c B_FONT_FAMILY_AND_STYLE - \c be_bold_font
- \c B_FONT_SPACING - \c be_fixed_font
- \c B_FONT_SIZE \param mask A mask of the following values to determine what font properties
- \c B_FONT_ENCODING to set:
- \c B_FONT_SHEAR - \c B_FONT_FAMILY_AND_STYLE
- \c B_FONT_FACE - \c B_FONT_SPACING
- \c B_FONT_ROTATION - \c B_FONT_SIZE
- \c B_FONT_FLAGS - \c B_FONT_ENCODING
- \c B_FONT_SHEAR
- \c B_FONT_FACE
- \c B_FONT_ROTATION
- \c B_FONT_FLAGS
\since BeOS R3 \since BeOS R3
*/ */
@@ -3956,6 +3959,8 @@ SetViewColor(Parent()->ViewColor());
\fn BSize BView::MinSize() \fn BSize BView::MinSize()
\brief Return the minimum size of the view. \brief Return the minimum size of the view.
This is only meaningful if the view is part of a BLayout.
\return The minimum size of the view as a BSize. \return The minimum size of the view as a BSize.
\sa BAbstractLayout::MinSize() \sa BAbstractLayout::MinSize()
@@ -3968,6 +3973,8 @@ SetViewColor(Parent()->ViewColor());
\fn BSize BView::MaxSize() \fn BSize BView::MaxSize()
\brief Return the maximum size of the view. \brief Return the maximum size of the view.
This is only meaningful if the view is part of a BLayout.
\return The maximum size of the view as a BSize. \return The maximum size of the view as a BSize.
\sa BAbstractLayout::MaxSize() \sa BAbstractLayout::MaxSize()
@@ -3980,6 +3987,8 @@ SetViewColor(Parent()->ViewColor());
\fn BSize BView::PreferredSize() \fn BSize BView::PreferredSize()
\brief Return the preferred size of the view. \brief Return the preferred size of the view.
This is only meaningful if the view is part of a BLayout.
\return The preferred size of the view as a BSize. \return The preferred size of the view as a BSize.
\sa BAbstractLayout::PreferredSize() \sa BAbstractLayout::PreferredSize()
@@ -3992,6 +4001,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::SetExplicitMinSize(BSize size) \fn void BView::SetExplicitMinSize(BSize size)
\brief Set this view's min size, to be used by MinSize(). \brief Set this view's min size, to be used by MinSize().
This is only meaningful if the view is part of a BLayout.
\sa BAbstractLayout::SetExplicitMinSize() \sa BAbstractLayout::SetExplicitMinSize()
\since Haiku R1 \since Haiku R1
@@ -4002,6 +4013,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::SetExplicitMaxSize(BSize size) \fn void BView::SetExplicitMaxSize(BSize size)
\brief Set this view's max size, to be used by MaxSize(). \brief Set this view's max size, to be used by MaxSize().
This is only meaningful if the view is part of a BLayout.
\sa BAbstractLayout::SetExplicitMaxSize() \sa BAbstractLayout::SetExplicitMaxSize()
\since Haiku R1 \since Haiku R1
@@ -4012,6 +4025,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::SetExplicitPreferredSize(BSize size) \fn void BView::SetExplicitPreferredSize(BSize size)
\brief Set this view's preferred size, to be used by PreferredSize(). \brief Set this view's preferred size, to be used by PreferredSize().
This is only meaningful if the view is part of a BLayout.
\sa BAbstractLayout::SetExplicitPreferredSize() \sa BAbstractLayout::SetExplicitPreferredSize()
\since Haiku R1 \since Haiku R1
@@ -4022,6 +4037,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::SetExplicitAlignment(BAlignment alignment) \fn void BView::SetExplicitAlignment(BAlignment alignment)
\brief Set this view's alignment, to be used by Alignment(). \brief Set this view's alignment, to be used by Alignment().
This is only meaningful if the view is part of a BLayout.
\sa BAbstractLayout::SetExplicitAlignment() \sa BAbstractLayout::SetExplicitAlignment()
\since Haiku R1 \since Haiku R1
@@ -4032,6 +4049,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::SetLayout(BLayout* layout) \fn void BView::SetLayout(BLayout* layout)
\brief Sets the \a layout of the view. \brief Sets the \a layout of the view.
This is only meaningful if the view is part of a BLayout.
\param layout The \a layout to set. \param layout The \a layout to set.
\since Haiku R1 \since Haiku R1
@@ -4042,6 +4061,8 @@ SetViewColor(Parent()->ViewColor());
\fn BLayout* BView::GetLayout() const \fn BLayout* BView::GetLayout() const
\brief Get the layout of the view. \brief Get the layout of the view.
This is only meaningful if the view is part of a BLayout.
\returns The layout of the view. \returns The layout of the view.
\since Haiku R1 \since Haiku R1
@@ -4052,6 +4073,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::InvalidateLayout(bool descendants) \fn void BView::InvalidateLayout(bool descendants)
\brief Invalidate layout. \brief Invalidate layout.
This is only meaningful if the view is part of a BLayout.
\param descendants Also invalidate its children views. \param descendants Also invalidate its children views.
\since Haiku R1 \since Haiku R1
@@ -4062,6 +4085,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::EnableLayoutInvalidation() \fn void BView::EnableLayoutInvalidation()
\brief Enable layout invalidation. \brief Enable layout invalidation.
This is only meaningful if the view is part of a BLayout.
\since Haiku R1 \since Haiku R1
*/ */
@@ -4070,6 +4095,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::DisableLayoutInvalidation() \fn void BView::DisableLayoutInvalidation()
\brief Disable layout invalidation. \brief Disable layout invalidation.
This is only meaningful if the view is part of a BLayout.
\since Haiku R1 \since Haiku R1
*/ */
@@ -4078,6 +4105,8 @@ SetViewColor(Parent()->ViewColor());
\fn bool BView::IsLayoutInvalidationDisabled() \fn bool BView::IsLayoutInvalidationDisabled()
\brief Returns whether or not layout invalidation is disabled. \brief Returns whether or not layout invalidation is disabled.
This is only meaningful if the view is part of a BLayout.
\return \c true of layout invalidation is disabled, \c false otherwise. \return \c true of layout invalidation is disabled, \c false otherwise.
\since Haiku R1 \since Haiku R1
@@ -4088,6 +4117,8 @@ SetViewColor(Parent()->ViewColor());
\fn bool BView::IsLayoutValid() const \fn bool BView::IsLayoutValid() const
\brief Returns whether or not the layout is valid. \brief Returns whether or not the layout is valid.
This is only meaningful if the view is part of a BLayout.
\brief Returns \c true if the layout is valid, \c false otherwise. \brief Returns \c true if the layout is valid, \c false otherwise.
\since Haiku R1 \since Haiku R1
@@ -4099,12 +4130,14 @@ SetViewColor(Parent()->ViewColor());
\brief Service call for BView derived classes re-enabling \brief Service call for BView derived classes re-enabling
InvalidateLayout() notifications. InvalidateLayout() notifications.
BLayout and BView will avoid calling InvalidateLayout on views that have BLayout and BView will avoid calling InvalidateLayout on views that have
already been invalidated, but if the view caches internal layout information already been invalidated, but if the view caches internal layout information
which it updates in methods other than DoLayout(), it has to invoke this which it updates in methods other than DoLayout(), it has to invoke this
method, when it has done so, since otherwise the information might become method, when it has done so, since otherwise the information might become
obsolete without the layout noticing. obsolete without the layout noticing.
This is only meaningful if the view is part of a BLayout.
\since Haiku R1 \since Haiku R1
*/ */
@@ -4113,6 +4146,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::Layout(bool force) \fn void BView::Layout(bool force)
\brief Layout the view. \brief Layout the view.
This is only meaningful if the view is part of a BLayout.
\param force If \c true layout even if valid. \param force If \c true layout even if valid.
\since Haiku R1 \since Haiku R1
@@ -4123,6 +4158,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::Relayout() \fn void BView::Relayout()
\brief Relayout the view. \brief Relayout the view.
This is only meaningful if the view is part of a BLayout.
\since Haiku R1 \since Haiku R1
*/ */
@@ -4131,6 +4168,8 @@ SetViewColor(Parent()->ViewColor());
\fn void BView::DoLayout() \fn void BView::DoLayout()
\brief Layout view within the layout context. \brief Layout view within the layout context.
This is only meaningful if the view is part of a BLayout.
\since Haiku R1 \since Haiku R1
*/ */