we need our own imaglist implementation because in wxmac wxIcon does not inherit...

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index 024c6f9bd235093743fe98ac752107a5447c9d71..9caf869e9642a16fc8ccf68c094cac4839ff0235 100644 (file)
--- a/include/wx/frame.h
+++ b/include/wx/frame.h
@@ -5,8 +5,8 @@
 // Modified by:
 // Created:     15.11.99
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     15.11.99
 // RCS-ID:      $Id$

-// Copyright:   (c) wxWindows team
-// Licence:     wxWindows license
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_BASE_
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_FRAME_H_BASE_


@@ -16,22 +16,32 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "framebase.h"
 #endif
 
 #include "wx/toplevel.h"      // the base class
 
 // the default names for various classs
     #pragma interface "framebase.h"
 #endif
 
 #include "wx/toplevel.h"      // the base class
 
 // the default names for various classs

-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
+extern WXDLLEXPORT_DATA(const wxChar*) wxFrameNameStr;
+extern WXDLLEXPORT_DATA(const wxChar*) wxStatusLineNameStr;
+extern WXDLLEXPORT_DATA(const wxChar*) wxToolBarNameStr;

 
 class WXDLLEXPORT wxFrame;
 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxStatusBar;
 class WXDLLEXPORT wxToolBar;
 
 
 class WXDLLEXPORT wxFrame;
 class WXDLLEXPORT wxMenuBar;
 class WXDLLEXPORT wxStatusBar;
 class WXDLLEXPORT wxToolBar;
 

+// ----------------------------------------------------------------------------
+// constants
+// ----------------------------------------------------------------------------
+
+// wxFrame-specific (i.e. not for wxDialog) 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
+#define wxFRAME_SHAPED          0x0010  // Create a window that is able to be shaped
+

 // ----------------------------------------------------------------------------
 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
 //
 // ----------------------------------------------------------------------------
 // wxFrame is a top-level window with optional menubar, statusbar and toolbar
 //


@@ -52,7 +62,7 @@ public:
     virtual ~wxFrameBase();
 
     wxFrame *New(wxWindow *parent,
     virtual ~wxFrameBase();
 
     wxFrame *New(wxWindow *parent,

-                 wxWindowID id,
+                 wxWindowID winid,

                  const wxString& title,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  const wxString& title,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,


@@ -68,10 +78,7 @@ public:
 
     // sends a size event to the window using its current size -- this has an
     // effect of refreshing the window layout
 
     // sends a size event to the window using its current size -- this has an
     // effect of refreshing the window layout

-    //
-    // currently it is only implemented under MSW but is declared here to make
-    // it possible to call it in portable code without using #ifdef's
-    virtual void SendSizeEvent() { }
+    virtual void SendSizeEvent();

 
     // menu bar functions
     // ------------------
 
     // menu bar functions
     // ------------------


@@ -81,33 +88,28 @@ public:
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #endif // wxUSE_MENUS
 
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #endif // wxUSE_MENUS
 

-#ifdef WXWIN_COMPATIBILITY_2_2
-    // call this to simulate a menu command
-    bool Command(int id) { return ProcessCommand(id); }
-#endif // WXWIN_COMPATIBILITY_2_2
-
-    // process menu command: returns TRUE if processed
-    bool ProcessCommand(int id);
+    // process menu command: returns true if processed
+    bool ProcessCommand(int winid);

 
     // status bar functions
     // --------------------
 #if wxUSE_STATUSBAR
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,
 
     // status bar functions
     // --------------------
 #if wxUSE_STATUSBAR
     // create the main status bar by calling OnCreateStatusBar()
     virtual wxStatusBar* CreateStatusBar(int number = 1,

-                                         long style = wxST_SIZEGRIP,
-                                         wxWindowID id = 0,
+                                         long style = wxST_SIZEGRIP|wxFULL_REPAINT_ON_RESIZE,
+                                         wxWindowID winid = 0,

                                          const wxString& name =
                                             wxStatusLineNameStr);
     // return a new status bar
     virtual wxStatusBar *OnCreateStatusBar(int number,
                                            long style,
                                          const wxString& name =
                                             wxStatusLineNameStr);
     // return a new status bar
     virtual wxStatusBar *OnCreateStatusBar(int number,
                                            long style,

-                                           wxWindowID id,
+                                           wxWindowID winid,

                                            const wxString& name);
     // get the main status bar
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 
     // sets the main status bar
                                            const wxString& name);
     // get the main status bar
     virtual wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
 
     // sets the main status bar

-    void SetStatusBar(wxStatusBar *statBar) { m_frameStatusBar = statBar; }
+    virtual void SetStatusBar(wxStatusBar *statBar);

 
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);
 
     // forward these to status bar
     virtual void SetStatusText(const wxString &text, int number = 0);


@@ -122,49 +124,64 @@ public:
 
     // toolbar functions
     // -----------------
 
     // toolbar functions
     // -----------------

+

 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()
 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()

-    virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER|wxTB_HORIZONTAL,
-                                     wxWindowID id = -1,
+    virtual wxToolBar* CreateToolBar(long style = -1,
+                                     wxWindowID winid = wxID_ANY,

                                      const wxString& name = wxToolBarNameStr);
     // return a new toolbar
     virtual wxToolBar *OnCreateToolBar(long style,
                                      const wxString& name = wxToolBarNameStr);
     // return a new toolbar
     virtual wxToolBar *OnCreateToolBar(long style,

-                                       wxWindowID id,
+                                       wxWindowID winid,

                                        const wxString& name );
 
     // get/set the main toolbar
     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }
                                        const wxString& name );
 
     // get/set the main toolbar
     virtual wxToolBar *GetToolBar() const { return m_frameToolBar; }

-    virtual void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
+    virtual void SetToolBar(wxToolBar *toolbar);

 #endif // wxUSE_TOOLBAR
 
     // implementation only from now on
     // -------------------------------
 
     // event handlers
 #endif // wxUSE_TOOLBAR
 
     // implementation only from now on
     // -------------------------------
 
     // event handlers

-    void OnIdle(wxIdleEvent& event);
+#if wxUSE_MENUS
+#if wxUSE_STATUSBAR
+    void OnMenuOpen(wxMenuEvent& event);
+    void OnMenuClose(wxMenuEvent& event);

     void OnMenuHighlight(wxMenuEvent& event);
     void OnMenuHighlight(wxMenuEvent& event);

+#endif // wxUSE_STATUSBAR

 
 

-#if wxUSE_MENUS
-    // send wxUpdateUIEvents for all menu items (called from OnIdle())
-    void DoMenuUpdates();
-    void DoMenuUpdates(wxMenu* menu, wxWindow* focusWin);
+    // send wxUpdateUIEvents for all menu items in the menubar,
+    // or just for menu if non-NULL
+    virtual void DoMenuUpdates(wxMenu* menu = NULL);

 #endif // wxUSE_MENUS
 
 #endif // wxUSE_MENUS
 

+    // do the UI update processing for this window
+    virtual void UpdateWindowUI(long flags = wxUPDATE_UI_NONE);
+
+    // Implement internal behaviour (menu updating on some platforms)
+    virtual void OnInternalIdle();
+

     // if there is no real wxTopLevelWindow on this platform we have to define
     // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
     // old ports (wxMotif) which don't define them in wxFrame
 #ifndef wxTopLevelWindowNative
     virtual bool ShowFullScreen(bool WXUNUSED(show),
                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
     // if there is no real wxTopLevelWindow on this platform we have to define
     // some wxTopLevelWindowBase pure virtual functions here to avoid breaking
     // old ports (wxMotif) which don't define them in wxFrame
 #ifndef wxTopLevelWindowNative
     virtual bool ShowFullScreen(bool WXUNUSED(show),
                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)

-        { return FALSE; }
+        { return false; }

     virtual bool IsFullScreen() const
     virtual bool IsFullScreen() const

-        { return FALSE; }
+        { return false; }

 #endif // no wxTopLevelWindowNative
 
 #endif // no wxTopLevelWindowNative
 

-    // show help text (typically in the statusbar); show is FALSE
-    // if you are hiding the help, TRUE otherwise
+    // show help text (typically in the statusbar); show is false
+    // if you are hiding the help, true otherwise

     virtual void DoGiveHelp(const wxString& text, bool show);
 
     virtual void DoGiveHelp(const wxString& text, bool show);
 

+#if WXWIN_COMPATIBILITY_2_2
+    // call this to simulate a menu command
+    wxDEPRECATED( bool Command(int winid) );
+#endif // WXWIN_COMPATIBILITY_2_2
+

 protected:
     // the frame main menu/status/tool bars
     // ------------------------------------
 protected:
     // the frame main menu/status/tool bars
     // ------------------------------------


@@ -189,6 +206,11 @@ protected:
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     wxMenuBar *m_frameMenuBar;
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     wxMenuBar *m_frameMenuBar;

+
+#if wxUSE_STATUSBAR
+    // the saved status bar text overwritten by DoGiveHelp()
+    wxString m_oldStatusText;
+#endif // wxUSE_STATUSBAR

 #endif // wxUSE_MENUS
 
 #if wxUSE_STATUSBAR
 #endif // wxUSE_MENUS
 
 #if wxUSE_STATUSBAR


@@ -197,8 +219,8 @@ protected:
     virtual void PositionStatusBar() { }
 
     // show the help string for this menu item in the given status bar: the
     virtual void PositionStatusBar() { }
 
     // show the help string for this menu item in the given status bar: the

-    // status bar pointer can be NULL; return TRUE if help was shown
-    bool ShowMenuHelp(wxStatusBar *statbar, int id);
+    // status bar pointer can be NULL; return true if help was shown
+    bool ShowMenuHelp(wxStatusBar *statbar, int helpid);

 
     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR
 
     wxStatusBar *m_frameStatusBar;
 #endif // wxUSE_STATUSBAR


@@ -214,7 +236,10 @@ protected:
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 
     wxToolBar *m_frameToolBar;
 #endif // wxUSE_TOOLBAR
 

+#if wxUSE_MENUS && wxUSE_STATUSBAR

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+#endif // wxUSE_MENUS && wxUSE_STATUSBAR
+

     DECLARE_NO_COPY_CLASS(wxFrameBase)
 };
 
     DECLARE_NO_COPY_CLASS(wxFrameBase)
 };
 


@@ -222,7 +247,9 @@ protected:
 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
     #include "wx/univ/frame.h"
 #else // !__WXUNIVERSAL__
 #if defined(__WXUNIVERSAL__) // && !defined(__WXMICROWIN__)
     #include "wx/univ/frame.h"
 #else // !__WXUNIVERSAL__

-    #if defined(__WXMSW__)
+    #if defined(__WXPALMOS__)
+        #include "wx/palmos/frame.h"
+    #elif defined(__WXMSW__)

         #include "wx/msw/frame.h"
     #elif defined(__WXGTK__)
         #include "wx/gtk/frame.h"
         #include "wx/msw/frame.h"
     #elif defined(__WXGTK__)
         #include "wx/gtk/frame.h"


@@ -230,6 +257,8 @@ protected:
         #include "wx/motif/frame.h"
     #elif defined(__WXMAC__)
         #include "wx/mac/frame.h"
         #include "wx/motif/frame.h"
     #elif defined(__WXMAC__)
         #include "wx/mac/frame.h"

+    #elif defined(__WXCOCOA__)
+        #include "wx/cocoa/frame.h"

     #elif defined(__WXPM__)
         #include "wx/os2/frame.h"
     #endif
     #elif defined(__WXPM__)
         #include "wx/os2/frame.h"
     #endif