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