Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 16:22:58 +00:00
parent 92b6654b66
commit ae3c17b401
277 changed files with 0 additions and 0 deletions
--- a/interface/wx/docmdi.h
+++ b/interface/wx/docmdi.h
@@ -0,0 +1,149 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        docmdi.h
+// Purpose:     interface of wxDocMDIParentFrame and wxDocMDIChildFrame
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @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 wxDocTemplate
+    classes.
+
+    @library{wxcore}
+    @category{docview}
+
+    @see @ref overview_docview, @ref page_samples_docview, wxMDIParentFrame
+*/
+class wxDocMDIParentFrame : public wxMDIParentFrame
+{
+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");
+    //@}
+
+    /**
+        Destructor.
+    */
+    ~wxDocMDIParentFrame();
+
+    /**
+        Creates the window.
+    */
+    bool Create(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");
+
+    /**
+        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:
+
+        @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 class is part of the document/view framework supported by wxWidgets,
+    and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
+    classes.
+
+    @library{wxcore}
+    @category{docview}
+
+    @see @ref overview_docview, @ref page_samples_docview, wxMDIChildFrame
+*/
+class wxDocMDIChildFrame : public wxMDIChildFrame
+{
+public:
+    /**
+        Constructor.
+    */
+    wxDocMDIChildFrame(wxDocument* doc, wxView* view,
+                       wxFrame* parent, wxWindowID id,
+                       const wxString& title,
+                       const wxPoint& pos = wxDefaultPosition,
+                       const wxSize& size = wxDefaultSize,
+                       long style = wxDEFAULT_FRAME_STYLE,
+                       const wxString& name = "frame");
+
+    /**
+        Destructor.
+    */
+    ~wxDocMDIChildFrame();
+
+    /**
+        Returns the document associated with this frame.
+    */
+    wxDocument* GetDocument() const;
+
+    /**
+        Returns the view associated with this frame.
+    */
+    wxView* GetView() const;
+
+    /**
+        Sets the currently active view to be the frame's view. You may need
+        to override (but still call) this function in order to set the keyboard
+        focus for your subwindow.
+    */
+    void OnActivate(wxActivateEvent event);
+
+    /**
+        Closes and deletes the current view and document.
+    */
+    void OnCloseWindow(wxCloseEvent& event);
+
+    /**
+        Sets the document for this frame.
+    */
+    void SetDocument(wxDocument* doc);
+
+    /**
+        Sets the view for this frame.
+    */
+    void SetView(wxView* view);
+};
+