]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/docmdich.tex
Applied patch [ 1747059 ] wxAUIDefaultTabArt wxAUI_NB_BOTTOM
[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
fc2171bd 6The class is part of the document/view framework supported by wxWidgets,
f7bd2698
JS
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}\\
7376079d 16\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
f7bd2698
JS
17\helpref{wxWindow}{wxwindow}\\
18\helpref{wxEvtHandler}{wxevthandler}\\
19\helpref{wxObject}{wxobject}
20
954b8ae6
JS
21\wxheading{Include files}
22
23<wx/docmdi.h>
24
a7af285d
VZ
25\wxheading{Library}
26
27\helpref{wxCore}{librarieslist}
28
f7bd2698
JS
29\wxheading{See also}
30
31\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}
32
b236c10f 33\membersection{wxDocMDIChildFrame::m\_childDocument}\label{wxdocmdichildframemchilddocument}
f7bd2698
JS
34
35\member{wxDocument*}{m\_childDocument}
36
37The document associated with the frame.
38
b236c10f 39\membersection{wxDocMDIChildFrame::m\_childView}\label{wxdocmdichildframemchildview}
f7bd2698
JS
40
41\member{wxView*}{m\_childView}
42
43The view associated with the frame.
44
b236c10f 45\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}\label{wxdocmdichildframector}
f7bd2698
JS
46
47\func{}{wxDocMDIChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
48 \param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
49 \param{const wxSize\&}{ size = wxDefaultSize},
50 \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}
51
52Constructor.
53
b236c10f 54\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}\label{wxdocmdichildframedtor}
f7bd2698
JS
55
56\func{}{\destruct{wxDocMDIChildFrame}}{\void}
57
58Destructor.
59
b236c10f 60\membersection{wxDocMDIChildFrame::GetDocument}\label{wxdocmdichildframegetdocument}
f7bd2698
JS
61
62\constfunc{wxDocument*}{GetDocument}{\void}
63
64Returns the document associated with this frame.
65
b236c10f 66\membersection{wxDocMDIChildFrame::GetView}\label{wxdocmdichildframegetview}
f7bd2698
JS
67
68\constfunc{wxView*}{GetView}{\void}
69
70Returns the view associated with this frame.
71
b236c10f 72\membersection{wxDocMDIChildFrame::OnActivate}\label{wxdocmdichildframeonactivate}
f7bd2698 73
82540ef2 74\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}
f7bd2698
JS
75
76Sets the currently active view to be the frame's view. You may need
77to override (but still call) this function in order to set the keyboard
78focus for your subwindow.
79
b236c10f 80\membersection{wxDocMDIChildFrame::OnCloseWindow}\label{wxdocmdichildframeonclosewindow}
f7bd2698 81
82540ef2 82\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
f7bd2698
JS
83
84Closes and deletes the current view and document.
85
b236c10f 86\membersection{wxDocMDIChildFrame::SetDocument}\label{wxdocmdichildframesetdocument}
f7bd2698
JS
87
88\func{void}{SetDocument}{\param{wxDocument *}{doc}}
89
90Sets the document for this frame.
91
b236c10f 92\membersection{wxDocMDIChildFrame::SetView}\label{wxdocmdichildframesetview}
f7bd2698
JS
93
94\func{void}{SetView}{\param{wxView *}{view}}
95
96Sets the view for this frame.
97
98