]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/docmdich.tex
Some doc corrections; removed wxDocument arg from wxView constructor;
[wxWidgets.git] / docs / latex / wx / docmdich.tex
... / ...
CommitLineData
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{Include files}
21
22<wx/docmdi.h>
23
24\wxheading{See also}
25
26\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}
27
28\membersection{wxDocMDIChildFrame::m\_childDocument}
29
30\member{wxDocument*}{m\_childDocument}
31
32The document associated with the frame.
33
34\membersection{wxDocMDIChildFrame::m\_childView}
35
36\member{wxView*}{m\_childView}
37
38The view associated with the frame.
39
40\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}
41
42\func{}{wxDocMDIChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
43 \param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
44 \param{const wxSize\&}{ size = wxDefaultSize},
45 \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}
46
47Constructor.
48
49\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}
50
51\func{}{\destruct{wxDocMDIChildFrame}}{\void}
52
53Destructor.
54
55\membersection{wxDocMDIChildFrame::GetDocument}
56
57\constfunc{wxDocument*}{GetDocument}{\void}
58
59Returns the document associated with this frame.
60
61\membersection{wxDocMDIChildFrame::GetView}
62
63\constfunc{wxView*}{GetView}{\void}
64
65Returns the view associated with this frame.
66
67\membersection{wxDocMDIChildFrame::OnActivate}
68
69\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}
70
71Sets the currently active view to be the frame's view. You may need
72to override (but still call) this function in order to set the keyboard
73focus for your subwindow.
74
75\membersection{wxDocMDIChildFrame::OnCloseWindow}
76
77\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
78
79Closes and deletes the current view and document.
80
81\membersection{wxDocMDIChildFrame::SetDocument}
82
83\func{void}{SetDocument}{\param{wxDocument *}{doc}}
84
85Sets the document for this frame.
86
87\membersection{wxDocMDIChildFrame::SetView}
88
89\func{void}{SetView}{\param{wxView *}{view}}
90
91Sets the view for this frame.
92
93