interface/docmdi.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        docmdi.h
   3 // Purpose:     documentation for wxDocMDIParentFrame class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxDocMDIParentFrame
  11     @wxheader{docmdi.h}
  12
  13     The wxDocMDIParentFrame class provides a default top-level frame for
  14     applications using the document/view framework. This class can only be used for
  15     MDI parent frames.
  16
  17     It cooperates with the wxView, wxDocument,
  18     wxDocManager and wxDocTemplates classes.
  19
  20     See the example application in @c samples/docview.
  21
  22     @library{wxcore}
  23     @category{FIXME}
  24
  25     @seealso
  26     @ref overview_docviewoverview "Document/view overview", wxMDIParentFrame
  27 */
  28 class wxDocMDIParentFrame : public wxMDIParentFrame
  29 {
  30 public:
  31     //@{
  32     /**
  33         Constructor.
  34     */
  35     wxDocMDIParentFrame();
  36     wxDocMDIParentFrame(wxDocManager* manager, wxFrame * parent,
  37                         wxWindowID id,
  38                         const wxString& title,
  39                         const wxPoint& pos = wxDefaultPosition,
  40                         const wxSize& size = wxDefaultSize,
  41                         long style = wxDEFAULT_FRAME_STYLE,
  42                         const wxString& name = "frame");
  43     //@}
  44
  45     /**
  46         Destructor.
  47     */
  48     ~wxDocMDIParentFrame();
  49
  50     /**
  51         Creates the window.
  52     */
  53     bool Create(wxDocManager* manager, wxFrame * parent,
  54                 wxWindowID id, const wxString& title,
  55                 const wxPoint& pos = wxDefaultPosition,
  56                 const wxSize& size = wxDefaultSize,
  57                 long style = wxDEFAULT_FRAME_STYLE,
  58                 const wxString& name = "frame");
  59
  60     /**
  61         Deletes all views and documents. If no user input cancelled the
  62         operation, the frame will be destroyed and the application will exit.
  63
  64         Since understanding how document/view clean-up takes place can be difficult,
  65         the implementation of this function is shown below.
  66     */
  67     void OnCloseWindow(wxCloseEvent& event);
  68 };
  69
  70
  71 /**
  72     @class wxDocMDIChildFrame
  73     @wxheader{docmdi.h}
  74
  75     The wxDocMDIChildFrame class provides a default frame for displaying documents
  76     on separate windows. This class can only be used for MDI child frames.
  77
  78     The class is part of the document/view framework supported by wxWidgets,
  79     and cooperates with the wxView, wxDocument,
  80     wxDocManager and wxDocTemplate classes.
  81
  82     See the example application in @c samples/docview.
  83
  84     @library{wxcore}
  85     @category{FIXME}
  86
  87     @seealso
  88     @ref overview_docviewoverview "Document/view overview", wxMDIChildFrame
  89 */
  90 class wxDocMDIChildFrame : public wxMDIChildFrame
  91 {
  92 public:
  93     /**
  94         Constructor.
  95     */
  96     wxDocMDIChildFrame(wxDocument* doc, wxView* view,
  97                        wxFrame* parent,
  98                        wxWindowID id,
  99                        const wxString& title,
 100                        const wxPoint& pos = wxDefaultPosition,
 101                        const wxSize& size = wxDefaultSize,
 102                        long style = wxDEFAULT_FRAME_STYLE,
 103                        const wxString& name = "frame");
 104
 105     /**
 106         Destructor.
 107     */
 108     ~wxDocMDIChildFrame();
 109
 110     /**
 111         Returns the document associated with this frame.
 112     */
 113     wxDocument* GetDocument();
 114
 115     /**
 116         Returns the view associated with this frame.
 117     */
 118     wxView* GetView();
 119
 120     /**
 121         Sets the currently active view to be the frame's view. You may need
 122         to override (but still call) this function in order to set the keyboard
 123         focus for your subwindow.
 124     */
 125     void OnActivate(wxActivateEvent event);
 126
 127     /**
 128         Closes and deletes the current view and document.
 129     */
 130     void OnCloseWindow(wxCloseEvent& event);
 131
 132     /**
 133         Sets the document for this frame.
 134     */
 135     void SetDocument(wxDocument * doc);
 136
 137     /**
 138         Sets the view for this frame.
 139     */
 140     void SetView(wxView * view);
 141
 142     /**
 143         wxDocument* m_childDocument
 144
 145         The document associated with the frame.
 146     */
 147
 148
 149     /**
 150         wxView* m_childView
 151
 152         The view associated with the frame.
 153     */
 154 };