interface/wx/docmdi.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        docmdi.h
   3 // Purpose:     interface of wxDocMDIParentFrame and wxDocMDIChildFrame
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxDocMDIParentFrame
  11
  12     The wxDocMDIParentFrame class provides a default top-level frame for
  13     applications using the document/view framework. This class can only be used
  14     for MDI parent frames.
  15
  16     It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
  17     classes.
  18
  19     @library{wxcore}
  20     @category{docview}
  21
  22     @see @ref overview_docview, @ref page_samples_docview, wxMDIParentFrame
  23 */
  24 class wxDocMDIParentFrame : public wxMDIParentFrame
  25 {
  26 public:
  27     //@{
  28     /**
  29         Constructor.
  30     */
  31     wxDocMDIParentFrame();
  32     wxDocMDIParentFrame(wxDocManager* manager, wxFrame* parent,
  33                         wxWindowID id,
  34                         const wxString& title,
  35                         const wxPoint& pos = wxDefaultPosition,
  36                         const wxSize& size = wxDefaultSize,
  37                         long style = wxDEFAULT_FRAME_STYLE,
  38                         const wxString& name = wxFrameNameStr);
  39     //@}
  40
  41     /**
  42         Destructor.
  43     */
  44     virtual ~wxDocMDIParentFrame();
  45
  46     /**
  47         Creates the window.
  48     */
  49     bool Create(wxDocManager* manager, wxFrame* parent,
  50                 wxWindowID id, const wxString& title,
  51                 const wxPoint& pos = wxDefaultPosition,
  52                 const wxSize& size = wxDefaultSize,
  53                 long style = wxDEFAULT_FRAME_STYLE,
  54                 const wxString& name = wxFrameNameStr);
  55 };
  56
  57
  58
  59 /**
  60     @class wxDocMDIChildFrame
  61
  62     The wxDocMDIChildFrame class provides a default frame for displaying
  63     documents on separate windows. This class can only be used for MDI child
  64     frames.
  65
  66     The class is part of the document/view framework supported by wxWidgets,
  67     and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
  68     classes.
  69
  70     @library{wxcore}
  71     @category{docview}
  72
  73     @see @ref overview_docview, @ref page_samples_docview, wxMDIChildFrame
  74 */
  75 class wxDocMDIChildFrame : public wxMDIChildFrame
  76 {
  77 public:
  78     /**
  79         Constructor.
  80     */
  81     wxDocMDIChildFrame(wxDocument* doc, wxView* view,
  82                        wxMDIParentFrame* parent, wxWindowID id,
  83                        const wxString& title,
  84                        const wxPoint& pos = wxDefaultPosition,
  85                        const wxSize& size = wxDefaultSize,
  86                        long style = wxDEFAULT_FRAME_STYLE,
  87                        const wxString& name = wxFrameNameStr);
  88
  89     /**
  90         Destructor.
  91     */
  92     virtual ~wxDocMDIChildFrame();
  93
  94     /**
  95         Returns the document associated with this frame.
  96     */
  97     wxDocument* GetDocument() const;
  98
  99     /**
 100         Returns the view associated with this frame.
 101     */
 102     wxView* GetView() const;
 103
 104     /**
 105         Sets the document for this frame.
 106     */
 107     void SetDocument(wxDocument* doc);
 108
 109     /**
 110         Sets the view for this frame.
 111     */
 112     void SetView(wxView* view);
 113 };
 114