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