X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1c4f8f8d180afa03110f52eb95f9b083088f5c03..a977709b11432e05af48e205cc02c0a0ad4ecf16:/docs/latex/wx/frame.tex diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index ba58e1fe8c..1ccdfe06ce 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -24,25 +24,41 @@ application windows. \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt +\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{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxTHICK\_FRAME \pipe wxSYSTEM\_MENU \pipe wxCAPTION}.} -\twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only. } -\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame. } -\twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only. } -\twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame. } -\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows. Windows only. } -\twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu. } -\twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window. Windows and Motif only.} -\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only (?). } -\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Unix only).} -\twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{Causes the frame to be above the parent window in the -z-order and not shown in the taskbar. Without this style, frames are created as top-level windows that may be obscured by -the parent window, and frame titles are shown in the taskbar. Windows only. } -\twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small titlebar to be created; -the frame title does not appear in the taskbar. Windows only. } +\twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}. Windows only.} +\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame.} +\twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized. Windows only.} +\twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame.} +\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows. Windows only.} +\twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.} +\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only.} +\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.} +\twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small +titlebar to be created; the frame does not appear in the taskbar under Windows.} +\twocolitem{\windowstyle{wxFRAME\_NO\_TASKBAR}}{Creates a normal frame but if +this frame has a parent it does not appear in the taskbar under Windows. Note +that a frame without parent will still appear in the taskbar even with this +style. Has no effect under other platforms.} +\twocolitem{\windowstyle{wxFRAME\_FLOAT\_ON\_PARENT}}{Unused any longer, use +wxFRAME\_TOOL\_WINDOW or wxFRAME\_NO\_TASKBAR instead} +\twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the +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, 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 +which can not be resized by user, you may use the following combination of +styles: {\tt wxDEFAULT\_FRAME\_STYLE \& \~ (wxRESIZE\_BORDER \pipe wxRESIZE\_BOX \pipe wxMAXIMIZE\_BOX)}. +% Note: the space after the tilde is necessary or Tex2RTF complains. + See also \helpref{window styles overview}{windowstyles}. \wxheading{Remarks} @@ -235,7 +251,7 @@ Returns a pointer to the menubar currently associated with the frame (if any). \membersection{wxFrame::GetStatusBar}\label{wxframegetstatusbar} -\func{wxStatusBar*}{GetStatusBar}{\void} +\constfunc{wxStatusBar*}{GetStatusBar}{\void} Returns a pointer to the status bar currently associated with the frame (if any). @@ -245,14 +261,13 @@ Returns a pointer to the status bar currently associated with the frame (if any) \membersection{wxFrame::GetTitle}\label{wxframegettitle} -\func{wxString\&}{GetTitle}{\void} +\constfunc{wxString}{GetTitle}{\void} -Gets a temporary pointer to the frame title. See -\helpref{wxFrame::SetTitle}{wxframesettitle}. +Gets a string containing the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}. \membersection{wxFrame::GetToolBar}\label{wxframegettoolbar} -\func{wxToolBar*}{GetToolBar}{\void} +\constfunc{wxToolBar*}{GetToolBar}{\void} Returns a pointer to the toolbar currently associated with the frame (if any). @@ -263,9 +278,9 @@ Returns a pointer to the toolbar currently associated with the frame (if any). \membersection{wxFrame::Iconize}\label{wxframeiconize} -\func{void}{Iconize}{\param{const bool}{ iconize}} +\func{void}{Iconize}{\param{bool}{ iconize}} -Iconizes or restores the frame. Windows only. +Iconizes or restores the frame. \wxheading{Parameters} @@ -275,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} @@ -289,13 +314,13 @@ Returns TRUE if the frame is maximized. \membersection{wxFrame::Maximize}\label{wxframemaximize} -\func{void}{Maximize}{\param{const bool }{maximize}} +\func{void}{Maximize}{\param{bool }{maximize}} Maximizes or restores the frame. \wxheading{Parameters} -\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it}. +\docparam{maximize}{If TRUE, maximizes the frame, otherwise it restores it.} \wxheading{Remarks} @@ -414,38 +439,46 @@ 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. -Under Windows, instead of using {\bf SetIcon}, you can add the -following lines to your MS Windows resource file: - -\begin{verbatim} -wxSTD_MDIPARENTFRAME ICON icon1.ico -wxSTD_MDICHILDFRAME ICON icon2.ico -wxSTD_FRAME ICON icon3.ico -\end{verbatim} - -where icon1.ico will be used for the MDI parent frame, icon2.ico -will be used for MDI child frames, and icon3.ico will be used for -non-MDI frames. +See also \helpref{wxIcon}{wxicon}. -If these icons are not supplied, and {\bf SetIcon} is not called either, -then the following defaults apply if you have included wx.rc. +\membersection{wxFrame::SetIcons}\label{wxframeseticons} -\begin{verbatim} -wxDEFAULT_FRAME ICON std.ico -wxDEFAULT_MDIPARENTFRAME ICON mdi.ico -wxDEFAULT_MDICHILDFRAME ICON child.ico -\end{verbatim} +\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}} -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. +Sets the icons for this frame. -{\it Note:} a wxWindows application linked with subsystem equal to 4.0 -(i.e. marked as a Windows 95 application) doesn't respond properly -to wxFrame::SetIcon. To work around this until a solution is found, -mark your program as a 3.5 application. This will also ensure -that Windows provides small icons for the application automatically. +\wxheading{Parameters} -See also \helpref{wxIcon}{wxicon}. +\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 +%following lines to your MS Windows resource file: +% +%\begin{verbatim} +%wxSTD_MDIPARENTFRAME ICON icon1.ico +%wxSTD_MDICHILDFRAME ICON icon2.ico +%wxSTD_FRAME ICON icon3.ico +%\end{verbatim} +% +%where icon1.ico will be used for the MDI parent frame, icon2.ico +%will be used for MDI child frames, and icon3.ico will be used for +%non-MDI frames. +% +%If these icons are not supplied, and {\bf SetIcon} is not called either, +%then the following defaults apply if you have included wx.rc. +% +%\begin{verbatim} +%wxDEFAULT_FRAME ICON std.ico +%wxDEFAULT_MDIPARENTFRAME ICON mdi.ico +%wxDEFAULT_MDICHILDFRAME ICON child.ico +%\end{verbatim} +% +%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. \membersection{wxFrame::SetMenuBar}\label{wxframesetmenubar} @@ -528,6 +561,7 @@ variable fields. \pythonnote{Only a single parameter is required, a Python list of integers.} +\perlnote{In wxPerl this method takes the field widths as parameters.} \membersection{wxFrame::SetToolBar}\label{wxframesettoolbar} @@ -554,3 +588,26 @@ Sets the frame title. \helpref{wxFrame::GetTitle}{wxframegettitle} +\membersection{wxFrame::ShowFullScreen}\label{wxframeshowfullscreen} + +\func{bool}{ShowFullScreen}{\param{bool}{ show}, \param{long}{ style = wxFULLSCREEN\_ALL}} + +Passing TRUE to {\it shows} shows the frame full-screen, and passing FALSE restores the frame +again. {\it style} is a bit list containing some or all of the following values, which +indicate what elements of the frame to hide in full-screen mode: + +\begin{itemize}\itemsep=0pt +\item wxFULLSCREEN\_NOMENUBAR +\item wxFULLSCREEN\_NOTOOLBAR +\item wxFULLSCREEN\_NOSTATUSBAR +\item wxFULLSCREEN\_NOBORDER +\item wxFULLSCREEN\_NOCAPTION +\item wxFULLSCREEN\_ALL (all of the above) +\end{itemize} + +This function has not been tested with MDI frames. + +\wxheading{See also} + +\helpref{wxFrame::IsFullScreen}{wxframeisfullscreen} +