X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..658d98040dc6c7146c9c1ef651c7e5c0ebe83ec7:/interface/docmdi.h diff --git a/interface/docmdi.h b/interface/docmdi.h index 6858c1f346..fd31790829 100644 --- a/interface/docmdi.h +++ b/interface/docmdi.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: docmdi.h -// Purpose: documentation for wxDocMDIParentFrame class +// Purpose: interface of wxDocMDIParentFrame // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,21 +9,20 @@ /** @class wxDocMDIParentFrame @wxheader{docmdi.h} - + The wxDocMDIParentFrame class provides a default top-level frame for applications using the document/view framework. This class can only be used for MDI parent frames. - + It cooperates with the wxView, wxDocument, - wxDocManager and wxDocTemplates classes. - + wxDocManager and wxDocTemplates() classes. + See the example application in @c samples/docview. - + @library{wxcore} @category{FIXME} - - @seealso - @ref overview_docviewoverview "Document/view overview", wxMDIParentFrame + + @see @ref overview_docviewoverview, wxMDIParentFrame */ class wxDocMDIParentFrame : public wxMDIParentFrame { @@ -33,13 +32,13 @@ public: Constructor. */ wxDocMDIParentFrame(); - wxDocMDIParentFrame(wxDocManager* manager, wxFrame * parent, - wxWindowID id, - const wxString& title, - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - long style = wxDEFAULT_FRAME_STYLE, - const wxString& name = "frame"); + wxDocMDIParentFrame(wxDocManager* manager, wxFrame* parent, + wxWindowID id, + const wxString& title, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + long style = wxDEFAULT_FRAME_STYLE, + const wxString& name = "frame"); //@} /** @@ -50,7 +49,7 @@ public: /** Creates the window. */ - bool Create(wxDocManager* manager, wxFrame * parent, + bool Create(wxDocManager* manager, wxFrame* parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, @@ -60,7 +59,6 @@ public: /** Deletes all views and documents. If no user input cancelled the operation, the frame will be destroyed and the application will exit. - Since understanding how document/view clean-up takes place can be difficult, the implementation of this function is shown below. */ @@ -68,24 +66,24 @@ public: }; + /** @class wxDocMDIChildFrame @wxheader{docmdi.h} - + The wxDocMDIChildFrame class provides a default frame for displaying documents on separate windows. This class can only be used for MDI child frames. - + The class is part of the document/view framework supported by wxWidgets, and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate classes. - + See the example application in @c samples/docview. - + @library{wxcore} @category{FIXME} - - @seealso - @ref overview_docviewoverview "Document/view overview", wxMDIChildFrame + + @see @ref overview_docviewoverview, wxMDIChildFrame */ class wxDocMDIChildFrame : public wxMDIChildFrame { @@ -110,12 +108,12 @@ public: /** Returns the document associated with this frame. */ - wxDocument* GetDocument(); + wxDocument* GetDocument() const; /** Returns the view associated with this frame. */ - wxView* GetView(); + wxView* GetView() const; /** Sets the currently active view to be the frame's view. You may need @@ -132,23 +130,22 @@ public: /** Sets the document for this frame. */ - void SetDocument(wxDocument * doc); + void SetDocument(wxDocument* doc); /** Sets the view for this frame. */ - void SetView(wxView * view); + void SetView(wxView* view); /** wxDocument* m_childDocument - The document associated with the frame. */ /** wxView* m_childView - The view associated with the frame. */ }; +