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