From 56463e2bbe8aa1b5347f8b7411cd6bd3e7b45fa0 Mon Sep 17 00:00:00 2001
From: Andrew Lindesay <apl@lindesay.co.nz>
Date: Sat, 23 Mar 2013 00:51:49 +0000
Subject: [PATCH] Added Show(), Hide() and IsHidden() docs to the View
documentationZ
---
docs/user/interface/View.dox | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/docs/user/interface/View.dox b/docs/user/interface/View.dox
index c213b5f..ec1989b 100644
|
a
|
b
|
|
| 296 | 296 | \returns The layout of the view. |
| 297 | 297 | */ |
| 298 | 298 | |
| | 299 | /*! |
| | 300 | \fn bool BView::IsHidden() const |
| | 301 | \brief Informs the caller if the view is presently hidden. |
| | 302 | |
| | 303 | \returns The boolean will be true if the view is presently hidden. |
| | 304 | |
| | 305 | \sa BView::Show() |
| | 306 | \sa BView::Hide() |
| | 307 | */ |
| | 308 | |
| | 309 | /*! |
| | 310 | \fn void BView::Hide() |
| | 311 | \brief Increments the hidden counter of the view by one. |
| | 312 | |
| | 313 | A view can be visible or hidden. A counter determines if a view is hidden; one or more and the view is hidden. This method will increment the counter. This method will invalidate the parent view's layout if necessary in order to cause the view to become hidden in the layout. |
| | 314 | |
| | 315 | \sa BView::Show() |
| | 316 | \sa BView::IsHidden() |
| | 317 | */ |
| | 318 | |
| | 319 | /*! |
| | 320 | \fn void BView::Show() |
| | 321 | \brief Decrements the hidden counter of the view by one. |
| | 322 | |
| | 323 | A view can be visible or hidden. A counter determines if a view is hidden; zero or less and the view is visible. This method will decrement the counter. This method will invalidate the parent view's layout if necessary in order to cause the view to become visible in the layout. |
| | 324 | |
| | 325 | \sa BView::Hide() |
| | 326 | \sa BView::IsHidden() |
| | 327 | */ |
| 299 | 328 | |
