no changes, just come cleanup and more comments

[wxWidgets.git] / docs / latex / wx / docchfrm.tex

\section{\class{wxDocChildFrame}}\label{wxdocchildframe}

The wxDocChildFrame class provides a default frame for displaying documents
on separate windows. This class can only be used for SDI (not MDI) child frames.

The class is part of the document/view framework supported by wxWidgets,
and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocument}{wxdocument},
\rtfsp\helpref{wxDocManager}{wxdocmanager} and \helpref{wxDocTemplate}{wxdoctemplate} classes.

See the example application in {\tt samples/docview}.

\wxheading{Derived from}

\helpref{wxFrame}{wxframe}\\
\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/docview.h>

\wxheading{Library}

\helpref{wxCore}{librarieslist}

\wxheading{See also}

\helpref{Document/view overview}{docviewoverview}, \helpref{wxFrame}{wxframe}



\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxDocChildFrame::m\_childDocument}\label{wxdocchildframemchilddocument}

\member{wxDocument*}{m\_childDocument}

The document associated with the frame.

\membersection{wxDocChildFrame::m\_childView}\label{wxdocchildframemchildview}

\member{wxView*}{m\_childView}

The view associated with the frame.

\membersection{wxDocChildFrame::wxDocChildFrame}\label{wxdocchildframector}

\func{}{wxDocChildFrame}{\param{wxDocument* }{doc}, \param{wxView* }{view}, \param{wxFrame* }{parent},
 \param{wxWindowID}{ id}, \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},
 \param{const wxSize\&}{ size = wxDefaultSize},
 \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}

Constructor.

\membersection{wxDocChildFrame::\destruct{wxDocChildFrame}}\label{wxdocchildframedtor}

\func{}{\destruct{wxDocChildFrame}}{\void}

Destructor.

\membersection{wxDocChildFrame::GetDocument}\label{wxdocchildframegetdocument}

\constfunc{wxDocument*}{GetDocument}{\void}

Returns the document associated with this frame.

\membersection{wxDocChildFrame::GetView}\label{wxdocchildframegetview}

\constfunc{wxView*}{GetView}{\void}

Returns the view associated with this frame.

\membersection{wxDocChildFrame::OnActivate}\label{wxdocchildframeonactivate}

\func{void}{OnActivate}{\param{wxActivateEvent}{ event}}

Sets the currently active view to be the frame's view. You may need
to override (but still call) this function in order to set the keyboard
focus for your subwindow.

\membersection{wxDocChildFrame::OnCloseWindow}\label{wxdocchildframeonclosewindow}

\func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}

Closes and deletes the current view and document.

\membersection{wxDocChildFrame::SetDocument}\label{wxdocchildframesetdocument}

\func{void}{SetDocument}{\param{wxDocument *}{doc}}

Sets the document for this frame.

\membersection{wxDocChildFrame::SetView}\label{wxdocchildframesetview}

\func{void}{SetView}{\param{wxView *}{view}}

Sets the view for this frame.