X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/06d20283afba5439c8a2c1b3b7cd3390541da52d..b41f29c357205531670a156b67247b9345688150:/docs/latex/wx/mdi.tex diff --git a/docs/latex/wx/mdi.tex b/docs/latex/wx/mdi.tex index 64d7d75eb9..40420973e2 100644 --- a/docs/latex/wx/mdi.tex +++ b/docs/latex/wx/mdi.tex @@ -36,7 +36,7 @@ See also \helpref{window styles overview}{windowstyles}. \wxheading{Remarks} -Although internally an MDI child frame is a child of the MDI client window, in wxWindows +Although internally an MDI child frame is a child of the MDI client window, in wxWidgets you create it as a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}. You can usually forget that the client window exists. @@ -77,10 +77,10 @@ Constructor, creating the window. \docparam{title}{The caption to be displayed on the frame's title bar.} \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by -either the windowing system or wxWindows, depending on platform.} +either the windowing system or wxWidgets, depending on platform.} \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by -either the windowing system or wxWindows, depending on platform.} +either the windowing system or wxWidgets, depending on platform.} \docparam{style}{The window style. See \helpref{wxMDIChildFrame}{wxmdichildframe}.} @@ -145,7 +145,6 @@ Restores this MDI child frame (unmaximizes). \helpref{wxMDIChildFrame::Activate}{wxmdichildframeactivate},\rtfsp \helpref{wxMDIChildFrame::Maximize}{wxmdichildframemaximize} - \section{\class{wxMDIClientWindow}}\label{wxmdiclientwindow} An MDI client window is a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}, and manages zero or @@ -242,11 +241,12 @@ and is used in many popular Windows applications, such as Microsoft Word(TM). There may be multiple MDI parent frames in a single application, but this probably only makes sense within programming development environments. -Child frames may be either \helpref{wxMDIChildFrame}{wxmdichildframe}, or \helpref{wxFrame}{wxframe}. +Child frames may be of class \helpref{wxMDIChildFrame}{wxmdichildframe} (contained +within the parent frame) or \helpref{wxFrame}{wxframe} (shown as a top-level frame). An MDI parent frame always has a \helpref{wxMDIClientWindow}{wxmdiclientwindow} associated with it, which is the parent for MDI client frames. -This client window may be resized to accomodate non-MDI windows, as seen in Microsoft Visual C++ (TM) and +This client window may be resized to accommodate non-MDI windows, as seen in Microsoft Visual C++ (TM) and Microsoft Publisher (TM), where a documentation window is placed to one side of the workspace. MDI remains popular despite dire warnings from Microsoft itself that MDI is an obsolete @@ -276,6 +276,8 @@ for Windows, it is implicit in wxTHICK\_FRAME).} \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).} \twocolitem{\windowstyle{wxVSCROLL}}{Displays a vertical scrollbar in the {\it client window}, allowing the user to view child frames that are off the current view.} +\twocolitem{\windowstyle{wxFRAME\_NO\_WINDOW\_MENU}}{Under Windows, removes the Window menu that is normally +added automatically.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. @@ -309,10 +311,10 @@ Constructor, creating the window. \docparam{title}{The caption to be displayed on the frame's title bar.} \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by -either the windowing system or wxWindows, depending on platform.} +either the windowing system or wxWidgets, depending on platform.} \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by -either the windowing system or wxWindows, depending on platform.} +either the windowing system or wxWidgets, depending on platform.} \docparam{style}{The window style. See \helpref{wxMDIParentFrame}{wxmdiparentframe}.} @@ -431,7 +433,6 @@ automatically by the client window. \helpref{wxMDIParentFrame::GetToolBar}{wxmdiparentframegettoolbar},\rtfsp \helpref{wxMDIParentFrame::SetToolBar}{wxmdiparentframesettoolbar},\rtfsp -\helpref{wxWindow}{wxwindowonsize},\rtfsp \helpref{wxMDIClientWindow}{wxmdiclientwindow} @@ -464,11 +465,25 @@ Returns the window being used as the toolbar for this frame. \helpref{wxMDIParentFrame::SetToolBar}{wxmdiparentframesettoolbar} +\membersection{wxMDIParentFrame::GetWindowMenu}\label{wxmdiparentframegetwindowmenu} + +\constfunc{wxMenu*}{GetWindowMenu}{\void} + +Returns the current Window menu (added by wxWidgets to the menubar). This function +is available under Windows only. + \membersection{wxMDIParentFrame::OnCreateClient}\label{wxmdiparentframeoncreateclient} \func{virtual wxMDIClientWindow*}{OnCreateClient}{\void} -Override this to return a different kind of client window. +Override this to return a different kind of client window. If you override this function, +you must create your parent frame in two stages, or your function will never be called, +due to the way C++ treats virtual functions called from constructors. For example: + +\begin{verbatim} + frame = new MyParentFrame; + frame->Create(parent, myParentFrameId, wxT("My Parent Frame")); +\end{verbatim} \wxheading{Remarks} @@ -478,7 +493,7 @@ on the background. Note that it is probably impossible to have a client window that scrolls as well as painting a bitmap or pattern, since in {\bf OnScroll}, the scrollbar positions always return zero. -(Solutions to: \verb$julian.smart@ukonline.co.uk$). +(Solutions to: {\tt julian.smart@btopenworld.com}). \wxheading{See also} @@ -517,6 +532,17 @@ toolbars managed by the application. \helpref{wxMDIParentFrame::GetToolBar}{wxmdiparentframegettoolbar},\rtfsp \helpref{wxMDIParentFrame::GetClientSize}{wxmdiparentframegetclientsize} +\membersection{wxMDIParentFrame::SetWindowMenu}\label{wxmdiparentframesetwindowmenu} + +\func{void}{SetWindowMenu}{\param{wxMenu*}{ menu}} + +Call this to change the current Window menu. Ownership of the menu object passes to +the frame when you call this function. + +This call is available under Windows only. + +To remove the window completely, use the wxFRAME\_NO\_WINDOW\_MENU window style. + \membersection{wxMDIParentFrame::Tile}\label{wxmdiparentframetile} \func{void}{Tile}{\void}