Corrected library association

[wxWidgets.git] / interface / wx / mdi.h

diff --git a/interface/wx/mdi.h b/interface/wx/mdi.h
index 6e37b9af788a3f3bcc21e4bbf955c57e6797522d..ff39121e6def2f3bbe37b93d5f0b9ef023152d51 100644 (file)
--- a/interface/wx/mdi.h
+++ b/interface/wx/mdi.h
@@ -8,14 +8,10 @@
 
 /**
     @class wxMDIClientWindow
 
 /**
     @class wxMDIClientWindow

-    @wxheader{mdi.h}

 
     An MDI client window is a child of wxMDIParentFrame, and manages zero or
     more wxMDIChildFrame objects.
 
 
     An MDI client window is a child of wxMDIParentFrame, and manages zero or
     more wxMDIChildFrame objects.
 

-    @library{wxcore}
-    @category{managedwnd}
-

     @remarks
 
     The client window is the area where MDI child windows exist. It doesn't have to
     @remarks
 
     The client window is the area where MDI child windows exist. It doesn't have to


@@ -32,6 +28,9 @@
     Under Windows 95, the client window will automatically have a sunken border style
     when the active child is not maximized, and no border style when a child is maximized.
 
     Under Windows 95, the client window will automatically have a sunken border style
     when the active child is not maximized, and no border style when a child is maximized.
 

+    @library{wxcore}
+    @category{managedwnd}
+

     @see wxMDIChildFrame, wxMDIParentFrame, wxFrame
 */
 class wxMDIClientWindow : public wxWindow
     @see wxMDIChildFrame, wxMDIParentFrame, wxFrame
 */
 class wxMDIClientWindow : public wxWindow


@@ -60,20 +59,19 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxMDIClientWindow();
+    virtual ~wxMDIClientWindow();

 
     /**
         Used in two-step frame construction. See wxMDIClientWindow()
         for further details.
     */
 
     /**
         Used in two-step frame construction. See wxMDIClientWindow()
         for further details.
     */

-    bool CreateClient(wxMDIParentFrame* parent, long style = 0);
+    virtual bool CreateClient(wxMDIParentFrame* parent, long style = 0);

 };
 
 
 
 /**
     @class wxMDIParentFrame
 };
 
 
 
 /**
     @class wxMDIParentFrame

-    @wxheader{mdi.h}

 
     An MDI (Multiple Document Interface) parent frame is a window which can contain
     MDI child frames in its own 'desktop'. It is a convenient way to avoid window
 
     An MDI (Multiple Document Interface) parent frame is a window which can contain
     MDI child frames in its own 'desktop'. It is a convenient way to avoid window


@@ -176,6 +174,9 @@ public:
         @remarks During the construction of the frame, the client window will be
                  created. To use a different class from wxMDIClientWindow, override
                  OnCreateClient().
         @remarks During the construction of the frame, the client window will be
                  created. To use a different class from wxMDIClientWindow, override
                  OnCreateClient().

+                 Under Windows 95, the client window will automatically have a
+                 sunken border style when the active child is not maximized,
+                 and no border style when a child is maximized.

 
         @see Create(), OnCreateClient()
     */
 
         @see Create(), OnCreateClient()
     */


@@ -189,39 +190,39 @@ public:
     /**
         Destructor. Destroys all child windows and menu bar if present.
     */
     /**
         Destructor. Destroys all child windows and menu bar if present.
     */

-    ~wxMDIParentFrame();
+    virtual ~wxMDIParentFrame();

 
     /**
         Activates the MDI child following the currently active one.
 
         @see ActivatePrevious()
     */
 
     /**
         Activates the MDI child following the currently active one.
 
         @see ActivatePrevious()
     */

-    void ActivateNext();
+    virtual void ActivateNext();

 
     /**
         Activates the MDI child preceding the currently active one.
 
         @see ActivateNext()
     */
 
     /**
         Activates the MDI child preceding the currently active one.
 
         @see ActivateNext()
     */

-    void ActivatePrevious();
+    virtual void ActivatePrevious();

 
     /**
         Arranges any iconized (minimized) MDI child windows.
 
         @see Cascade(), Tile()
     */
 
     /**
         Arranges any iconized (minimized) MDI child windows.
 
         @see Cascade(), Tile()
     */

-    void ArrangeIcons();
+    virtual void ArrangeIcons();

 
     /**
         Arranges the MDI child windows in a cascade.
 
         @see Tile(), ArrangeIcons()
     */
 
     /**
         Arranges the MDI child windows in a cascade.
 
         @see Tile(), ArrangeIcons()
     */

-    void Cascade();
+    virtual void Cascade();

 
     /**
 
     /**

-        Used in two-step frame construction. See wxMDIParentFrame()
-        for further details.
+        Used in two-step frame construction.
+        See wxMDIParentFrame() for further details.

     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& title,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& title,


@@ -275,7 +276,7 @@ public:
         width and height.
         @endWxPythonOnly
     */
         width and height.
         @endWxPythonOnly
     */

-    virtual void GetClientSize(int* width, int* height) const;
+    void GetClientSize(int* width, int* height) const;

 
     /**
         Returns a pointer to the client window.
 
     /**
         Returns a pointer to the client window.


@@ -316,7 +317,7 @@ public:
 
         Note that it is probably impossible to have a client window that scrolls
         as well as painting a bitmap or pattern, since in @b OnScroll, the scrollbar
 
         Note that it is probably impossible to have a client window that scrolls
         as well as painting a bitmap or pattern, since in @b OnScroll, the scrollbar

-        positions always return zero. (Solutions to: julian.smart@btopenworld.com).
+        positions always return zero.

 
         @see GetClientWindow(), wxMDIClientWindow
     */
 
         @see GetClientWindow(), wxMDIClientWindow
     */


@@ -353,8 +354,8 @@ public:
     virtual void SetToolBar(wxWindow* toolbar);
 
     /**
     virtual void SetToolBar(wxWindow* toolbar);
 
     /**

-        Call this to change the current Window menu. Ownership of the menu object
-        passes to the frame when you call this function.
+        Call this to change the current Window menu.
+        Ownership of the menu object passes to the frame when you call this function.

 
         This call is available under Windows only.
 
 
         This call is available under Windows only.
 


@@ -368,14 +369,13 @@ public:
 
         Currently only implemented for MSW, does nothing under the other platforms.
     */
 
         Currently only implemented for MSW, does nothing under the other platforms.
     */

-    void Tile(wxOrientation orient = wxHORIZONTAL);
+    virtual void Tile(wxOrientation orient = wxHORIZONTAL);

 };
 
 
 
 /**
     @class wxMDIChildFrame
 };
 
 
 
 /**
     @class wxMDIChildFrame

-    @wxheader{mdi.h}

 
     An MDI child frame is a frame that can only exist on a wxMDIClientWindow,
     which is itself a child of wxMDIParentFrame.
 
     An MDI child frame is a frame that can only exist on a wxMDIClientWindow,
     which is itself a child of wxMDIParentFrame.


@@ -407,6 +407,19 @@ public:
            Displays a thick frame around the window (Windows and Motif only).
     @endStyleTable
 
            Displays a thick frame around the window (Windows and Motif only).
     @endStyleTable
 

+    @remarks
+    Although internally an MDI child frame is a child of the MDI client window,
+    in wxWidgets you create it as a child of wxMDIParentFrame.
+    You can usually forget that the client window exists.
+    MDI child frames are clipped to the area of the MDI client window, and may
+    be iconized on the client window.
+    You can associate a menubar with a child frame as usual, although an MDI
+    child doesn't display its menubar under its own title bar.
+    The MDI parent frame's menubar will be changed to reflect the currently
+    active child frame.
+    If there are currently no children, the parent frame's own menubar will
+    be displayed.
+

     @library{wxcore}
     @category{managedwnd}
 
     @library{wxcore}
     @category{managedwnd}
 


@@ -456,18 +469,18 @@ public:
     /**
         Destructor. Destroys all child windows and menu bar if present.
     */
     /**
         Destructor. Destroys all child windows and menu bar if present.
     */

-    ~wxMDIChildFrame();
+    virtual ~wxMDIChildFrame();

 
     /**
         Activates this MDI child frame.
 
         @see Maximize(), Restore()
     */
 
     /**
         Activates this MDI child frame.
 
         @see Maximize(), Restore()
     */

-    void Activate();
+    virtual void Activate();

 
     /**
 
     /**

-        Used in two-step frame construction. See wxMDIChildFrame()
-        for further details.
+        Used in two-step frame construction.
+        See wxMDIChildFrame() for further details.

     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& title,
     */
     bool Create(wxWindow* parent, wxWindowID id,
                 const wxString& title,


@@ -486,6 +499,6 @@ public:
     /**
         Restores this MDI child frame (unmaximizes).
     */
     /**
         Restores this MDI child frame (unmaximizes).
     */

-    void Restore();
+    virtual void Restore();

 };
 
 };