X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f35398824b11747a5930f729409b9fa59da3fad9..ded4fa5b7a2a8177a6905b9b0fcda1d3dac2d0ff:/docs/latex/wx/frame.tex diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index 76b1ccf613..0dc9cffa0f 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -24,7 +24,7 @@ application windows. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BOX \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.} +\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxRESIZE\_BORDER \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.} \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized). Windows only. } \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.} \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.} @@ -47,7 +47,11 @@ wxFRAME\_TOOL\_WINDOW or wxFRAME\_NO\_TASKBAR instead} caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction). -You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX.} +You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so +you should use +{\tt wxDEFAULT\_FRAME\_STYLE \& \~ (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the +frames having this style (the dialogs don't have minimize nor maximize box by +default)} \end{twocollist} The default frame style is for normal, resizeable frames. To create a frame @@ -59,7 +63,7 @@ See also \helpref{window styles overview}{windowstyles}. \wxheading{Remarks} -An application should normally define an \helpref{OnCloseWindow}{wxwindowonclosewindow} handler for the +An application should normally define an \helpref{wxCloseEvent}{wxcloseevent} handler for the frame to respond to system close events, for example so that related data and subwindows can be cleaned up. \wxheading{See also} @@ -276,7 +280,7 @@ Returns a pointer to the toolbar currently associated with the frame (if any). \func{void}{Iconize}{\param{bool}{ iconize}} -Iconizes or restores the frame. Windows only. +Iconizes or restores the frame. \wxheading{Parameters} @@ -286,11 +290,21 @@ Iconizes or restores the frame. Windows only. \helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}. +\membersection{wxFrame::IsFullScreen}\label{wxframeisfullscreen} + +\func{bool}{IsFullScreen}{\void} + +Returns TRUE if the frame is in fullscreen mode. + +\wxheading{See also} + +\helpref{wxFrame::ShowFullScreen}{wxframeshowfullscreen} + \membersection{wxFrame::IsIconized}\label{wxframeisiconized} \constfunc{bool}{IsIconized}{\void} -Returns TRUE if the frame is iconized. Windows only. +Returns TRUE if the frame is iconized. \membersection{wxFrame::IsMaximized}\label{wxframeismaximized} @@ -386,29 +400,26 @@ implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}. \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}. -\membersection{wxFrame::OnMenuCommand}\label{wxframeonmenucommand} - -\func{void}{OnMenuCommand}{\param{wxCommandEvent\&}{ event}} - -See \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand}. - \membersection{wxFrame::OnMenuHighlight}\label{wxframeonmenuhighlight} \func{void}{OnMenuHighlight}{\param{wxMenuEvent\&}{ event}} -See \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight}. +The default implementation displays an appropriate help string +in the status bar, if there is one. + +See \helpref{wxMenuEvent}{wxmenuevent}. \membersection{wxFrame::OnSize}\label{wxframeonsize} \func{void}{OnSize}{\param{wxSizeEvent\& }{event}} -See \helpref{wxWindow::OnSize}{wxwindowonsize}. - The default {\bf wxFrame::OnSize} implementation looks for a single subwindow, and if one is found, resizes it to fit inside the frame. Override this member if more complex behaviour is required (for example, if there are several subwindows). +See \helpref{wxSizeEvent}{wxsizeevent}. + \membersection{wxFrame::SetIcon}\label{wxframeseticon} \func{void}{SetIcon}{\param{const wxIcon\& }{icon}} @@ -425,6 +436,20 @@ The frame takes a `copy' of {\it icon}, but since it uses reference counting, the copy is very quick. It is safe to delete {\it icon} after calling this function. +See also \helpref{wxIcon}{wxicon}. + +\membersection{wxFrame::SetIcons}\label{wxframeseticons} + +\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}} + +Sets the icons for this frame. + +\wxheading{Parameters} + +\docparam{icons}{The icons to associate with this frame.} + +See also \helpref{wxIconBundle}{wxiconbundle}. + % VZ: we don't have all this any more (18.08.00) % %Under Windows, instead of using {\bf SetIcon}, you can add the @@ -452,8 +477,6 @@ calling this function. %You can replace std.ico, mdi.ico and child.ico with your own defaults %for all your wxWindows application. Currently they show the same icon. -See also \helpref{wxIcon}{wxicon}. - \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar} \func{void}{SetMenuBar}{\param{wxMenuBar* }{menuBar}} @@ -579,5 +602,45 @@ indicate what elements of the frame to hide in full-screen mode: \item wxFULLSCREEN\_ALL (all of the above) \end{itemize} -This function only works on Windows and has not been tested with MDI frames. +This function has not been tested with MDI frames. + +\wxheading{See also} + +\helpref{wxFrame::IsFullScreen}{wxframeisfullscreen} + +\membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane} + +\func{void}{SetStatusBarPane}{\param{int}{ n}} + +Set the status bar pane used to display menu and toolbar help. +Using -1 disables help display. + +\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane} + +\func{int}{GetStatusBarPane}{\void} + +Returns the status bar pane used to display menu and toolbar help. + +\wxheading{See also} + +\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane} + +\membersection{wxFrame::SetStatusBarPane}\label{wxframesetstatusbarpane} + +\func{void}{SetStatusBarPane}{\param{int}{ n}} + +Set the status bar pane used to display menu and toolbar help. +Using -1 disables help display. + +\membersection{wxFrame::GetStatusBarPane}\label{wxframegetstatusbarpane} + +\func{int}{GetStatusBarPane}{\void} + +Returns the status bar pane used to display menu and toolbar help. + +\wxheading{See also} + +\helpref{wxFrame::SetStatusBarPane}{wxframesetstatusbarpane} + +