added macros to avoid code repetition when defining comparison operators; use them...

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

diff --git a/include/wx/frame.h b/include/wx/frame.h
index ee270269f75ea4f4c35816b452ff69f0497ed870..8c599ae4352de461b09655c7448a54e5159e3455 100644 (file)
--- a/include/wx/frame.h
+++ b/include/wx/frame.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     15.11.99
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWindows team
+// Copyright:   (c) wxWidgets team
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
@@ -16,22 +16,27 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#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
-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
-WXDLLEXPORT_DATA(extern const wxChar*) wxToolBarNameStr;
+extern WXDLLEXPORT_DATA(const wxChar) wxStatusLineNameStr[];
+extern WXDLLEXPORT_DATA(const wxChar) wxToolBarNameStr[];
 
 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
 //
@@ -68,10 +73,7 @@ public:
 
     // 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
     // ------------------
@@ -81,7 +83,7 @@ public:
     virtual wxMenuBar *GetMenuBar() const { return m_frameMenuBar; }
 #endif // wxUSE_MENUS
 
-    // process menu command: returns TRUE if processed
+    // process menu command: returns true if processed
     bool ProcessCommand(int winid);
 
     // status bar functions
@@ -102,7 +104,7 @@ public:
     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);
@@ -121,7 +123,7 @@ public:
 #if wxUSE_TOOLBAR
     // create main toolbar bycalling OnCreateToolBar()
     virtual wxToolBar* CreateToolBar(long style = -1,
-                                     wxWindowID winid = -1,
+                                     wxWindowID winid = wxID_ANY,
                                      const wxString& name = wxToolBarNameStr);
     // return a new toolbar
     virtual wxToolBar *OnCreateToolBar(long style,
@@ -130,7 +132,7 @@ public:
 
     // 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
@@ -146,7 +148,7 @@ public:
 
     // send wxUpdateUIEvents for all menu items in the menubar,
     // or just for menu if non-NULL
-    void DoMenuUpdates(wxMenu* menu = NULL);
+    virtual void DoMenuUpdates(wxMenu* menu = NULL);
 #endif // wxUSE_MENUS
 
     // do the UI update processing for this window
@@ -161,19 +163,16 @@ public:
 #ifndef wxTopLevelWindowNative
     virtual bool ShowFullScreen(bool WXUNUSED(show),
                                 long WXUNUSED(style) = wxFULLSCREEN_ALL)
-        { return FALSE; }
+        { return false; }
     virtual bool IsFullScreen() const
-        { return FALSE; }
+        { return false; }
 #endif // no wxTopLevelWindowNative
 
-    // show help text (typically in the statusbar); show is FALSE
-    // if you are hiding the help, TRUE otherwise
+#if wxUSE_MENUS || wxUSE_TOOLBAR
+    // 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);
-
-#if WXWIN_COMPATIBILITY_2_2
-    // call this to simulate a menu command
-    bool Command(int winid) { return ProcessCommand(winid); }
-#endif // WXWIN_COMPATIBILITY_2_2
+#endif
 
 protected:
     // the frame main menu/status/tool bars
@@ -199,12 +198,12 @@ protected:
     virtual void AttachMenuBar(wxMenuBar *menubar);
 
     wxMenuBar *m_frameMenuBar;
+#endif // wxUSE_MENUS
 
-#if wxUSE_STATUSBAR
+#if wxUSE_STATUSBAR && (wxUSE_MENUS || wxUSE_TOOLBAR)
     // the saved status bar text overwritten by DoGiveHelp()
     wxString m_oldStatusText;
-#endif // wxUSE_STATUSBAR
-#endif // wxUSE_MENUS
+#endif
 
 #if wxUSE_STATUSBAR
     // override to update status bar position (or anything else) when
@@ -212,7 +211,7 @@ protected:
     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
+    // status bar pointer can be NULL; return true if help was shown
     bool ShowMenuHelp(wxStatusBar *statbar, int helpid);
 
     wxStatusBar *m_frameStatusBar;
@@ -240,10 +239,14 @@ protected:
 #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__)
+    #elif defined(__WXGTK20__)
         #include "wx/gtk/frame.h"
+    #elif defined(__WXGTK__)
+        #include "wx/gtk1/frame.h"
     #elif defined(__WXMOTIF__)
         #include "wx/motif/frame.h"
     #elif defined(__WXMAC__)