]>
Commit | Line | Data |
---|---|---|
1 | \section{\class{wxDocMDIChildFrame}}\label{wxdocmdichildframe} | |
2 | ||
3 | The wxDocMDIChildFrame class provides a default frame for displaying documents | |
4 | on separate windows. This class can only be used for MDI child frames. | |
5 | ||
6 | The class is part of the document/view framework supported by wxWidgets, | |
7 | and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument}, | |
8 | \rtfsp\helpref{wxDocManager}{wxdocmanager} and \helpref{wxDocTemplate}{wxdoctemplate} classes. | |
9 | ||
10 | See 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 | \membersection{wxDocMDIChildFrame::m\_childDocument}\label{wxdocmdichildframemchilddocument} | |
34 | ||
35 | \member{wxDocument*}{m\_childDocument} | |
36 | ||
37 | The document associated with the frame. | |
38 | ||
39 | \membersection{wxDocMDIChildFrame::m\_childView}\label{wxdocmdichildframemchildview} | |
40 | ||
41 | \member{wxView*}{m\_childView} | |
42 | ||
43 | The view associated with the frame. | |
44 | ||
45 | \membersection{wxDocMDIChildFrame::wxDocMDIChildFrame}\label{wxdocmdichildframector} | |
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 | ||
52 | Constructor. | |
53 | ||
54 | \membersection{wxDocMDIChildFrame::\destruct{wxDocMDIChildFrame}}\label{wxdocmdichildframedtor} | |
55 | ||
56 | \func{}{\destruct{wxDocMDIChildFrame}}{\void} | |
57 | ||
58 | Destructor. | |
59 | ||
60 | \membersection{wxDocMDIChildFrame::GetDocument}\label{wxdocmdichildframegetdocument} | |
61 | ||
62 | \constfunc{wxDocument*}{GetDocument}{\void} | |
63 | ||
64 | Returns the document associated with this frame. | |
65 | ||
66 | \membersection{wxDocMDIChildFrame::GetView}\label{wxdocmdichildframegetview} | |
67 | ||
68 | \constfunc{wxView*}{GetView}{\void} | |
69 | ||
70 | Returns the view associated with this frame. | |
71 | ||
72 | \membersection{wxDocMDIChildFrame::OnActivate}\label{wxdocmdichildframeonactivate} | |
73 | ||
74 | \func{void}{OnActivate}{\param{wxActivateEvent}{ event}} | |
75 | ||
76 | Sets the currently active view to be the frame's view. You may need | |
77 | to override (but still call) this function in order to set the keyboard | |
78 | focus for your subwindow. | |
79 | ||
80 | \membersection{wxDocMDIChildFrame::OnCloseWindow}\label{wxdocmdichildframeonclosewindow} | |
81 | ||
82 | \func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}} | |
83 | ||
84 | Closes and deletes the current view and document. | |
85 | ||
86 | \membersection{wxDocMDIChildFrame::SetDocument}\label{wxdocmdichildframesetdocument} | |
87 | ||
88 | \func{void}{SetDocument}{\param{wxDocument *}{doc}} | |
89 | ||
90 | Sets the document for this frame. | |
91 | ||
92 | \membersection{wxDocMDIChildFrame::SetView}\label{wxdocmdichildframesetview} | |
93 | ||
94 | \func{void}{SetView}{\param{wxView *}{view}} | |
95 | ||
96 | Sets the view for this frame. | |
97 | ||
98 |