| | 1 | \section{\class{wxDocMDIParentFrame}}\label{wxdocmdiparentframe} |
| | 2 | |
| | 3 | The wxDocMDIParentFrame class provides a default top-level frame for |
| | 4 | applications using the document/view framework. This class can only be used for MDI parent frames. |
| | 5 | |
| | 6 | It cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument}, |
| | 7 | \rtfsp\helpref{wxDocManager}{wxdocmanager} and \helpref{wxDocTemplates}{wxdoctemplate} classes. |
| | 8 | |
| | 9 | See the example application in {\tt samples/docview}. |
| | 10 | |
| | 11 | \wxheading{Derived from} |
| | 12 | |
| | 13 | \helpref{wxMDIParentFrame}{wxmdiparentframe}\\ |
| | 14 | \helpref{wxFrame}{wxframe}\\ |
| | 15 | \helpref{wxWindow}{wxwindow}\\ |
| | 16 | \helpref{wxEvtHandler}{wxevthandler}\\ |
| | 17 | \helpref{wxObject}{wxobject} |
| | 18 | |
| | 19 | \wxheading{Include files} |
| | 20 | |
| | 21 | <wx/docmdi.h> |
| | 22 | |
| | 23 | \wxheading{See also} |
| | 24 | |
| | 25 | \helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIParentFrame}{wxmdiparentframe} |
| | 26 | |
| | 27 | \latexignore{\rtfignore{\wxheading{Members}}} |
| | 28 | |
| | 29 | \membersection{wxDocMDIParentFrame::wxDocMDIParentFrame}\label{wxdocmdiparentframector} |
| | 30 | |
| | 31 | \func{}{wxDocParentFrame}{\param{wxDocManager*}{ manager}, \param{wxFrame *}{parent}, \param{wxWindowID}{ id}, |
| | 32 | \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, |
| | 33 | \param{const wxSize\&}{ size = wxDefaultSize}, |
| | 34 | \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = "frame"}} |
| | 35 | |
| | 36 | Constructor. |
| | 37 | |
| | 38 | \membersection{wxDocMDIParentFrame::\destruct{wxDocMDIParentFrame}}\label{wxdocmdiparentframedtor} |
| | 39 | |
| | 40 | \func{}{\destruct{wxDocMDIParentFrame}}{\void} |
| | 41 | |
| | 42 | Destructor. |
| | 43 | |
| | 44 | \membersection{wxDocMDIParentFrame::OnCloseWindow}\label{wxdocmdiparentframeonclosewindow} |
| | 45 | |
| | 46 | \func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}} |
| | 47 | |
| | 48 | Deletes all views and documents. If no user input cancelled the |
| | 49 | operation, the frame will be destroyed and the application will exit. |
| | 50 | |
| | 51 | Since understanding how document/view clean-up takes place can be difficult, |
| | 52 | the implementation of this function is shown below. |
| | 53 | |
| | 54 | \begin{verbatim} |
| | 55 | void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event) |
| | 56 | { |
| | 57 | if (m_docManager->Clear(!event.CanVeto())) |
| | 58 | { |
| | 59 | this->Destroy(); |
| | 60 | } |
| | 61 | else |
| | 62 | event.Veto(); |
| | 63 | } |
| | 64 | \end{verbatim} |
| | 65 | |
projects / wxWidgets.git / blame_incremental