Mention graphics classes, separate out image and bitmap classes

[wxWidgets.git] / interface / docmdi.h

diff --git a/interface/docmdi.h b/interface/docmdi.h
index 6858c1f346107a02d31214ae7906e9381c8a84c4..758fba89b64aeb61f5b2e1d27a0b8730e4cf7056 100644 (file)
--- a/interface/docmdi.h
+++ b/interface/docmdi.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        docmdi.h
-// Purpose:     documentation for wxDocMDIParentFrame class
+// Purpose:     interface of wxDocMDIParentFrame and wxDocMDIChildFrame
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,21 +9,18 @@
 /**
     @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.
-    
-    See the example application in @c samples/docview.
-    
+    applications using the document/view framework. This class can only be used
+    for MDI parent frames.
+
+    It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
+    classes.
+
     @library{wxcore}
-    @category{FIXME}
-    
-    @seealso
-    @ref overview_docviewoverview "Document/view overview", wxMDIParentFrame
+    @category{docview}
+
+    @see @ref overview_docview, @ref page_samples_docview, wxMDIParentFrame
 */
 class wxDocMDIParentFrame : public wxMDIParentFrame
 {
@@ -33,13 +30,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 +47,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,32 +57,43 @@ 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.
+
+        Since understanding how document/view clean-up takes place can be
+        difficult, the implementation of this function is shown below:
+
+        @code
+        void wxDocParentFrame::OnCloseWindow(wxCloseEvent& event)
+        {
+            if (m_docManager->Clear(!event.CanVeto()))
+            {
+                this->Destroy();
+            }
+            else
+                event.Veto();
+        }
+        @endcode
     */
     void OnCloseWindow(wxCloseEvent& event);
 };
 
 
+
 /**
     @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 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.
-    
+    and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
+    classes.
+
     @library{wxcore}
-    @category{FIXME}
-    
-    @seealso
-    @ref overview_docviewoverview "Document/view overview", wxMDIChildFrame
+    @category{docview}
+
+    @see @ref overview_docview, @ref page_samples_docview, wxMDIChildFrame
 */
 class wxDocMDIChildFrame : public wxMDIChildFrame
 {
@@ -94,8 +102,7 @@ public:
         Constructor.
     */
     wxDocMDIChildFrame(wxDocument* doc, wxView* view,
-                       wxFrame* parent,
-                       wxWindowID id,
+                       wxFrame* parent, wxWindowID id,
                        const wxString& title,
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,
@@ -110,12 +117,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 +139,11 @@ 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);
-
-    /**
-        wxDocument* m_childDocument
-        
-        The document associated with the frame.
-    */
-
-
-    /**
-        wxView* m_childView
-        
-        The view associated with the frame.
-    */
+    void SetView(wxView* view);
 };
+