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