added wxHeaderCtrl::OnColumnCountChanging()

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

diff --git a/interface/wx/frame.h b/interface/wx/frame.h
index e9c4e1a6aff839dc6dd5ab3d4f7990734f50e4d6..58348fca312a1d64d31df5208824909ebc9b9ce1 100644 (file)
--- a/interface/wx/frame.h
+++ b/interface/wx/frame.h
@@ -31,15 +31,11 @@
     @li @c wxEVT_SIZE: if the frame has exactly one child window, not counting the
         status and toolbar, this child is resized to take the entire frame client area.
         If two or more windows are present, they should be laid out explicitly either
-        by manually handling wxEVT_SIZE or using sizers;
+        by manually handling @c wxEVT_SIZE or using sizers;
     @li @c wxEVT_MENU_HIGHLIGHT: the default implementation displays the help string
         associated with the selected item in the first pane of the status bar, if there is one.
 
 
-    @section frame_styles
-
-    wxFrame supports the following styles:
-
     @beginStyleTable
     @style{wxDEFAULT_FRAME_STYLE}
            Defined as wxMINIMIZE_BOX |  wxMAXIMIZE_BOX |  wxRESIZE_BORDER |
@@ -110,6 +106,15 @@
            look. This is an extra style.
     @endExtraStyleTable
 
+    @beginEventTable{wxCloseEvent}
+    @event{EVT_CLOSE(func)}
+        The frame is being closed by the user or programmatically (see wxWindow::Close).
+        The user may generate this event clicking the close button
+        (typically the 'X' on the top-right of the title bar) if it's present
+        (see the @c wxCLOSE_BOX style).
+    @endEventTable
+
+
     @library{wxcore}
     @category{managedwnd}
 
@@ -156,10 +161,12 @@ public:
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxDEFAULT_FRAME_STYLE,
-            const wxString& name = "frame");
+            const wxString& name = wxFrameNameStr);
 
     /**
         Destructor. Destroys all child windows and menu bar if present.
+
+        See @ref overview_windowdeletion for more info.
     */
     virtual ~wxFrame();
 
@@ -222,19 +229,18 @@ public:
         @return A pointer to the toolbar if it was created successfully, @NULL
                 otherwise.
 
-        @remarks By default, the toolbar is an instance of wxToolBar (which is
-                 defined to be a suitable toolbar class on each
-                 platform, such as wxToolBar95). To use a different
-                 class, override OnCreateToolBar().
-                 When a toolbar has been created with this function, or made
-                 known to the frame with wxFrame::SetToolBar, the frame will
-                 manage the toolbar position and adjust the return value from
-                 wxWindow::GetClientSize to reflect the available space for
-                 application windows.
-                 Under Pocket PC, you should always use this function for creating
-                 the toolbar to be managed by the frame, so that wxWidgets can
-                 use a combined menubar and toolbar.
-                 Where you manage your own toolbars, create a wxToolBar as usual.
+        @remarks
+            By default, the toolbar is an instance of wxToolBar.
+            To use a different class, override OnCreateToolBar().
+            When a toolbar has been created with this function, or made
+            known to the frame with wxFrame::SetToolBar(), the frame will
+            manage the toolbar position and adjust the return value from
+            wxWindow::GetClientSize() to reflect the available space for
+            application windows.
+            Under Pocket PC, you should always use this function for creating
+            the toolbar to be managed by the frame, so that wxWidgets can
+            use a combined menubar and toolbar.
+            Where you manage your own toolbars, create a wxToolBar as usual.
 
         @see CreateStatusBar(), OnCreateToolBar(), SetToolBar(), GetToolBar()
     */
@@ -332,7 +338,7 @@ public:
         @param id
             The identifier for a menu item.
     */
-    void ProcessCommand(int id);
+    bool ProcessCommand(int id);
 
     /**
         Tells the frame to show the given menu bar.
@@ -386,7 +392,7 @@ public:
         @param n
             The number of fields in the status bar. It must be the
             same used in CreateStatusBar.
-        @param widths
+        @param widths_field
             Must contain an array of n integers, each of which is a status field width
             in pixels. A value of -1 indicates that the field is variable width; at
             least one field must be -1. You should delete this array after calling