]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/docmdich.tex
Always draw the selection of selected items, not just when they have
[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}\\
16\helpref{wxWindow}{wxwindow}\\
17\helpref{wxEvtHandler}{wxevthandler}\\
18\helpref{wxObject}{wxobject}
19
954b8ae6
JS
20\wxheading{Include files}
21
22<wx/docmdi.h>
23
f7bd2698
JS
24\wxheading{See also}
25
26\helpref{Document/view overview}{docviewoverview}, \helpref{wxMDIChildFrame}{wxmdichildframe}
27
b236c10f 28\membersection{wxDocMDIChildFrame::m\_childDocument}\label{wxdocmdichildframemchilddocument}
f7bd2698
JS
29
30\member{wxDocument*}{m\_childDocument}
31
32The document associated with the frame.
33
b236c10f 34\membersection{wxDocMDIChildFrame::m\_childView}\label{wxdocmdichildframemchildview}
f7bd2698
JS
35
36\member{wxView*}{m\_childView}
37
38The view associated with the frame.
39
b236c10f 40\membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}\label{wxdocmdichildframector}
f7bd2698
JS
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
b236c10f 49\membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}\label{wxdocmdichildframedtor}
f7bd2698
JS
50
51\func{}{\destruct{wxDocMDIChildFrame}}{\void}
52
53Destructor.
54
b236c10f 55\membersection{wxDocMDIChildFrame::GetDocument}\label{wxdocmdichildframegetdocument}
f7bd2698
JS
56
57\constfunc{wxDocument*}{GetDocument}{\void}
58
59Returns the document associated with this frame.
60
b236c10f 61\membersection{wxDocMDIChildFrame::GetView}\label{wxdocmdichildframegetview}
f7bd2698
JS
62
63\constfunc{wxView*}{GetView}{\void}
64
65Returns the view associated with this frame.
66
b236c10f 67\membersection{wxDocMDIChildFrame::OnActivate}\label{wxdocmdichildframeonactivate}
f7bd2698 68
82540ef2 69\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}
f7bd2698
JS
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
b236c10f 75\membersection{wxDocMDIChildFrame::OnCloseWindow}\label{wxdocmdichildframeonclosewindow}
f7bd2698 76
82540ef2 77\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}
f7bd2698
JS
78
79Closes and deletes the current view and document.
80
b236c10f 81\membersection{wxDocMDIChildFrame::SetDocument}\label{wxdocmdichildframesetdocument}
f7bd2698
JS
82
83\func{void}{SetDocument}{\param{wxDocument *}{doc}}
84
85Sets the document for this frame.
86
b236c10f 87\membersection{wxDocMDIChildFrame::SetView}\label{wxdocmdichildframesetview}
f7bd2698
JS
88
89\func{void}{SetView}{\param{wxView *}{view}}
90
91Sets the view for this frame.
92
93