From 8c2c52ff670dd1c32ecb880be5610ca18526b402 Mon Sep 17 00:00:00 2001 From: John Scipione Date: Wed, 28 May 2014 12:14:09 -0400 Subject: [PATCH] BView docs: move description up, few updates. --- docs/user/interface/View.dox | 60 +++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 29 deletions(-) diff --git a/docs/user/interface/View.dox b/docs/user/interface/View.dox index 14b1c4ec69..9f2b9416e2 100644 --- a/docs/user/interface/View.dox +++ b/docs/user/interface/View.dox @@ -761,9 +761,9 @@ SetViewColor(Parent()->ViewColor()); call it yourself. If you need to forcefully redraw the view consider calling Invalidate() instead. - \param updateRect The rectangular area to be drawn. - The default implementation does nothing. + + \param updateRect The rectangular area to be drawn. */ @@ -772,9 +772,9 @@ SetViewColor(Parent()->ViewColor()); \brief Perform any drawing that needs to be done after child view have already been drawn. - \param updateRect The rectangular area to drawn in. - The default implementation does nothing. + + \param updateRect The rectangular area to drawn in. */ @@ -782,10 +782,10 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::FrameMoved(BPoint newPosition) \brief Hook method called when the view is moved. + The default implementation does nothing. + \param newPosition The point of the top left corner of the frame that the view has been moved to. - - The default implementation does nothing. */ @@ -793,10 +793,10 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::FrameResized(float newWidth, float newHeight) \brief Hook method called when the view is resized. + The default implementation does nothing. + \param newWidth The new \a width of the view. \param newHeight The new \a height of the view. - - The default implementation does nothing. */ @@ -804,10 +804,10 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::KeyDown(const char* bytes, int32 numBytes) \brief Hook method called when a keyboard key is pressed. + The default implementation sets keyboard navigation focus. + \param bytes The bytes of the key combination pressed. \param numBytes The number of bytes in \a bytes. - - The default implementation sets keyboard navigation focus. */ @@ -815,10 +815,10 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::KeyUp(const char* bytes, int32 numBytes) \brief Hook method called when a keyboard key is released. + The default implementation does nothing. + \param bytes The bytes of the key combination pressed. \param numBytes The number of bytes in \a bytes. - - The default implementation does nothing. */ @@ -828,9 +828,9 @@ SetViewColor(Parent()->ViewColor()); \note This method was not available in BeOS R5. - \param descendants Whether or not child views have also been invalidated. - The default implementation does nothing. + + \param descendants Whether or not child views have also been invalidated. */ @@ -838,6 +838,8 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::MessageReceived(BMessage* message) \brief Handle \a message received by the associated looper. + The default implementation does nothing. + \param message The \a message received by the associated looper. \see BHandler::MessageReceived() @@ -848,10 +850,10 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::MouseDown(BPoint where) \brief Hook method called when a mouse button is pressed. + The default implementation does nothing. + \param where The point on the screen where to mouse pointer is when the mouse button is pressed. - - The default implementation does nothing. */ @@ -859,10 +861,10 @@ SetViewColor(Parent()->ViewColor()); \fn void BView::MouseUp(BPoint where) \brief Hook method called when a mouse button is released. + The default implementation does nothing. + \param where The point on the screen where to mouse pointer is when the mouse button is released. - - The default implementation does nothing. */ @@ -885,9 +887,9 @@ SetViewColor(Parent()->ViewColor()); anything you want. The default version does nothing. The pulse granularity is no better than once per 100,000 microseconds. - \sa SetPulseRate() - The default implementation does nothing. + + \sa SetPulseRate() */ @@ -896,9 +898,9 @@ SetViewColor(Parent()->ViewColor()); \brief Hook method called when the view becomes the target of \a scrollView. - \param scrollView The BScrollView object that has targeted the view. - The default implementation does nothing. + + \param scrollView The BScrollView object that has targeted the view. */ @@ -907,10 +909,10 @@ SetViewColor(Parent()->ViewColor()); \brief Hook method called when the attached window is activated or deactivated. + The default implementation does nothing. + \param state \c true if the window becomes activated, \c false if the window becomes deactivated. - - The default implementation does nothing. */ @@ -919,17 +921,17 @@ SetViewColor(Parent()->ViewColor()); /*! \fn BRect BView::Bounds() const - \brief Returns the view frame rectangle in the view's coordinate system. + \brief Returns the view's frame rectangle in the view's coordinate system. - \return The bounding rectangle of the view. + \return The view's bounding rectangle in the view's coordinate system. */ /*! \fn BRect BView::Frame() const - \brief Returns the frame rectangle of the view in the parent's coordinate system. + \brief Returns the view's frame rectangle in the parent's coordinate system. - \returns The view's frame rectangle. + \returns The view's frame rectangle in the parent's coordinate system. */ @@ -1411,7 +1413,7 @@ SetViewColor(Parent()->ViewColor()); /*! \fn void BView::MakeFocus(bool focusState) \brief Makes the view the current focus view of the window or gives up - being the focus view of the window. + being the window's focus view. The focus view handles selections and KeyDown events when the the attached window is active. There can be only one focus view at a time per window.