Correct wxID_SEPARATOR description in menu documentation.

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

diff --git a/interface/wx/frame.h b/interface/wx/frame.h
index cf016028d8ae7efc2c4be4b25cbfecbcd7c325c1..a8bcda572abf50ec5e3d200ad41c2dfcc052019c 100644 (file)
--- a/interface/wx/frame.h
+++ b/interface/wx/frame.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxFrame
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxFrame
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -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
     @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.
 
 
     @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 |
     @beginStyleTable
     @style{wxDEFAULT_FRAME_STYLE}
            Defined as wxMINIMIZE_BOX |  wxMAXIMIZE_BOX |  wxRESIZE_BORDER |


@@ -47,39 +43,49 @@
     @style{wxICONIZE}
            Display the frame iconized (minimized). Windows only.
     @style{wxCAPTION}
     @style{wxICONIZE}
            Display the frame iconized (minimized). Windows only.
     @style{wxCAPTION}

-           Puts a caption on the frame.
+           Puts a caption on the frame. Notice that this flag is required by
+           wxMINIMIZE_BOX, wxMAXIMIZE_BOX and wxCLOSE_BOX on most systems as
+           the corresponding buttons cannot be shown if the window has no title
+           bar at all. I.e. if wxCAPTION is not specified those styles would be
+           simply ignored.

     @style{wxMINIMIZE}
            Identical to wxICONIZE. Windows only.
     @style{wxMINIMIZE_BOX}
            Displays a minimize box on the frame.
     @style{wxMAXIMIZE}
     @style{wxMINIMIZE}
            Identical to wxICONIZE. Windows only.
     @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}
     @style{wxMAXIMIZE_BOX}

-           Displays a maximize box on the frame.
+           Displays a maximize box on the frame. Notice that under wxGTK
+           wxRESIZE_BORDER must be used as well or this style is ignored.

     @style{wxCLOSE_BOX}
            Displays a close box on the frame.
     @style{wxSTAY_ON_TOP}
            Stay on top of all other windows, see also wxFRAME_FLOAT_ON_PARENT.
     @style{wxSYSTEM_MENU}
     @style{wxCLOSE_BOX}
            Displays a close box on the frame.
     @style{wxSTAY_ON_TOP}
            Stay on top of all other windows, see also wxFRAME_FLOAT_ON_PARENT.
     @style{wxSYSTEM_MENU}

-           Displays a system menu.
+           Displays a system menu containing the list of various windows
+           commands in the window title bar. Unlike wxMINIMIZE_BOX,
+           wxMAXIMIZE_BOX and wxCLOSE_BOX styles this style can be used without
+           wxCAPTION, at least under Windows, and makes the system menu
+           available without showing it on screen in this case. However it is
+           recommended to only use it together with wxCAPTION for consistent
+           behaviour under all platforms.

     @style{wxRESIZE_BORDER}
            Displays a resizeable border around the window.
     @style{wxFRAME_TOOL_WINDOW}
     @style{wxRESIZE_BORDER}
            Displays a resizeable border around the window.
     @style{wxFRAME_TOOL_WINDOW}

-           Causes a frame with a small titlebar to be created; the frame does
+           Causes a frame with a small title bar to be created; the frame does

            not appear in the taskbar under Windows or GTK+.
     @style{wxFRAME_NO_TASKBAR}
            Creates an otherwise normal frame but it does not appear in the
            taskbar under Windows or GTK+ (note that it will minimize to the
            desktop window under Windows which may seem strange to the users
            and thus it might be better to use this style only without
            not appear in the taskbar under Windows or GTK+.
     @style{wxFRAME_NO_TASKBAR}
            Creates an otherwise normal frame but it does not appear in the
            taskbar under Windows or GTK+ (note that it will minimize to the
            desktop window under Windows which may seem strange to the users
            and thus it might be better to use this style only without

-           wxMINIMIZE_BOX style). In wxGTK, the flag is respected only if GTK+
-           is at least version 2.2 and the window manager supports
-           _NET_WM_STATE_SKIP_TASKBAR hint. Has no effect under other platforms.
+           wxMINIMIZE_BOX style). In wxGTK, the flag is respected only if the
+           window manager supports _NET_WM_STATE_SKIP_TASKBAR hint.

     @style{wxFRAME_FLOAT_ON_PARENT}
            The frame will always be on top of its parent (unlike wxSTAY_ON_TOP).
            A frame created with this style must have a non-@NULL parent.
     @style{wxFRAME_SHAPED}
     @style{wxFRAME_FLOAT_ON_PARENT}
            The frame will always be on top of its parent (unlike wxSTAY_ON_TOP).
            A frame created with this style must have a non-@NULL parent.
     @style{wxFRAME_SHAPED}

-           Windows with this style are   allowed to have their shape changed
+           Windows with this style are allowed to have their shape changed

            with the SetShape() method.
     @endStyleTable
 
            with the SetShape() method.
     @endStyleTable
 


@@ -110,6 +116,26 @@
            look. This is an extra style.
     @endExtraStyleTable
 
            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}
 
     @library{wxcore}
     @category{managedwnd}
 


@@ -156,12 +182,14 @@ public:
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxDEFAULT_FRAME_STYLE,
             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.
 
     /**
         Destructor. Destroys all child windows and menu bar if present.

+
+        See @ref overview_windowdeletion for more info.

     */
     */

-    ~wxFrame();
+    virtual ~wxFrame();

 
     /**
         Centres the frame on the display.
 
     /**
         Centres the frame on the display.


@@ -175,12 +203,11 @@ public:
         Used in two-step frame construction.
         See wxFrame() for further details.
     */
         Used in two-step frame construction.
         See wxFrame() for further details.
     */

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

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_FRAME_STYLE,

-                const wxString& name = "frame");
+                const wxString& name = wxFrameNameStr);

 
     /**
         Creates a status bar at the bottom of the frame.
 
     /**
         Creates a status bar at the bottom of the frame.


@@ -205,10 +232,9 @@ public:
 
         @see SetStatusText(), OnCreateStatusBar(), GetStatusBar()
     */
 
         @see SetStatusText(), OnCreateStatusBar(), GetStatusBar()
     */

-    virtual wxStatusBar* CreateStatusBar(int number = 1,
-                                         long style = 0,
-                                         wxWindowID id = -1,
-                                         const wxString& name = "statusBar");
+    virtual wxStatusBar* CreateStatusBar(int number = 1, long style = wxSTB_DEFAULT_STYLE,
+                                         wxWindowID id = 0,
+                                         const wxString& name = wxStatusLineNameStr);

 
     /**
         Creates a toolbar at the top or left of the frame.
 
     /**
         Creates a toolbar at the top or left of the frame.


@@ -224,38 +250,37 @@ public:
         @return A pointer to the toolbar if it was created successfully, @NULL
                 otherwise.
 
         @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()
     */
     virtual wxToolBar* CreateToolBar(long style = wxBORDER_NONE | wxTB_HORIZONTAL,
 
         @see CreateStatusBar(), OnCreateToolBar(), SetToolBar(), GetToolBar()
     */
     virtual wxToolBar* CreateToolBar(long style = wxBORDER_NONE | wxTB_HORIZONTAL,

-                                     wxWindowID id = -1,
-                                     const wxString& name = "toolBar");
+                                     wxWindowID id = wxID_ANY,
+                                     const wxString& name = wxToolBarNameStr);

 
     /**
         Returns the origin of the frame client area (in client coordinates).
         It may be different from (0, 0) if the frame has a toolbar.
     */
 
     /**
         Returns the origin of the frame client area (in client coordinates).
         It may be different from (0, 0) if the frame has a toolbar.
     */

-    wxPoint GetClientAreaOrigin() const;
+    virtual wxPoint GetClientAreaOrigin() const;

 
     /**
         Returns a pointer to the menubar currently associated with the frame (if any).
 
         @see SetMenuBar(), wxMenuBar, wxMenu
     */
 
     /**
         Returns a pointer to the menubar currently associated with the frame (if any).
 
         @see SetMenuBar(), wxMenuBar, wxMenu
     */

-    wxMenuBar* GetMenuBar() const;
+    virtual wxMenuBar* GetMenuBar() const;

 
     /**
         Returns a pointer to the status bar currently associated with the frame
 
     /**
         Returns a pointer to the status bar currently associated with the frame


@@ -263,21 +288,21 @@ public:
 
         @see CreateStatusBar(), wxStatusBar
     */
 
         @see CreateStatusBar(), wxStatusBar
     */

-    wxStatusBar* GetStatusBar() const;
+    virtual wxStatusBar* GetStatusBar() const;

 
     /**
         Returns the status bar pane used to display menu and toolbar help.
 
         @see SetStatusBarPane()
     */
 
     /**
         Returns the status bar pane used to display menu and toolbar help.
 
         @see SetStatusBarPane()
     */

-    int GetStatusBarPane();
+    int GetStatusBarPane() const;

 
     /**
         Returns a pointer to the toolbar currently associated with the frame (if any).
 
         @see CreateToolBar(), wxToolBar, SetToolBar()
     */
 
     /**
         Returns a pointer to the toolbar currently associated with the frame (if any).
 
         @see CreateToolBar(), wxToolBar, SetToolBar()
     */

-    wxToolBar* GetToolBar() const;
+    virtual wxToolBar* GetToolBar() const;

 
     /**
         Virtual function called when a status bar is requested by CreateStatusBar().
 
     /**
         Virtual function called when a status bar is requested by CreateStatusBar().


@@ -334,7 +359,7 @@ public:
         @param id
             The identifier for a menu item.
     */
         @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.
 
     /**
         Tells the frame to show the given menu bar.


@@ -353,14 +378,17 @@ public:
 
         @see GetMenuBar(), wxMenuBar, wxMenu.
     */
 
         @see GetMenuBar(), wxMenuBar, wxMenu.
     */

-    void SetMenuBar(wxMenuBar* menuBar);
+    virtual void SetMenuBar(wxMenuBar* menuBar);

 
     /**
         Associates a status bar with the frame.
 
 
     /**
         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()
     */
         @see CreateStatusBar(), wxStatusBar, GetStatusBar()
     */

-    void SetStatusBar(wxStatusBar* statusBar);
+    virtual void SetStatusBar(wxStatusBar* statusBar);

 
     /**
         Set the status bar pane used to display menu and toolbar help.
 
     /**
         Set the status bar pane used to display menu and toolbar help.


@@ -388,7 +416,7 @@ public:
         @param n
             The number of fields in the status bar. It must be the
             same used in CreateStatusBar.
         @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
             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


@@ -397,12 +425,16 @@ 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.
         @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, int* widths);
+    virtual void SetStatusWidths(int n, const int* widths_field);

 
     /**
         Associates a toolbar with the frame.
     */
 
     /**
         Associates a toolbar with the frame.
     */

-    void SetToolBar(wxToolBar* toolBar);
+    virtual void SetToolBar(wxToolBar* toolBar);

 };
 
 };