X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/971562cb51391676afccb9822e491d677f052c0d..751731864888f00e31e6dce1092ac28a1fac5358:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index ecd5b6798c..d3e214b8cc 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1448,6 +1448,24 @@ implements the following methods:\par \end{twocollist}} } +\membersection{wxWindow::Navigate}\label{wxwindownavigate} + +\func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}} + +Does keyboard navigation from this window to another, by sending +a wxNavigationKeyEvent. + +\wxheading{Parameters} + +\docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.} + +\wxheading{Remarks} + +You may wish to call this from a text control custom keypress handler to do the default +navigation behaviour for the tab key, since the standard default behaviour for +a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab +and not navigate to the next control. + %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving %% the old docs here in case we want to move any still needed bits to %% the right location (i.e. probably the corresponding events docs) @@ -1987,9 +2005,7 @@ default value is {\tt false}.} \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu} -\func{bool}{PopupMenu}{\param{wxMenu* }{menu}} - -\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}} +\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos = wxDefaultPosition}} \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}} @@ -2336,7 +2352,7 @@ from within wxWindow::OnSize functions.} \membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour} -\func{virtual void}{SetBackgroundColour}{\param{const wxColour\& }{colour}} +\func{virtual bool}{SetBackgroundColour}{\param{const wxColour\& }{colour}} Sets the background colour of the window. @@ -2346,7 +2362,8 @@ explanation of the difference between this method and \wxheading{Parameters} -\docparam{colour}{The colour to be used as the background colour.} +\docparam{colour}{The colour to be used as the background colour, pass + {\tt wxNullColour} to reset to the default colour.} \wxheading{Remarks} @@ -2358,9 +2375,11 @@ Note that setting the background colour does not cause an immediate refresh, so may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after calling this function. -Use this function with care under GTK+ as the new appearance of the window might -not look equally well when used with "Themes", i.e GTK+'s ability to change its -look as the user wishes with run-time loadable modules. +Using this function will disable attempts to use themes for this +window, if the system supports them. Use with care since usually the +themes represent the appearance chosen by the user to be used for all +applications on the system. + \wxheading{See also} @@ -2614,7 +2633,8 @@ explanations. \wxheading{Parameters} -\docparam{font}{Font to associate with this window.} +\docparam{font}{Font to associate with this window, pass +{\tt wxNullFont} to reset to the default font.} \wxheading{See also} @@ -2634,7 +2654,8 @@ explanation of the difference between this method and \wxheading{Parameters} -\docparam{colour}{The colour to be used as the foreground colour.} +\docparam{colour}{The colour to be used as the foreground colour, pass + {\tt wxNullColour} to reset to the default colour.} \wxheading{Remarks} @@ -2642,9 +2663,10 @@ The interpretation of foreground colour is open to interpretation according to the window class; it may be the text colour or other colour, or it may not be used at all. -Note that when using this functions under GTK, you will disable the so called "themes", -i.e. the user chosen appearance of windows and controls, including the themes of -their parent windows. +Using this function will disable attempts to use themes for this +window, if the system supports them. Use with care since usually the +themes represent the appearance chosen by the user to be used for all +applications on the system. \wxheading{See also}