X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/70e8189368e353e7f675144244f6026f5ab31d9b..60b73526d6797ee466c272dbfca962a230bc5908:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 43697c7b0f..106ff9e65d 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1118,8 +1118,10 @@ the window won't get the event. \wxheading{See also} -\helpref{wxKeyEvent}{wxkeyevent}, \helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp -\helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp +\helpref{wxKeyEvent}{wxkeyevent},\rtfsp +\helpref{wxWindow::OnCharHook}{wxwindowoncharhook},\rtfsp +%% GD: OnXXX functions are not documented +%%\helpref{wxApp::OnCharHook}{wxapponcharhook},\rtfsp \helpref{Event handling overview}{eventhandlingoverview} \membersection{wxWindow::OnCommand}\label{wxwindowoncommand} @@ -1207,8 +1209,9 @@ destroying the window if it returns TRUE or if the close is being forced. \helpref{wxWindow::OnClose}{wxwindowonclose},\rtfsp \helpref{wxWindow::Destroy}{wxwindowdestroy},\rtfsp \helpref{wxCloseEvent}{wxcloseevent},\rtfsp -\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession},\rtfsp -\helpref{wxApp::OnEndSession}{wxapponendsession} +\helpref{wxApp::OnQueryEndSession}{wxapponqueryendsession} +%% GD: OnXXX functions are not documented +%%\helpref{wxApp::OnEndSession}{wxapponendsession} \membersection{wxWindow::OnDropFiles}\label{wxwindowondropfiles} @@ -1349,7 +1352,9 @@ when the application is idle. \wxheading{See also} -\helpref{wxApp::OnIdle}{wxapponidle}, \helpref{wxIdleEvent}{wxidleevent} +%% GD: OnXXX functions are not documented +%%\helpref{wxApp::OnIdle}{wxapponidle} +\helpref{wxIdleEvent}{wxidleevent} \membersection{wxWindow::OnInitDialog}\label{wxwindowoninitdialog} @@ -1807,12 +1812,21 @@ implements the following methods:\par \membersection{wxWindow::ScrollLines}\label{wxwindowscrolllines} -\func{virtual void}{ScrollLines}{\param{int }{lines}} +\func{virtual bool}{ScrollLines}{\param{int }{lines}} Scrolls the window by the given number of lines down (if {\it lines} is positive) or up. -This function is currently only implemented under MSW. +\wxheading{Return value} + +Returns {\tt TRUE} if the window was scrolled, {\tt FALSE} if it was already +on top/bottom and nothing was done. + +\wxheading{Remarks} + +This function is currently only implemented under MSW and wxTextCtrl under +wxGTK (it also works for wxScrolledWindow derived classes under all +platforms). \wxheading{See also} @@ -1820,12 +1834,21 @@ This function is currently only implemented under MSW. \membersection{wxWindow::ScrollPages}\label{wxwindowscrollpages} -\func{virtual void}{ScrollPages}{\param{int }{pages}} +\func{virtual bool}{ScrollPages}{\param{int }{pages}} Scrolls the window by the given number of pages down (if {\it pages} is positive) or up. -This function is currently only implemented under MSW. +\wxheading{Return value} + +Returns {\tt TRUE} if the window was scrolled, {\tt FALSE} if it was already +on top/bottom and nothing was done. + +\wxheading{Remarks} + +This function is currently only implemented under MSW and wxTextCtrl under +wxGTK (it also works for wxScrolledWindow derived classes under all +platforms). \wxheading{See also} @@ -2039,6 +2062,16 @@ bits are: \twocolitem{\windowstyle{wxWS\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow() and Validate() methods will recursively descend into all children of the window if it has this style flag set.} +\twocolitem{\windowstyle{wxWS\_EX\_BLOCK\_EVENTS}}{Normally, the command +events are propagared upwards to the window parent recursively until a handler +for them is found. Using this style allows to prevent them from being +propagated beyond this window. Notice that wxDialog has this style on by +default for the reasons explained in the +\helpref{event processing overview}{eventprocessing}.} +\twocolitem{\windowstyle{wxWS\_EX\_TRANSIENT}}{This can be used to prevent a +window from being used as an implicit parent for the dialogs which were +created without a parent. It is useful for the windows which can disappear at +any moment as creating childs of such windows results in fatal problems.} \end{twocollist} \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus}