]>
Commit | Line | Data |
---|---|---|
a660d684 KB |
1 | \section{\class{wxDocChildFrame}}\label{wxdocchildframe} |
2 | ||
3 | The wxDocChildFrame class provides a default frame for displaying documents | |
4 | on separate windows. This class can only be used for SDI (not MDI) child frames. | |
5 | ||
fc2171bd | 6 | The class is part of the document/view framework supported by wxWidgets, |
a660d684 KB |
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{wxFrame}{wxframe}\\ | |
15 | \helpref{wxWindow}{wxwindow}\\ | |
16 | \helpref{wxEvtHandler}{wxevthandler}\\ | |
17 | \helpref{wxObject}{wxobject} | |
18 | ||
954b8ae6 JS |
19 | \wxheading{Include files} |
20 | ||
21 | <wx/docview.h> | |
22 | ||
a7af285d VZ |
23 | \wxheading{Library} |
24 | ||
25 | \helpref{wxCore}{librarieslist} | |
26 | ||
a660d684 KB |
27 | \wxheading{See also} |
28 | ||
29 | \helpref{Document/view overview}{docviewoverview}, \helpref{wxFrame}{wxframe} | |
30 | ||
b236c10f | 31 | \membersection{wxDocChildFrame::m\_childDocument}\label{wxdocchildframemchilddocument} |
a660d684 KB |
32 | |
33 | \member{wxDocument*}{m\_childDocument} | |
34 | ||
35 | The document associated with the frame. | |
36 | ||
b236c10f | 37 | \membersection{wxDocChildFrame::m\_childView}\label{wxdocchildframemchildview} |
a660d684 KB |
38 | |
39 | \member{wxView*}{m\_childView} | |
40 | ||
41 | The view associated with the frame. | |
42 | ||
b236c10f | 43 | \membersection{wxDocChildFrame::wxDocChildFrame}\label{wxdocchildframector} |
a660d684 KB |
44 | |
45 | \func{}{wxDocChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent}, | |
f7bd2698 | 46 | \param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition}, |
a660d684 KB |
47 | \param{const wxSize\&}{ size = wxDefaultSize}, |
48 | \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}} | |
49 | ||
50 | Constructor. | |
51 | ||
b236c10f | 52 | \membersection{wxDocChildFrame::\destruct{wxDocChildFrame}}\label{wxdocchildframedtor} |
a660d684 KB |
53 | |
54 | \func{}{\destruct{wxDocChildFrame}}{\void} | |
55 | ||
56 | Destructor. | |
57 | ||
b236c10f | 58 | \membersection{wxDocChildFrame::GetDocument}\label{wxdocchildframegetdocument} |
a660d684 KB |
59 | |
60 | \constfunc{wxDocument*}{GetDocument}{\void} | |
61 | ||
62 | Returns the document associated with this frame. | |
63 | ||
b236c10f | 64 | \membersection{wxDocChildFrame::GetView}\label{wxdocchildframegetview} |
a660d684 KB |
65 | |
66 | \constfunc{wxView*}{GetView}{\void} | |
67 | ||
68 | Returns the view associated with this frame. | |
69 | ||
b236c10f | 70 | \membersection{wxDocChildFrame::OnActivate}\label{wxdocchildframeonactivate} |
a660d684 | 71 | |
82540ef2 | 72 | \func{void}{OnActivate}{\param{wxActivateEvent}{ event}} |
a660d684 KB |
73 | |
74 | Sets the currently active view to be the frame's view. You may need | |
75 | to override (but still call) this function in order to set the keyboard | |
76 | focus for your subwindow. | |
77 | ||
b236c10f | 78 | \membersection{wxDocChildFrame::OnCloseWindow}\label{wxdocchildframeonclosewindow} |
a660d684 | 79 | |
82540ef2 | 80 | \func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}} |
a660d684 KB |
81 | |
82 | Closes and deletes the current view and document. | |
83 | ||
b236c10f | 84 | \membersection{wxDocChildFrame::SetDocument}\label{wxdocchildframesetdocument} |
a660d684 KB |
85 | |
86 | \func{void}{SetDocument}{\param{wxDocument *}{doc}} | |
87 | ||
88 | Sets the document for this frame. | |
89 | ||
b236c10f | 90 | \membersection{wxDocChildFrame::SetView}\label{wxdocchildframesetview} |
a660d684 KB |
91 | |
92 | \func{void}{SetView}{\param{wxView *}{view}} | |
93 | ||
94 | Sets the view for this frame. | |
95 | ||
96 |