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