]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/docmdich.tex
Changed GetForce -> !CanVeto
[wxWidgets.git] / docs / latex / wx / docmdich.tex
CommitLineData
f7bd2698
JS
1\section{\class{wxDocMDIChildFrame}}\label{wxdocmdichildframe}
2
3The wxDocMDIChildFrame class provides a default frame for displaying documents
4on separate windows. This class can only be used for MDI child frames.
5
6The class is part of the document/view framework supported by wxWindows,
7and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument},
8\rtfsp\helpref{wxDocManager}{wxdocmanager} and \helpref{wxDocTemplate}{wxdoctemplate} classes.
9
10See the example application in {\tt samples/docview}.
11
12\wxheading{Derived from}
13
14\helpref{wxMDIChildFrame}{wxmdichildframe}\\
15\helpref{wxFrame}{wxframe}\\
16\helpref{wxWindow}{wxwindow}\\
17\helpref{wxEvtHandler}{wxevthandler}\\
18\helpref{wxObject}{wxobject}
19
20\wxheading{See also}
21
22\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}
23
24\membersection{wxDocMDIChildFrame::m\_childDocument}
25
26\member{wxDocument*}{m\_childDocument}
27
28The document associated with the frame.
29
30\membersection{wxDocMDIChildFrame::m\_childView}
31
32\member{wxView*}{m\_childView}
33
34The view associated with the frame.
35
36\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}
37
38\func{}{wxDocMDIChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
39 \param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
40 \param{const wxSize\&}{ size = wxDefaultSize},
41 \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}
42
43Constructor.
44
45\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}
46
47\func{}{\destruct{wxDocMDIChildFrame}}{\void}
48
49Destructor.
50
51\membersection{wxDocMDIChildFrame::GetDocument}
52
53\constfunc{wxDocument*}{GetDocument}{\void}
54
55Returns the document associated with this frame.
56
57\membersection{wxDocMDIChildFrame::GetView}
58
59\constfunc{wxView*}{GetView}{\void}
60
61Returns the view associated with this frame.
62
63\membersection{wxDocMDIChildFrame::OnActivate}
64
82540ef2 65\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}
f7bd2698
JS
66
67Sets the currently active view to be the frame's view. You may need
68to override (but still call) this function in order to set the keyboard
69focus for your subwindow.
70
82540ef2 71\membersection{wxDocMDIChildFrame::OnCloseWindow}
f7bd2698 72
82540ef2 73\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
f7bd2698
JS
74
75Closes and deletes the current view and document.
76
77\membersection{wxDocMDIChildFrame::SetDocument}
78
79\func{void}{SetDocument}{\param{wxDocument *}{doc}}
80
81Sets the document for this frame.
82
83\membersection{wxDocMDIChildFrame::SetView}
84
85\func{void}{SetView}{\param{wxView *}{view}}
86
87Sets the view for this frame.
88
89