X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/eaaa6a06a25774c18d10bb8182cc1934ed0ed9aa..d9c8e68e58c5d6b0debc5df02b8fa6dba719e12e:/docs/latex/wx/frame.tex diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index a41ddd02f2..ba58e1fe8c 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,21 +16,31 @@ 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{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{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. } \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -122,7 +138,9 @@ for further details. \membersection{wxFrame::CreateStatusBar}\label{wxframecreatestatusbar} -\func{virtual bool}{CreateStatusBar}{\param{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 +149,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 +177,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} @@ -178,62 +250,42 @@ Returns a pointer to the status bar currently associated with the frame (if any) Gets a temporary pointer to the frame title. See \helpref{wxFrame::SetTitle}{wxframesettitle}. -\membersection{wxFrame::Iconize}\label{wxframeiconize} - -\func{void}{Iconize}{\param{const bool}{ iconize}} - -Iconizes or restores the frame. +\membersection{wxFrame::GetToolBar}\label{wxframegettoolbar} -\wxheading{Parameters} +\func{wxToolBar*}{GetToolBar}{\void} -\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}. +\helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}, \helpref{wxToolBar}{wxtoolbar},\rtfsp +\helpref{wxFrame::SetToolBar}{wxframesettoolbar} -\membersection{wxFrame::IsIconized}\label{wxframeisiconized} - -\func{bool}{IsIconized}{\void} - -Returns TRUE if the frame is iconized. - -\membersection{wxFrame::LoadAccelerators}\label{wxframeloadaccelerators} +\membersection{wxFrame::Iconize}\label{wxframeiconize} -\func{void}{LoadAccelerators}{\param{const wxString\& }{table}} +\func{void}{Iconize}{\param{const bool}{ iconize}} -Loads a keyboard accelerator table for this frame. +Iconizes or restores the frame. Windows only. \wxheading{Parameters} -\docparam{table}{Accelerator table to load.} - -\wxheading{Return value} - -TRUE if the operation was successful, FALSE otherwise. - -\wxheading{Remarks} +\docparam{izonize}{If TRUE, iconizes the frame; if FALSE, shows and restores it.} -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::IsIconized}{wxframeisiconized}, \helpref{wxFrame::Maximize}{wxframemaximize}. -\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. Windows only. -} -\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} @@ -255,21 +307,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{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 +324,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 +345,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}} @@ -388,6 +473,17 @@ 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{int}{ number = 0}} @@ -426,9 +522,24 @@ 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.} + + +\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}}