synchronize GTK2 minimum version in docs

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

diff --git a/interface/wx/frame.h b/interface/wx/frame.h
index 740f0578590b3c7b65fe542916ae3ee064fbcfda..9fda5c534ee976342eeab0c359cd2178ea5a3472 100644 (file)
--- a/interface/wx/frame.h
+++ b/interface/wx/frame.h
@@ -3,9 +3,17 @@
 // 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

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+   Frame specific styles
+*/
+#define wxFRAME_NO_TASKBAR      0x0002  // No taskbar button (MSW only)
+#define wxFRAME_TOOL_WINDOW     0x0004  // No taskbar button, no system menu
+#define wxFRAME_FLOAT_ON_PARENT 0x0008  // Always above its parent
+
+

 /**
     @class wxFrame
 
 /**
     @class wxFrame
 


@@ -24,14 +32,14 @@
              data and subwindows can be cleaned up.
 
 
              data and subwindows can be cleaned up.
 
 

-    @section wxframe_defaultevent Default event processing
+    @section frame_defaultevent Default event processing

 
     wxFrame processes the following events:
 
     @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
 
     wxFrame processes the following events:
 
     @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.
 


@@ -43,48 +51,58 @@
     @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}
     @style{wxRESIZE_BORDER}

-           Displays a resizeable border around the window.
+           Displays a resizable border around the window.

     @style{wxFRAME_TOOL_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
 

-    The default frame style is for normal, resizeable frames.
-    To create a frame which can not be resized by user, you may use the following
+    The default frame style is for normal, resizable frames.
+    To create a frame which cannot be resized by user, you may use the following

     combination of styles:
 
     @code
     combination of styles:
 
     @code

-        wxDEFAULT_FRAME_STYLE & ~(wxRESIZE_BORDER | wxRESIZE_BOX | wxMAXIMIZE_BOX)
+        wxDEFAULT_FRAME_STYLE & ~(wxRESIZE_BORDER | wxMAXIMIZE_BOX)

     @endcode
 
     See also the @ref overview_windowstyles.
     @endcode
 
     See also the @ref overview_windowstyles.


@@ -93,7 +111,7 @@
     @style{wxFRAME_EX_CONTEXTHELP}
            Under Windows, puts a query button on the caption. When pressed,
            Windows will go into a context-sensitive help mode and wxWidgets
     @style{wxFRAME_EX_CONTEXTHELP}
            Under Windows, puts a query button on the caption. When pressed,
            Windows will go into a context-sensitive help mode and wxWidgets

-           will send a wxEVT_HELP event if the user clicked on an application
+           will send a @c wxEVT_HELP event if the user clicked on an application

            window. Note that this is an extended style and must be set by
            calling SetExtraStyle before Create is called (two-step
            construction). You cannot use this style together with
            window. Note that this is an extended style and must be set by
            calling SetExtraStyle before Create is called (two-step
            construction). You cannot use this style together with


@@ -106,6 +124,27 @@
            look. This is an extra style.
     @endExtraStyleTable
 
            look. This is an extra style.
     @endExtraStyleTable
 

+    @beginEventEmissionTable
+    @event{EVT_CLOSE(func)}
+        Process a @c wxEVT_CLOSE_WINDOW event when 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}
 


@@ -114,7 +153,11 @@
 class wxFrame : public wxTopLevelWindow
 {
 public:
 class wxFrame : public wxTopLevelWindow
 {
 public:

-    //@{
+    /**
+        Default constructor.
+    */
+    wxFrame();
+

     /**
         Constructor, creating the window.
 
     /**
         Constructor, creating the window.
 


@@ -122,44 +165,40 @@ public:
             The window parent. This may be @NULL. If it is non-@NULL, the frame will
             always be displayed on top of the parent window on Windows.
         @param id
             The window parent. This may be @NULL. If it is non-@NULL, the frame will
             always be displayed on top of the parent window on Windows.
         @param id

-            The window identifier. It may take a value of -1 to indicate a default
-        value.
+            The window identifier. It may take a value of -1 to indicate a default value.

         @param title
             The caption to be displayed on the frame's title bar.
         @param pos
             The window position. The value wxDefaultPosition indicates a default position,
         @param title
             The caption to be displayed on the frame's title bar.
         @param pos
             The window position. The value wxDefaultPosition indicates a default position,

-        chosen by
-            either the windowing system or wxWidgets, depending on platform.
+            chosen by either the windowing system or wxWidgets, depending on platform.

         @param size
             The window size. The value wxDefaultSize indicates a default size, chosen by
             either the windowing system or wxWidgets, depending on platform.
         @param style
         @param size
             The window size. The value wxDefaultSize indicates a default size, chosen by
             either the windowing system or wxWidgets, depending on platform.
         @param style

-            The window style. See wxFrame.
+            The window style. See wxFrame class description.

         @param name
         @param name

-            The name of the window. This parameter is used to associate a name with the
-        item,
-            allowing the application user to set Motif resource values for
+            The name of the window. This parameter is used to associate a name with
+            the item, allowing the application user to set Motif resource values for

             individual windows.
 
         @remarks For Motif, MWM (the Motif Window Manager) should be running for
             individual windows.
 
         @remarks For Motif, MWM (the Motif Window Manager) should be running for

-                 any window styles to work (otherwise all styles take
-                 effect).
+                 any window styles to work (otherwise all styles take effect).

 
         @see Create()
     */
 
         @see Create()
     */

-    wxFrame();

     wxFrame(wxWindow* parent, wxWindowID id,
             const wxString& title,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
             long style = wxDEFAULT_FRAME_STYLE,
     wxFrame(wxWindow* parent, wxWindowID id,
             const wxString& title,
             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.


@@ -170,15 +209,14 @@ public:
     void Centre(int direction = wxBOTH);
 
     /**
     void Centre(int direction = wxBOTH);
 
     /**

-        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.


@@ -187,16 +225,15 @@ public:
             The number of fields to create. Specify a
             value greater than 1 to create a multi-field status bar.
         @param style
             The number of fields to create. Specify a
             value greater than 1 to create a multi-field status bar.
         @param style

-            The status bar style. See wxStatusBar for a list
-            of valid styles.
+            The status bar style. See wxStatusBar for a list of valid styles.

         @param id
         @param id

-            The status bar window identifier. If -1, an identifier will be chosen by
-            wxWidgets.
+            The status bar window identifier. If -1, an identifier will be chosen
+            by wxWidgets.

         @param name
             The status bar window name.
 
         @return A pointer to the status bar if it was created successfully, @NULL
         @param name
             The status bar window name.
 
         @return A pointer to the status bar if it was created successfully, @NULL

-                 otherwise.
+                otherwise.

 
         @remarks The width of the status bar is the whole width of the frame
                  (adjusted automatically when resizing), and the height
 
         @remarks The width of the status bar is the whole width of the frame
                  (adjusted automatically when resizing), and the height


@@ -204,72 +241,77 @@ 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 = wxStatusBarNameStr);

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

-            The toolbar style. See wxToolBar for a list
-            of valid styles.
+            The toolbar style. See wxToolBar for a list of valid styles.

         @param id
         @param id

-            The toolbar window identifier. If -1, an identifier will be chosen by
-            wxWidgets.
+            The toolbar window identifier. If -1, an identifier will be chosen
+            by wxWidgets.

         @param name
             The toolbar window name.
 
         @return A pointer to the toolbar if it was created successfully, @NULL
         @param name
             The toolbar window name.
 
         @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().
-
-        @see CreateStatusBar(), OnCreateToolBar(), SetToolBar(),
-             GetToolBar()
+                otherwise.
+
+        @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,
     */
     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 (if
-        any).
+        Returns a pointer to the status bar currently associated with the frame
+        (if any).

 
         @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().


@@ -326,18 +368,7 @@ public:
         @param id
             The identifier for a menu item.
     */
         @param id
             The identifier for a menu item.
     */

-    void ProcessCommand(int id);
-
-    /**
-        This function sends a dummy @ref overview_wxsizeevent "size event" to the frame
-        forcing it to reevaluate its children positions. It is sometimes useful to call
-        this function after adding or deleting a children after the frame creation or
-        if a child size changes.
-        Note that if the frame is using either sizers or constraints for the children
-        layout, it is enough to call wxWindow::Layout directly and
-        this function should not be used in this case.
-    */
-    void SendSizeEvent();
+    bool ProcessCommand(int id);

 
     /**
         Tells the frame to show the given menu bar.
 
     /**
         Tells the frame to show the given menu bar.


@@ -349,17 +380,24 @@ public:
                  destroyed also, so do not delete the menu bar
                  explicitly (except by resetting the frame's menu bar to
                  another frame or @NULL).
                  destroyed also, so do not delete the menu bar
                  explicitly (except by resetting the frame's menu bar to
                  another frame or @NULL).

+                 Under Windows, a size event is generated, so be sure to
+                 initialize data members properly before calling SetMenuBar().
+                 Note that on some platforms, it is not possible to call this
+                 function twice for the same frame object.

 
         @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.


@@ -387,23 +425,30 @@ 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
             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
-        SetStatusWidths.
+            least one field must be -1. You should delete this array after calling
+            SetStatusWidths().

 
         @remarks The widths of the variable fields are calculated from the total
                  width of all fields, minus the sum of widths of the
 
         @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.
+                 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);
+
+
+    void PushStatusText(const wxString &text, int number = 0);
+    void PopStatusText(int number = 0);
+

 };
 
 };