X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..820b49cdbf6fa6e6aac6bbb66e84ea9f5f5f745d:/docs/latex/wx/frame.tex?ds=sidebyside diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index 61cad1ee36..daaa50e60e 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -1,8 +1,14 @@ \section{\class{wxFrame}}\label{wxframe} -A frame is a window whose size and position can (usually) be changed by the user. It usually has -thick borders and a title bar, and can optionally contain a menu bar, toolbar and -status bar. A frame can contain any window that is not a frame or dialog. +A frame is a window whose size and position can (usually) be changed by the +user. It usually has thick borders and a title bar, and can optionally contain +a menu bar, toolbar and status bar. A frame can contain any window that is not +a frame or dialog. + +A frame that has a status bar and toolbar created via the +CreateStatusBar/CreateToolBar functions manages these windows, and adjusts the +value returned by GetClientSize to reflect the remaining size available to +application windows. \wxheading{Derived from} @@ -10,23 +16,49 @@ status bar. A frame can contain any window that is not a frame or dialog. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized) (Windows only).} +\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}.} -\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame (Windows and Motif only).} -\twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized (Windows only).} -\twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame (Windows and Motif only).} -\twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).} -\twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).} -\twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).} -\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif 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} @@ -47,7 +79,7 @@ frame to respond to system close events, for example so that related data and su Default constructor. -\func{}{wxFrame}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp +\func{}{wxFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxString\& }{name = ``frame"}} @@ -92,7 +124,7 @@ Destructor. Destroys all child windows and menu bar if present. \membersection{wxFrame::Centre}\label{wxframecentre} -\func{void}{Centre}{\param{const int}{ direction = wxBOTH}} +\func{void}{Centre}{\param{int}{ direction = wxBOTH}} Centres the frame on the display. @@ -112,7 +144,7 @@ Simulate a menu command. \membersection{wxFrame::Create}\label{wxframecreate} -\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp +\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp \param{const wxString\& }{name = ``frame"}} @@ -122,7 +154,9 @@ for further details. \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar} -\func{virtual bool}{CreateStatusBar}{\param{const int}{ number = 1}} +\func{virtual wxStatusBar*}{CreateStatusBar}{\param{int}{ number = 1}, + \param{long}{ style = 0}, + \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "statusBar"}} Creates a status bar at the bottom of the frame. @@ -131,9 +165,17 @@ Creates a status bar at the bottom of the frame. \docparam{number}{The number of fields to create. Specify a value greater than 1 to create a multi-field status bar.} +\docparam{style}{The status bar style. See \helpref{wxStatusBar}{wxstatusbar} for a list +of valid styles.} + +\docparam{id}{The status bar window identifier. If -1, an identifier will be chosen by +wxWindows.} + +\docparam{name}{The status bar window name.} + \wxheading{Return value} -TRUE if the status bar was created successfully. +A pointer to the the status bar if it was created successfully, NULL otherwise. \wxheading{Remarks} @@ -151,6 +193,52 @@ Note that you can put controls and other windows on the status bar if you wish. \helpref{wxFrame::OnCreateStatusBar}{wxframeoncreatestatusbar},\rtfsp \helpref{wxFrame::GetStatusBar}{wxframegetstatusbar} +\membersection{wxFrame::CreateToolBar}\label{wxframecreatetoolbar} + +\func{virtual wxToolBar*}{CreateToolBar}{\param{long}{ style = wxNO\_BORDER \pipe wxTB\_HORIZONTAL}, + \param{wxWindowID}{ id = -1}, \param{const wxString\&}{ name = "toolBar"}} + +Creates a toolbar at the top or left of the frame. + +\wxheading{Parameters} + +\docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list +of valid styles.} + +\docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by +wxWindows.} + +\docparam{name}{The toolbar window name.} + +\wxheading{Return value} + +A pointer to the the toolbar if it was created successfully, NULL otherwise. + +\wxheading{Remarks} + +By default, the toolbar is an instance of wxToolBar (which is defined to be +a suitable toolbar class on each platform, such as wxToolBar95). To use a different class, +override \helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar}. + +When a toolbar has been created with this function, or made known to the frame +with \helpref{wxFrame::SetToolBar}{wxframesettoolbar}, the frame will manage the toolbar +position and adjust the return value from \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} to +reflect the available space for application windows. + +\wxheading{See also} + +\helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar},\rtfsp +\helpref{wxFrame::OnCreateToolBar}{wxframeoncreatetoolbar},\rtfsp +\helpref{wxFrame::SetToolBar}{wxframesettoolbar},\rtfsp +\helpref{wxFrame::GetToolBar}{wxframegettoolbar} + +\membersection{wxFrame::GetClientAreaOrigin}\label{wxframegetclientareaorigin} + +\constfunc{wxPoint}{GetClientAreaOrigin}{\void} + +Returns the origin of the frame client area (in client coordinates). It may be +different from (0, 0) if the frame has a toolbar. + \membersection{wxFrame::GetMenuBar}\label{wxframegetmenubar} \constfunc{wxMenuBar*}{GetMenuBar}{\void} @@ -163,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). @@ -173,77 +261,66 @@ 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::Iconize}\label{wxframeiconize} +\membersection{wxFrame::GetToolBar}\label{wxframegettoolbar} -\func{void}{Iconize}{\param{const bool}{ iconize}} +\constfunc{wxToolBar*}{GetToolBar}{\void} -Iconizes or restores the frame. - -\wxheading{Parameters} - -\docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.} +Returns a pointer to the toolbar currently associated with the frame (if any). \wxheading{See also} -\helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}. - -\membersection{wxFrame::IsIconized}\label{wxframeisiconized} +\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp +\helpref{wxFrame::SetToolBar}{wxframesettoolbar} -\func{bool}{IsIconized}{\void} +\membersection{wxFrame::Iconize}\label{wxframeiconize} -Returns TRUE if the frame is iconized. +\func{void}{Iconize}{\param{bool}{ iconize}} -\membersection{wxFrame::LoadAccelerators}\label{wxframeloadaccelerators} +Iconizes or restores the frame. -\func{void}{LoadAccelerators}{\param{const wxString\& }{table}} +\wxheading{Parameters} -Loads a keyboard accelerator table for this frame. +\docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.} -\wxheading{Parameters} +\wxheading{See also} -\docparam{table}{Accelerator table to load.} +\helpref{wxFrame::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}. -\wxheading{Return value} +\membersection{wxFrame::IsFullScreen}\label{wxframeisfullscreen} -TRUE if the operation was successful, FALSE otherwise. +\func{bool}{IsFullScreen}{\void} -\wxheading{Remarks} +Returns TRUE if the frame is in fullscreen mode. -Accelerator tables map keystrokes onto control and menu identifiers, so the -programmer does not have to explicitly program this correspondence. +\wxheading{See also} -See the hello demo ({\tt hello.cpp} and {\tt hello.rc}) for -an example of accelerator usage. This is a fragment from {\tt hello.rc}: +\helpref{wxFrame::ShowFullScreen}{wxframeshowfullscreen} -\begin{verbatim} -#define HELLO_LOAD_FILE 111 +\membersection{wxFrame::IsIconized}\label{wxframeisiconized} -menus_accel ACCELERATORS -{ +\constfunc{bool}{IsIconized}{\void} -"^L", HELLO_LOAD_FILE +Returns TRUE if the frame is iconized. -} -\end{verbatim} +\membersection{wxFrame::IsMaximized}\label{wxframeismaximized} -This function only works under Windows. +\constfunc{bool}{IsMaximized}{\void} -% huh? If you call LoadAccelerators, you need to override wxFrame::OnActivate to do nothing. +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} @@ -255,21 +332,16 @@ This function only works under Windows. \membersection{wxFrame::OnActivate} -\func{void}{OnActivate}{\param{bool}{ active}} +\func{void}{OnActivate}{\param{wxActivateEvent\&}{ event}} Called when a window is activated or deactivated (MS Windows -only). If the window is being activated, {\it active} is TRUE, else it -is FALSE. - -If you call wxFrame::LoadAccelerators, you need to override this function e.g. - -\begin{verbatim} - void OnActivate(bool) {}; -\end{verbatim} +only). See also \helpref{wxActivateEvent}{wxactivateevent}. \membersection{wxFrame::OnCreateStatusBar}\label{wxframeoncreatestatusbar} -\func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{const int }{number}} +\func{virtual wxStatusBar*}{OnCreateStatusBar}{\param{int }{number}, + \param{long}{ style}, + \param{wxWindowID}{ id}, \param{const wxString\&}{ name}} Virtual function called when a status bar is requested by \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}. @@ -277,6 +349,14 @@ Virtual function called when a status bar is requested by \helpref{wxFrame::Crea \docparam{number}{The number of fields to create.} +\docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar} for a list +of valid styles.} + +\docparam{id}{The window identifier. If -1, an identifier will be chosen by +wxWindows.} + +\docparam{name}{The window name.} + \wxheading{Return value} A status bar object. @@ -290,6 +370,36 @@ implementation returns an instance of \helpref{wxStatusBar}{wxstatusbar}. \helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar}. +\membersection{wxFrame::OnCreateToolBar}\label{wxframeoncreatetoolbar} + +\func{virtual wxToolBar*}{OnCreateToolBar}{\param{long}{ style}, + \param{wxWindowID}{ id}, \param{const wxString\&}{ name}} + +Virtual function called when a toolbar is requested by \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}. + +\wxheading{Parameters} + +\docparam{style}{The toolbar style. See \helpref{wxToolBar}{wxtoolbar} for a list +of valid styles.} + +\docparam{id}{The toolbar window identifier. If -1, an identifier will be chosen by +wxWindows.} + +\docparam{name}{The toolbar window name.} + +\wxheading{Return value} + +A toolbar object. + +\wxheading{Remarks} + +An application can override this function to return a different kind of toolbar. The default +implementation returns an instance of \helpref{wxToolBar}{wxtoolbar}. + +\wxheading{See also} + +\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar}. + \membersection{wxFrame::OnMenuCommand}\label{wxframeonmenucommand} \func{void}{OnMenuCommand}{\param{wxCommandEvent\&}{ event}} @@ -329,36 +439,32 @@ 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. - -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. - -{\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. +% 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. See also \helpref{wxIcon}{wxicon}. @@ -388,9 +494,20 @@ Note that it is not possible to call this function twice for the same frame obje \helpref{wxFrame::GetMenuBar}{wxframegetmenubar}, \helpref{wxMenuBar}{wxmenubar}, \helpref{wxMenu}{wxmenu}. +\membersection{wxFrame::SetStatusBar}\label{wxframesetstatusbar} + +\func{void}{SetStatusBar}{\param{wxStatusBar*}{ statusBar}} + +Associates a status bar with the frame. + +\wxheading{See also} + +\helpref{wxFrame::CreateStatusBar}{wxframecreatestatusbar}, \helpref{wxStatusBar}{wxstatusbar},\rtfsp +\helpref{wxFrame::GetStatusBar}{wxframegetstatusbar} + \membersection{wxFrame::SetStatusText}\label{wxframesetstatustext} -\func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{const int}{ number = 0}} +\func{virtual void}{SetStatusText}{\param{const wxString\& }{ text}, \param{int}{ number = 0}} Sets the status bar text and redraws the status bar. @@ -410,7 +527,7 @@ Use an empty string to clear the status bar. \membersection{wxFrame::SetStatusWidths}\label{wxframesetstatuswidths} -\func{virtual void}{SetStatusWidths}{\param{const int}{ n}, \param{const int *}{widths}} +\func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}} Sets the widths of the fields in the status bar. @@ -426,9 +543,25 @@ field must be -1. You should delete this array after calling {\bf SetStatusWidth \wxheading{Remarks} The widths of the variable fields are calculated from the total width of all fields, -minus the sum of widths of the non-variable fields, divided by the number of +minus the sum of widths of the non-variable fields, divided by the number of 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} + +\func{void}{SetToolBar}{\param{wxToolBar*}{ toolBar}} + +Associates a toolbar with the frame. + +\wxheading{See also} + +\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp +\helpref{wxFrame::GetToolBar}{wxframegettoolbar} + \membersection{wxFrame::SetTitle}\label{wxframesettitle} \func{virtual void}{SetTitle}{\param{const wxString\& }{ title}} @@ -443,3 +576,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} +