]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/window.tex
docstring fix
[wxWidgets.git] / docs / latex / wx / window.tex
index 09f2f5d37b4f925e2611b8ca5288f674d6cb53a9..c307195d6e5ad12f06edf75d4733974434915c2f 100644 (file)
@@ -2222,11 +2222,13 @@ or frame).
 
 \membersection{wxWindow::Refresh}\label{wxwindowrefresh}
 
-\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect
-= NULL}}
+\func{virtual void}{Refresh}{\param{bool}{ eraseBackground = {\tt true}}, \param{const wxRect* }{rect = NULL}}
 
-Causes an event to be generated to repaint the
-window.
+Causes this window, and all of its children recursively (except under wxGTK1
+where this is not implemented), to be repainted. Note that repainting doesn't
+happen immediately but only during the next event loop iteration, if you need
+to update the window immediately you should use \helpref{Update}{wxwindowupdate} 
+instead.
 
 \wxheading{Parameters}
 
@@ -3487,12 +3489,12 @@ This function is currently only implemented under MSW.
 
 \func{virtual void}{Update}{\void}
 
-Calling this method immediately repaints the invalidated area of the window
-while this would usually only happen when the flow of control returns to the
-event loop. Notice that this function doesn't refresh the window and does
-nothing if the window hadn't been already repainted. Use
-\helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the
-window unconditionally.
+Calling this method immediately repaints the invalidated area of the window and
+all of its children recursively while this would usually only happen when the
+flow of control returns to the event loop. Notice that this function doesn't
+refresh the window and does nothing if the window hadn't been already
+repainted. Use \helpref{Refresh}{wxwindowrefresh} first if you want to
+immediately redraw the window unconditionally.
 
 
 \membersection{wxWindow::UpdateWindowUI}\label{wxwindowupdatewindowui}