]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/docprfrm.tex
added SetStatusText method (avoiding dc.Clear)
[wxWidgets.git] / docs / latex / wx / docprfrm.tex
1 \section{\class{wxDocParentFrame}}\label{wxdocparentframe}
2
3 The wxDocParentFrame class provides a default top-level frame for
4 applications using the document/view framework. This class can only be used for SDI (not 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{wxFrame}{wxframe}\\
14 \helpref{wxWindow}{wxwindow}\\
15 \helpref{wxEvtHandler}{wxevthandler}\\
16 \helpref{wxObject}{wxobject}
17
18 \wxheading{Include files}
19
20 <wx/docview.h>
21
22 \wxheading{See also}
23
24 \helpref{Document/view overview}{docviewoverview}, \helpref{wxFrame}{wxframe}
25
26 \latexignore{\rtfignore{\wxheading{Members}}}
27
28 \membersection{wxDocParentFrame::wxDocParentFrame}
29
30 \func{}{wxDocParentFrame}{\param{wxDocManager*}{ manager}, \param{wxFrame *}{parent}, \param{wxWindowID}{ id},
31 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
32 \param{const wxSize\&}{ size = wxDefaultSize},
33 \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = "frame"}}
34
35 Constructor.
36
37 \membersection{wxDocParentFrame::\destruct{wxDocParentFrame}}
38
39 \func{}{\destruct{wxDocParentFrame}}{\void}
40
41 Destructor.
42
43 \membersection{wxDocParentFrame::OnCloseWindow}
44
45 \func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
46
47 Deletes all views and documents. If no user input cancelled the
48 operation, the frame will be destroyed and the application will exit.
49
50 Since understanding how document/view clean-up takes place can be difficult,
51 the implementation of this function is shown below.
52
53 \begin{verbatim}
54 void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event)
55 {
56 if (m_docManager->Clear(!event.CanVeto()))
57 {
58 this->Destroy();
59 }
60 else
61 event.Veto();
62 }
63 \end{verbatim}
64