X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/mdi.tex diff --git a/docs/latex/wx/mdi.tex b/docs/latex/wx/mdi.tex index 61644c1874..b0564b043c 100644 --- a/docs/latex/wx/mdi.tex +++ b/docs/latex/wx/mdi.tex @@ -10,6 +10,10 @@ which is itself a child of \helpref{wxMDIParentFrame}{wxmdiparentframe}. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Window styles} \twocolwidtha{5cm} @@ -57,7 +61,7 @@ frame's own menubar will be displayed. Default constructor. -\func{}{wxMDIChildFrame}{\param{wxMDIParentFrame* }{parent}, \param{const wxWindowID }{id},\rtfsp +\func{}{wxMDIChildFrame}{\param{wxMDIParentFrame* }{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"}} @@ -111,7 +115,7 @@ Activates this MDI child frame. \membersection{wxMDIChildFrame::Create}\label{wxmdichildframecreate} -\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"}} @@ -141,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 @@ -153,6 +156,10 @@ more \helpref{wxMDIChildFrame}{wxmdichildframe} objects. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Remarks} The client window is the area where MDI child windows exist. It doesn't have to cover the whole @@ -225,6 +232,10 @@ and is used in many popular Windows applications, such as Microsoft Word(TM). \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Remarks} There may be multiple MDI parent frames in a single application, but this probably only makes sense @@ -234,7 +245,7 @@ Child frames may be either \helpref{wxMDIChildFrame}{wxmdichildframe}, or \helpr 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 @@ -264,6 +275,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}. @@ -281,7 +294,7 @@ See also \helpref{window styles overview}{windowstyles}. Default constructor. -\func{}{wxMDIParentFrame}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp +\func{}{wxMDIParentFrame}{\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 \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp \param{const wxString\& }{name = ``frame"}} @@ -373,7 +386,7 @@ Arranges the MDI child windows in a cascade. \membersection{wxMDIParentFrame::Create}\label{wxmdiparentframecreate} -\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 \pipe wxVSCROLL \pipe wxHSCROLL},\rtfsp \param{const wxString\& }{name = ``frame"}} @@ -422,6 +435,10 @@ automatically by the client window. \helpref{wxWindow}{wxwindowonsize},\rtfsp \helpref{wxMDIClientWindow}{wxmdiclientwindow} + +\pythonnote{The wxPython version of this method takes no arguments and +returns a tuple containing width and height.} + \membersection{wxMDIParentFrame::GetActiveChild}\label{wxmdiparentframegetactivechild} \constfunc{wxMDIChildFrame*}{GetActiveChild}{\void} @@ -448,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 wxWindows 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} @@ -462,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} @@ -501,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}