1 \section{\class{wxDocParentFrame
}}\label{wxdocparentframe
}
3 The wxDocParentFrame class provides a default top-level frame for
4 applications using the
document/view framework. This class can only be used for SDI (not MDI) parent frames.
6 It cooperates with the
\helpref{wxView
}{wxview
},
\helpref{wxDocument
}{wxdocument
},
7 \rtfsp\helpref{wxDocManager
}{wxdocmanager
} and
\helpref{wxDocTemplates
}{wxdoctemplate
} classes.
9 See the example application in
{\tt samples/docview
}.
11 \wxheading{Derived from
}
13 \helpref{wxFrame
}{wxframe
}\\
14 \helpref{wxWindow
}{wxwindow
}\\
15 \helpref{wxEvtHandler
}{wxevthandler
}\\
16 \helpref{wxObject
}{wxobject
}
18 \wxheading{Include files
}
24 \helpref{Document/view overview
}{docviewoverview
},
\helpref{wxFrame
}{wxframe
}
26 \latexignore{\rtfignore{\wxheading{Members
}}}
28 \membersection{wxDocParentFrame::wxDocParentFrame
}\label{wxdocparentframector
}
30 \func{}{wxDocParentFrame
}{\void}
34 \func{}{wxDocParentFrame
}{\param{wxDocManager*
}{ manager
},
\param{wxFrame *
}{parent
},
\param{wxWindowID
}{ id
},
35 \param{const wxString\&
}{title
},
\param{const wxPoint\&
}{ pos = wxDefaultPosition
},
36 \param{const wxSize\&
}{ size = wxDefaultSize
},
37 \param{long
}{ style = wxDEFAULT
\_FRAME\_STYLE},
\param{const wxString\&
}{name = "frame"
}}
41 \membersection{wxDocParentFrame::
\destruct{wxDocParentFrame
}}\label{wxdocparentframedtor
}
43 \func{}{\destruct{wxDocParentFrame
}}{\void}
47 \membersection{wxDocParentFrame::Create
}\label{wxdocparentframecreate
}
49 \func{bool
}{Create
}{\param{wxDocManager*
}{ manager
},
\param{wxFrame *
}{parent
},
\param{wxWindowID
}{ id
},
50 \param{const wxString\&
}{title
},
\param{const wxPoint\&
}{ pos = wxDefaultPosition
},
51 \param{const wxSize\&
}{ size = wxDefaultSize
},
52 \param{long
}{ style = wxDEFAULT
\_FRAME\_STYLE},
\param{const wxString\&
}{name = "frame"
}}
54 Used in two-step construction.
56 \membersection{wxDocParentFrame::GetDocumentManager
}\label{wxdocparentframegetdocumentmanager
}
58 \constfunc{wxDocManager *
}{GetDocumentManager
}{\void}
60 Returns the associated
\helpref{document manager object
}{wxdocmanager
}.
64 \membersection{wxDocParentFrame::OnCloseWindow
}\label{wxdocparentframeonclosewindow
}
66 \func{void
}{OnCloseWindow
}{\param{wxCloseEvent\&
}{ event
}}
68 Deletes all views and documents. If no user input cancelled the
69 operation, the frame will be destroyed and the application will exit.
71 Since understanding how
document/view clean-up takes place can be difficult,
72 the implementation of this function is shown below.
75 void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event)
77 if (m_docManager->Clear(!event.CanVeto()))