fixing wrong version commit

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

diff --git a/interface/wx/frame.h b/interface/wx/frame.h
index 92a9479fc4397950838881a88fab72e42dc941a3..2e88233fd5e4ed6a7b2319de49a3e5b33fb3c952 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 |
@@ -53,7 +49,7 @@
     @style{wxMINIMIZE_BOX}
            Displays a minimize box on the frame.
     @style{wxMAXIMIZE}
-           Displays the frame maximized. Windows only.
+           Displays the frame maximized. Windows and GTK+ only.
     @style{wxMAXIMIZE_BOX}
            Displays a maximize box on the frame.
     @style{wxCLOSE_BOX}
@@ -110,6 +106,26 @@
            look. This is an extra style.
     @endExtraStyleTable
 
+    @beginEventEmissionTable
+    @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). See wxCloseEvent.
+    @event{EVT_ICONIZE(func)}
+        Process a @c wxEVT_ICONIZE event. See wxIconizeEvent.
+    @event{EVT_MENU_OPEN(func)}
+        A menu is about to be opened. See wxMenuEvent.
+    @event{EVT_MENU_CLOSE(func)}
+        A menu has been just closed. See wxMenuEvent.
+    @event{EVT_MENU_HIGHLIGHT(id, func)}
+        The menu item with the specified id has been highlighted: used to show
+        help prompts in the status bar by wxFrame. See wxMenuEvent.
+    @event{EVT_MENU_HIGHLIGHT_ALL(func)}
+        A menu item has been highlighted, i.e. the currently selected menu item has changed.
+        See wxMenuEvent.
+    @endEventTable
+
     @library{wxcore}
     @category{managedwnd}
 
@@ -160,6 +176,8 @@ public:
 
     /**
         Destructor. Destroys all child windows and menu bar if present.
+
+        See @ref overview_windowdeletion for more info.
     */
     virtual ~wxFrame();
 
@@ -204,7 +222,7 @@ public:
 
         @see SetStatusText(), OnCreateStatusBar(), GetStatusBar()
     */
-    virtual wxStatusBar* CreateStatusBar(int number = 1, long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+    virtual wxStatusBar* CreateStatusBar(int number = 1, long style = wxSTB_DEFAULT_STYLE,
                                          wxWindowID id = 0,
                                          const wxString& name = wxStatusLineNameStr);
 
@@ -355,6 +373,9 @@ public:
     /**
         Associates a status bar with the frame.
 
+        If @a statusBar is @NULL, then the status bar, if present, is detached from
+        the frame, but @e not deleted.
+
         @see CreateStatusBar(), wxStatusBar, GetStatusBar()
     */
     virtual void SetStatusBar(wxStatusBar* statusBar);
@@ -394,6 +415,10 @@ public:
         @remarks The widths of the variable fields are calculated from the total
                  width of all fields, minus the sum of widths of the
                  non-variable fields, divided by the number of variable fields.
+
+        @beginWxPerlOnly
+        In wxPerl this method takes the field widths as parameters.
+        @endWxPerlOnly
     */
     virtual void SetStatusWidths(int n, const int* widths_field);