capitalize the application name in GetAppDisplayName() by default; this results in...

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

diff --git a/include/wx/toplevel.h b/include/wx/toplevel.h
index 2a929dfc23be2555a7c226d246d75a996a16e654..2421a6eb23fe10aea28ce63d2541a943d5828ac8 100644 (file)
--- a/include/wx/toplevel.h
+++ b/include/wx/toplevel.h
@@ -7,28 +7,26 @@
 // Created:     06.08.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     06.08.01
 // RCS-ID:      $Id$
 // Copyright:   (c) 2001 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-//                       Vaclav Slavik <vaclav@wxwindows.org>
+//                       Vaclav Slavik <vaclav@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_TOPLEVEL_BASE_H_
 #define _WX_TOPLEVEL_BASE_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "toplevelbase.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 

-#include "wx/window.h"
+#include "wx/nonownedwnd.h"

 #include "wx/iconbndl.h"
 #include "wx/iconbndl.h"

+#include "wx/containr.h"
+#include "wx/weakref.h"

 
 

-// the default names for various classs
-WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
+// the default names for various classes
+extern WXDLLIMPEXP_DATA_CORE(const char) wxFrameNameStr[];

 
 

-class WXDLLEXPORT wxTopLevelWindowBase;
+class WXDLLIMPEXP_FWD_CORE wxTopLevelWindowBase;

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -48,15 +46,19 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 #define wxTINY_CAPTION_VERT     0x0080
 #define wxRESIZE_BORDER         0x0040
 
 #define wxTINY_CAPTION_VERT     0x0080
 #define wxRESIZE_BORDER         0x0040
 

-// deprecated versions defined for compatibility reasons
-#define wxRESIZE_BOX            wxMAXIMIZE_BOX
-#define wxTHICK_FRAME           wxRESIZE_BORDER
+#if WXWIN_COMPATIBILITY_2_6
+
+    // deprecated versions defined for compatibility reasons
+    #define wxRESIZE_BOX            wxMAXIMIZE_BOX
+    #define wxTHICK_FRAME           wxRESIZE_BORDER

 
 

-// obsolete styles, unused any more
-#define wxDIALOG_MODAL          0
-#define wxDIALOG_MODELESS       0
-#define wxNO_3D                 0
-#define wxUSER_COLOURS          0
+    // obsolete styles, unused any more
+    #define wxDIALOG_MODAL          0
+    #define wxDIALOG_MODELESS       0
+    #define wxNO_3D                 0
+    #define wxUSER_COLOURS          0
+
+#endif // WXWIN_COMPATIBILITY_2_6

 
 // default style
 //
 
 // default style
 //


@@ -65,8 +67,14 @@ class WXDLLEXPORT wxTopLevelWindowBase;
 // "correctly", i.e. as full screen windows with a "hide" button (same as
 // "close" but round instead of squared and just hides the applications
 // instead of closing it) in the title bar
 // "correctly", i.e. as full screen windows with a "hide" button (same as
 // "close" but round instead of squared and just hides the applications
 // instead of closing it) in the title bar

-#ifdef __WXWINCE__
-    #define wxDEFAULT_FRAME_STYLE (0)
+#if defined(__WXWINCE__)
+    #if defined(__SMARTPHONE__)
+        #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE)
+    #elif defined(__WINCE_STANDARDSDK__)
+        #define wxDEFAULT_FRAME_STYLE (wxMAXIMIZE|wxCLOSE_BOX)
+    #else
+        #define wxDEFAULT_FRAME_STYLE (wxNO_BORDER)
+    #endif

 #else // !__WXWINCE__
     #define wxDEFAULT_FRAME_STYLE \
             (wxSYSTEM_MENU | \
 #else // !__WXWINCE__
     #define wxDEFAULT_FRAME_STYLE \
             (wxSYSTEM_MENU | \


@@ -98,11 +106,18 @@ enum
                                wxFULLSCREEN_NOCAPTION
 };
 
                                wxFULLSCREEN_NOCAPTION
 };
 

+// Styles for RequestUserAttention
+enum
+{
+    wxUSER_ATTENTION_INFO = 1,
+    wxUSER_ATTENTION_ERROR = 2
+};
+

 // ----------------------------------------------------------------------------
 // wxTopLevelWindow: a top level (as opposed to child) window
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxTopLevelWindow: a top level (as opposed to child) window
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxTopLevelWindowBase : public wxWindow
+class WXDLLIMPEXP_CORE wxTopLevelWindowBase : public wxNonOwnedWindow

 {
 public:
     // construction
 {
 public:
     // construction


@@ -112,63 +127,118 @@ public:
     // top level wnd state
     // --------------------
 
     // top level wnd state
     // --------------------
 

-    // maximize = TRUE => maximize, otherwise - restore
-    virtual void Maximize(bool maximize = TRUE) = 0;
+    // maximize = true => maximize, otherwise - restore
+    virtual void Maximize(bool maximize = true) = 0;

 
     // undo Maximize() or Iconize()
     virtual void Restore() = 0;
 
 
     // undo Maximize() or Iconize()
     virtual void Restore() = 0;
 

-    // iconize = TRUE => iconize, otherwise - restore
-    virtual void Iconize(bool iconize = TRUE) = 0;
+    // iconize = true => iconize, otherwise - restore
+    virtual void Iconize(bool iconize = true) = 0;

 
 

-    // return TRUE if the frame is maximized
+    // return true if the frame is maximized

     virtual bool IsMaximized() const = 0;
 
     virtual bool IsMaximized() const = 0;
 

-    // return TRUE if the frame is iconized
+    // return true if the frame is always maximized
+    // due to native guidelines or current policy
+    virtual bool IsAlwaysMaximized() const;
+
+    // return true if the frame is iconized

     virtual bool IsIconized() const = 0;
 
     // get the frame icon
     virtual bool IsIconized() const = 0;
 
     // get the frame icon

-    const wxIcon& GetIcon() const { return m_icons.GetIcon( -1 ); }
+    wxIcon GetIcon() const;

 
     // get the frame icons
     const wxIconBundle& GetIcons() const { return m_icons; }
 
 
     // get the frame icons
     const wxIconBundle& GetIcons() const { return m_icons; }
 

-    // set the frame icon
-    virtual void SetIcon(const wxIcon& icon) { m_icons = wxIconBundle( icon ); }
+    // set the frame icon: implemented in terms of SetIcons()
+    void SetIcon(const wxIcon& icon);

 
     // set the frame icons
 
     // set the frame icons

-    virtual void SetIcons(const wxIconBundle& icons ) { m_icons = icons; }
+    virtual void SetIcons(const wxIconBundle& icons) { m_icons = icons; }

 
     // maximize the window to cover entire screen
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
 
 
     // maximize the window to cover entire screen
     virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL) = 0;
 

-    // return TRUE if the frame is in fullscreen mode
+    // return true if the frame is in fullscreen mode

     virtual bool IsFullScreen() const = 0;
 
     virtual bool IsFullScreen() const = 0;
 

-    /*
-       for now we already have them in wxWindow, but this is wrong: these
-       methods really only make sense for wxTopLevelWindow!
-
+    // the title of the top level window: the text which the
+    // window shows usually at the top of the frame/dialog in dedicated bar

     virtual void SetTitle(const wxString& title) = 0;
     virtual wxString GetTitle() const = 0;
     virtual void SetTitle(const wxString& title) = 0;
     virtual wxString GetTitle() const = 0;

-     */
+
+    // enable/disable close button [x]
+    virtual bool EnableCloseButton(bool WXUNUSED(enable) ) { return false; } 

 
     // Set the shape of the window to the given region.
 
     // Set the shape of the window to the given region.

-    // Returns TRUE if the platform supports this feature (and the
+    // Returns true if the platform supports this feature (and the

     // operation is successful.)
     // operation is successful.)

-    virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return FALSE; }
+    virtual bool SetShape(const wxRegion& WXUNUSED(region)) { return false; }
+
+    // Attracts the users attention to this window if the application is
+    // inactive (should be called when a background event occurs)
+    virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
+
+    // Is this the active frame (highlighted in the taskbar)?
+    virtual bool IsActive() { return wxGetTopLevelParent(FindFocus()) == this; }
+
+    // this function may be overridden to return false to allow closing the
+    // application even when this top level window is still open
+    //
+    // notice that the window is still closed prior to the application exit and
+    // so it can still veto it even if it returns false from here
+    virtual bool ShouldPreventAppExit() const { return true; }
+
+
+#if defined(__SMARTPHONE__)
+    virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
+    virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL) = 0;
+#endif // __SMARTPHONE__
+
+    // centre the window on screen: this is just a shortcut
+    void CentreOnScreen(int dir = wxBOTH) { DoCentre(dir | wxCENTRE_ON_SCREEN); }
+    void CenterOnScreen(int dir = wxBOTH) { CentreOnScreen(dir); }
+
+
+    // default item access: we have a permanent default item which is the one
+    // set by the user code but we may also have a temporary default item which
+    // would be chosen if the user pressed "Enter" now but the default action
+    // reverts to the "permanent" default as soon as this temporary default
+    // item loses focus
+
+    // get the default item, temporary or permanent
+    wxWindow *GetDefaultItem() const
+        { return m_winTmpDefault ? m_winTmpDefault : m_winDefault; }
+
+    // set the permanent default item, return the old default
+    wxWindow *SetDefaultItem(wxWindow *win)
+        { wxWindow *old = GetDefaultItem(); m_winDefault = win; return old; }
+
+    // return the temporary default item, can be NULL
+    wxWindow *GetTmpDefaultItem() const { return m_winTmpDefault; }
+
+    // set a temporary default item, SetTmpDefaultItem(NULL) should be called
+    // soon after a call to SetTmpDefaultItem(window), return the old default
+    wxWindow *SetTmpDefaultItem(wxWindow *win)
+        { wxWindow *old = GetDefaultItem(); m_winTmpDefault = win; return old; }
+

 
     // implementation only from now on
     // -------------------------------
 
     // override some base class virtuals
     virtual bool Destroy();
 
     // implementation only from now on
     // -------------------------------
 
     // override some base class virtuals
     virtual bool Destroy();

-    virtual bool IsTopLevel() const { return TRUE; }
-    virtual wxSize GetMaxSize() const;
+    virtual bool IsTopLevel() const { return true; }
+    virtual bool IsVisible() const { return IsShown(); }

 
     // event handlers
     void OnCloseWindow(wxCloseEvent& event);
 
     // event handlers
     void OnCloseWindow(wxCloseEvent& event);

-    void OnSize(wxSizeEvent& event);
+    void OnSize(wxSizeEvent& WXUNUSED(event)) { DoLayout(); }
+
+    // Get rect to be used to center top-level children
+    virtual void GetRectForTopLevelChildren(int *x, int *y, int *w, int *h);

 
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms
 
     // this should go away, but for now it's called from docview.cpp,
     // so should be there for all platforms


@@ -177,54 +247,88 @@ public:
     // do the window-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 
     // do the window-specific processing after processing the update event
     virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
 

+    // a different API for SetSizeHints
+    virtual void SetMinSize(const wxSize& minSize);
+    virtual void SetMaxSize(const wxSize& maxSize);
+

 protected:
     // the frame client to screen translation should take account of the
     // toolbar which may shift the origin of the client area
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 
 protected:
     // the frame client to screen translation should take account of the
     // toolbar which may shift the origin of the client area
     virtual void DoClientToScreen(int *x, int *y) const;
     virtual void DoScreenToClient(int *x, int *y) const;
 

+    // add support for wxCENTRE_ON_SCREEN
+    virtual void DoCentre(int dir);
+
+    // no need to do client to screen translation to get our position in screen
+    // coordinates: this is already the case
+    virtual void DoGetScreenPosition(int *x, int *y) const
+    {
+        DoGetPosition(x, y);
+    }
+

     // test whether this window makes part of the frame
     // (menubar, toolbar and statusbar are excluded from automatic layout)
     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const
     // test whether this window makes part of the frame
     // (menubar, toolbar and statusbar are excluded from automatic layout)
     virtual bool IsOneOfBars(const wxWindow *WXUNUSED(win)) const

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

 
 

-    // check if we should exit the program after deleting this top level
-    // window (this is used in common dtor and wxMSW code)
+    // check if we should exit the program after deleting this window

     bool IsLastBeforeExit() const;
 
     bool IsLastBeforeExit() const;
 

-    // send the iconize event, return TRUE if processed
-    bool SendIconizeEvent(bool iconized = TRUE);
+    // send the iconize event, return true if processed
+    bool SendIconizeEvent(bool iconized = true);
+
+    // do TLW-specific layout: we resize our unique child to fill the entire
+    // client area
+    void DoLayout();

 
     // Get the default size for the new window if no explicit size given. If
     // there are better default sizes then these can be changed, just as long
     // as they are not too small for TLWs (and not larger than screen).
     static wxSize GetDefaultSize();
 
     // Get the default size for the new window if no explicit size given. If
     // there are better default sizes then these can be changed, just as long
     // as they are not too small for TLWs (and not larger than screen).
     static wxSize GetDefaultSize();

-    static int WidthDefault(int w) { return w == -1 ? GetDefaultSize().x : w; }
-    static int HeightDefault(int h) { return h == -1 ? GetDefaultSize().y : h; }
+    static int WidthDefault(int w) { return w == wxDefaultCoord ? GetDefaultSize().x : w; }
+    static int HeightDefault(int h) { return h == wxDefaultCoord ? GetDefaultSize().y : h; }
+

 
     // the frame icon
     wxIconBundle m_icons;
 
 
     // the frame icon
     wxIconBundle m_icons;
 

+    // a default window (usually a button) or NULL
+    wxWindowRef m_winDefault;
+
+    // a temporary override of m_winDefault, use the latter if NULL
+    wxWindowRef m_winTmpDefault;
+

     DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxTopLevelWindowBase)
     DECLARE_EVENT_TABLE()

+    WX_DECLARE_CONTROL_CONTAINER();

 };
 
 
 // include the real class declaration
 };
 
 
 // include the real class declaration

-#if defined(__WXMSW__)
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowPalm
+#elif defined(__WXMSW__)

     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW
     #include "wx/msw/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMSW

-#elif defined(__WXGTK__)
+#elif defined(__WXGTK20__)

     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK
     #include "wx/gtk/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowGTK

+#elif defined(__WXGTK__)
+    #include "wx/gtk1/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowGTK

 #elif defined(__WXX11__)
     #include "wx/x11/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowX11
 #elif defined(__WXMGL__)
     #include "wx/mgl/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMGL
 #elif defined(__WXX11__)
     #include "wx/x11/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowX11
 #elif defined(__WXMGL__)
     #include "wx/mgl/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMGL

+#elif defined(__WXDFB__)
+    #include "wx/dfb/toplevel.h"
+    #define wxTopLevelWindowNative wxTopLevelWindowDFB

 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)

-    #include "wx/mac/toplevel.h"
+    #include "wx/osx/toplevel.h"

     #define wxTopLevelWindowNative wxTopLevelWindowMac
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/toplevel.h"
     #define wxTopLevelWindowNative wxTopLevelWindowMac
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/toplevel.h"


@@ -241,7 +345,7 @@ protected:
     #include "wx/univ/toplevel.h"
 #else // !__WXUNIVERSAL__
     #ifdef wxTopLevelWindowNative
     #include "wx/univ/toplevel.h"
 #else // !__WXUNIVERSAL__
     #ifdef wxTopLevelWindowNative

-        class WXDLLEXPORT wxTopLevelWindow : public wxTopLevelWindowNative
+        class WXDLLIMPEXP_CORE wxTopLevelWindow : public wxTopLevelWindowNative

         {
         public:
             // construction
         {
         public:
             // construction