X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/08b97268061292f7c3794dae243a6490b23a42f1..b98bd6af23c1c73eb2cddf14da18455e5668de6d:/docs/latex/wx/tlw.tex diff --git a/docs/latex/wx/tlw.tex b/docs/latex/wx/tlw.tex index 6224124362..dba609ba32 100644 --- a/docs/latex/wx/tlw.tex +++ b/docs/latex/wx/tlw.tex @@ -29,6 +29,24 @@ applicable for the two classes above. \latexignore{\rtfignore{\wxheading{Members}}} +\membersection{wxTopLevelWindow::CanSetTransparent}\label{wxtoplevelwindowcansettransparent} + +\func{virtual bool}{CanSetTransparent}{\void} + +Returns \true if the platform supports making the window translucent. + +\wxheading{See also} + +\helpref{wxTopLevelWindow::SetTransparent}{wxtoplevelwindowsettransparent} + + +\membersection{wxTopLevelWindow::GetDefaultItem}\label{wxtoplevelwindowgetdefaultitem} + +\constfunc{wxWindow *}{GetDefaultItem}{\void} + +Returns a pointer to the button which is the default for this window, or \NULL. +The default button is the one activated by pressing the Enter key. + \membersection{wxTopLevelWindow::GetIcon}\label{wxtoplevelwindowgeticon} @@ -74,7 +92,7 @@ Gets a string containing the window title. \func{virtual bool}{HandleSettingChange}{\param{WXWPARAM}{ wParam}, \param{WXLPARAM}{ lParam}} Unique to the wxWinCE port. Responds to showing/hiding SIP (soft input panel) area and resize -accordingly window accordingly. Override this if you want to avoid resinzing or do additional +window accordingly. Override this if you want to avoid resizing or do additional operations. @@ -86,6 +104,14 @@ Returns \true if this window is currently active, i.e. if the user is currently working with it. +\membersection{wxTopLevelWindow::IsAlwaysMaximized}\label{wxtoplevelwindowisalwaysmaximized} + +\constfunc{virtual bool}{IsAlwaysMaximized}{\void} + +Returns \true if this window is expected to be always maximized, either due to platform policy +or due to local policy regarding particular class. + + \membersection{wxTopLevelWindow::Iconize}\label{wxtoplevelwindowiconize} \func{void}{Iconize}{\param{bool}{ iconize}} @@ -136,10 +162,6 @@ Maximizes or restores the window. \docparam{maximize}{If \true, maximizes the window, otherwise it restores it.} -\wxheading{Remarks} - -This function only works under Windows. - \wxheading{See also} \helpref{wxTopLevelWindow::Iconize}{wxtoplevelwindowiconize} @@ -163,6 +185,17 @@ This function is currently implemented for Win32 where it flashes the window icon in the taskbar, and for wxGTK with task bars supporting it. +\membersection{wxTopLevelWindow::SetDefaultItem}\label{wxtoplevelwindowsetdefaultitem} + +\func{void}{SetDefaultItem}{\param{wxWindow }{*win}} + +Changes the default item for the panel, usually \arg{win} is a button. + +\wxheading{See also} + +\helpref{GetDefaultItem}{wxtoplevelwindowgetdefaultitem} + + \membersection{wxTopLevelWindow::SetIcon}\label{wxtoplevelwindowseticon} \func{void}{SetIcon}{\param{const wxIcon\& }{icon}} @@ -267,6 +300,34 @@ Sets the window title. \helpref{wxTopLevelWindow::GetTitle}{wxtoplevelwindowgettitle} +\membersection{wxTopLevelWindow::SetTransparent}\label{wxtoplevelwindowsettransparent} + +\func{virtual bool}{SetTransparent}{\param{int }{ alpha}} + +If the platform supports it will set the window to be translucent + +\wxheading{Parameters} + +\docparam{alpha}{Determines how opaque or transparent the window will + be, if the platform supports the opreration. A value of 0 sets the + window to be fully transparent, and a value of 255 sets the window + to be fully opaque.} + +Returns \true if the transparency was successfully changed. + + + +\membersection{wxTopLevelWindow::ShouldPreventAppExit}\label{wxtoplevelwindowshouldpreventappexit} + +\constfunc{virtual bool}{ShouldPreventAppExit}{\void} + +This virtual function is not meant to be called directly but can be overridden +to return \false (it returns \true by default) to allow the application to +close even if this, presumably not very important, window is still opened. +By default, the application stays alive as long as there are any open top level +windows. + + \membersection{wxTopLevelWindow::ShowFullScreen}\label{wxtoplevelwindowshowfullscreen} \func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}}