]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/app.h
Add test for context menu, fixed mem leak, fixed focus problem when re-editing same...
[wxWidgets.git] / include / wx / app.h
index 4eae440186f8fee3691237cba975e648c8ababd7..f19a633abebf660db6bbf56ee06e67c351c7bda3 100644 (file)
 // ----------------------------------------------------------------------------
 
 #include "wx/event.h"       // for the base class
-
-#if wxUSE_GUI
-    #include "wx/window.h"  // for wxTopLevelWindows
-
-    #include "wx/vidmode.h"
-#endif // wxUSE_GUI
-
 #include "wx/build.h"
+#include "wx/cmdargs.h"     // for wxCmdLineArgsArray used by wxApp::argv
 #include "wx/init.h"        // we must declare wxEntry()
+#include "wx/intl.h"        // for wxLayoutDirection
 
-class WXDLLIMPEXP_BASE wxAppConsole;
-class WXDLLIMPEXP_BASE wxAppTraits;
-class WXDLLIMPEXP_BASE wxCmdLineParser;
-class WXDLLIMPEXP_BASE wxLog;
-class WXDLLIMPEXP_BASE wxMessageOutput;
-
-// wxUSE_EVTLOOP_IN_APP is a temporary hack needed until all ports are updated
-// to use wxEventLoop, otherwise we get linking errors on wxMac, it's going to
-// disappear a.s.a.p.
-#ifdef __WXMAC__
-    #define wxUSE_EVTLOOP_IN_APP 0
-#else
-    #define wxUSE_EVTLOOP_IN_APP 1
-    class WXDLLEXPORT wxEventLoop;
+class WXDLLIMPEXP_FWD_BASE wxAppConsole;
+class WXDLLIMPEXP_FWD_BASE wxAppTraits;
+class WXDLLIMPEXP_FWD_BASE wxCmdLineParser;
+class WXDLLIMPEXP_FWD_BASE wxEventLoopBase;
+class WXDLLIMPEXP_FWD_BASE wxLog;
+class WXDLLIMPEXP_FWD_BASE wxMessageOutput;
+
+#if wxUSE_GUI
+    class WXDLLIMPEXP_FWD_CORE wxVideoMode;
 #endif
 
 // ----------------------------------------------------------------------------
@@ -62,15 +52,15 @@ enum
 };
 
 // ----------------------------------------------------------------------------
-// wxAppConsole: wxApp for non-GUI applications
+// wxAppConsoleBase: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxAppConsole : public wxEvtHandler
+class WXDLLIMPEXP_BASE wxAppConsoleBase : public wxEvtHandler
 {
 public:
     // ctor and dtor
-    wxAppConsole();
-    virtual ~wxAppConsole();
+    wxAppConsoleBase();
+    virtual ~wxAppConsoleBase();
 
 
     // the virtual functions which may/must be overridden in the derived class
@@ -97,7 +87,7 @@ public:
 
     // This is the replacement for the normal main(): all program work should
     // be done here. When OnRun() returns, the programs starts shutting down.
-    virtual int OnRun() = 0;
+    virtual int OnRun();
 
     // This is only called if OnInit() returned true so it's a good place to do
     // any cleanup matching the initializations done there.
@@ -116,20 +106,6 @@ public:
     // crash.
     virtual void OnFatalException() { }
 
-#if wxUSE_EXCEPTIONS
-    // function called if an uncaught exception is caught inside the main
-    // event loop: it may return true to continue running the event loop or
-    // false to stop it (in the latter case it may rethrow the exception as
-    // well)
-    virtual bool OnExceptionInMainLoop();
-
-    // Called when an unhandled C++ exception occurs inside OnRun(): note that
-    // the exception type is lost by now, so if you really want to handle the
-    // exception you should override OnRun() and put a try/catch around
-    // MainLoop() call there
-    virtual void OnUnhandledException() { }
-#endif // wxUSE_EXCEPTIONS
-
     // Called from wxExit() function, should terminate the application a.s.a.p.
     virtual void Exit();
 
@@ -148,6 +124,17 @@ public:
     }
     void SetAppName(const wxString& name) { m_appName = name; }
 
+        // set/get the application display name: the display name is the name
+        // shown to the user in titles, reports, etc while the app name is
+        // used for paths, config, and other places the user doesn't see
+        //
+        // so the app name could be myapp while display name could be "My App"
+    wxString GetAppDisplayName() const
+    {
+        return m_appDisplayName.empty() ? GetAppName() : m_appDisplayName;
+    }
+    void SetAppDisplayName(const wxString& name) { m_appDisplayName = name; }
+
         // set/get the app class name
     wxString GetClassName() const { return m_className; }
     void SetClassName(const wxString& name) { m_className = name; }
@@ -156,6 +143,19 @@ public:
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 
+        // set/get the vendor display name:  the display name is shown
+        // in titles/reports/dialogs to the user, while the vendor name
+        // is used in some areas such as wxConfig, wxStandardPaths, etc
+    const wxString& GetVendorDisplayName() const
+    {
+        return m_vendorDisplayName.empty() ? GetVendorName()
+                                           : m_vendorDisplayName;
+    }
+    void SetVendorDisplayName(const wxString& name)
+    {
+        m_vendorDisplayName = name;
+    }
+
 
     // cmd line parsing stuff
     // ----------------------
@@ -195,26 +195,9 @@ public:
     // either should be configurable by the user (then he can change the
     // default behaviour simply by overriding CreateTraits() and returning his
     // own traits object) or which is GUI/console dependent as then wxAppTraits
-    // allows us to abstract the differences behind the common faรงade
+    // allows us to abstract the differences behind the common facade
     wxAppTraits *GetTraits();
 
-    // the functions below shouldn't be used now that we have wxAppTraits
-#if WXWIN_COMPATIBILITY_2_4
-
-#if wxUSE_LOG
-        // override this function to create default log target of arbitrary
-        // user-defined class (default implementation creates a wxLogGui
-        // object) -- this log object is used by default by all wxLogXXX()
-        // functions.
-    virtual wxLog *CreateLogTarget();
-#endif // wxUSE_LOG
-
-        // similar to CreateLogTarget() but for the global wxMessageOutput
-        // object
-    virtual wxMessageOutput *CreateMessageOutput();
-
-#endif // WXWIN_COMPATIBILITY_2_4
-
 
     // event processing functions
     // --------------------------
@@ -237,31 +220,86 @@ public:
     virtual void HandleEvent(wxEvtHandler *handler,
                              wxEventFunction func,
                              wxEvent& event) const;
+
+    // Called when an unhandled C++ exception occurs inside OnRun(): note that
+    // the main event loop has already terminated by now and the program will
+    // exit, if you need to really handle the exceptions you need to override
+    // OnExceptionInMainLoop()
+    virtual void OnUnhandledException();
 #endif // wxUSE_EXCEPTIONS
 
+    // event processing functions
+    // --------------------------
+
+    // return true if we're running event loop, i.e. if the events can
+    // (already) be dispatched
+    static bool IsMainLoopRunning();
+
     // process all events in the wxPendingEvents list -- it is necessary to
     // call this function to process posted events. This happens during each
     // event loop iteration in GUI mode but if there is no main loop, it may be
     // also called directly.
     virtual void ProcessPendingEvents();
 
+    // check if there are pending events on global pending event list
+    bool HasPendingEvents() const;
+
     // doesn't do anything in this class, just a hook for GUI wxApp
     virtual bool Yield(bool WXUNUSED(onlyIfNeeded) = false) { return true; }
 
     // make sure that idle events are sent again
-    virtual void WakeUpIdle() { }
+    virtual void WakeUpIdle();
+
+        // execute the main GUI loop, the function returns when the loop ends
+    virtual int MainLoop();
+
+        // exit the main GUI loop during the next iteration (i.e. it does not
+        // stop the program immediately!)
+    virtual void ExitMainLoop();
+
+        // returns true if there are unprocessed events in the event queue
+    virtual bool Pending();
 
+        // process the first event in the event queue (blocks until an event
+        // appears if there are none currently, use Pending() if this is not
+        // wanted), returns false if the event loop should stop and true
+        // otherwise
+    virtual bool Dispatch();
+
+        // this virtual function is called  when the application
+        // becomes idle and normally just sends wxIdleEvent to all interested
+        // parties
+        //
+        // it should return true if more idle events are needed, false if not
+    virtual bool ProcessIdle();
+
+#if wxUSE_EXCEPTIONS
+    // Function called if an uncaught exception is caught inside the main
+    // event loop: it may return true to continue running the event loop or
+    // false to stop it (in the latter case it may rethrow the exception as
+    // well)
+    virtual bool OnExceptionInMainLoop();
+#endif // wxUSE_EXCEPTIONS
 
     // debugging support
     // -----------------
 
+#ifdef __WXDEBUG__
     // this function is called when an assert failure occurs, the base class
     // version does the normal processing (i.e. shows the usual assert failure
     // dialog box)
     //
-    // the arguments are the place where the assert occured, the text of the
+    // the arguments are the location of the failed assert (func may be empty
+    // if the compiler doesn't support C99 __FUNCTION__), the text of the
     // assert itself and the user-specified message
-#ifdef __WXDEBUG__
+    virtual void OnAssertFailure(const wxChar *file,
+                                 int line,
+                                 const wxChar *func,
+                                 const wxChar *cond,
+                                 const wxChar *msg);
+
+    // old version of the function without func parameter, for compatibility
+    // only, override OnAssertFailure() in the new code
     virtual void OnAssert(const wxChar *file,
                           int line,
                           const wxChar *cond,
@@ -273,12 +311,6 @@ public:
     // options of the library and abort if it doesn't
     static bool CheckBuildOptions(const char *optionsSignature,
                                   const char *componentName);
-#if WXWIN_COMPATIBILITY_2_4
-    static bool CheckBuildOptions(const wxBuildOptions& buildOptions)
-    {
-        return CheckBuildOptions(buildOptions.m_signature, "your program");
-    }
-#endif
 
     // implementation only from now on
     // -------------------------------
@@ -298,8 +330,17 @@ public:
 
 
     // command line arguments (public for backwards compatibility)
-    int      argc;
-    wxChar **argv;
+    int argc;
+
+    // this object is implicitly convertible to either "char**" (traditional
+    // type of argv parameter of main()) or to "wchar_t **" (for compatibility
+    // with Unicode build in previous wx versions and because the command line
+    // can, in pr
+#if wxUSE_UNICODE
+    wxCmdLineArgsArray argv;
+#else
+    char **argv;
+#endif
 
 protected:
     // the function which creates the traits object when GetTraits() needs it
@@ -313,22 +354,37 @@ protected:
     // the one and only global application object
     static wxAppConsole *ms_appInstance;
 
+    // create main loop from AppTraits or return NULL if
+    // there is no main loop implementation
+    wxEventLoopBase *CreateMainLoop();
 
     // application info (must be set from the user code)
-    wxString m_vendorName,      // vendor name (ACME Inc)
-             m_appName,         // app name
-             m_className;       // class name
+    wxString m_vendorName,        // vendor name ("acme")
+             m_vendorDisplayName, // vendor display name (e.g. "ACME Inc")
+             m_appName,           // app name ("myapp")
+             m_appDisplayName,    // app display name ("My Application")
+             m_className;         // class name
 
     // the class defining the application behaviour, NULL initially and created
     // by GetTraits() when first needed
     wxAppTraits *m_traits;
 
+    // the main event loop of the application (may be NULL if the loop hasn't
+    // been started yet or has already terminated)
+    wxEventLoopBase *m_mainLoop;
 
     // the application object is a singleton anyhow, there is no sense in
     // copying it
-    DECLARE_NO_COPY_CLASS(wxAppConsole)
+    DECLARE_NO_COPY_CLASS(wxAppConsoleBase)
 };
 
+#if defined(__UNIX__)
+    #include "wx/unix/app.h"
+#else
+    // this has to be a class and not a typedef as we forward declare it
+    class wxAppConsole : public wxAppConsoleBase { };
+#endif
+
 // ----------------------------------------------------------------------------
 // wxAppBase: the common part of wxApp implementations for all platforms
 // ----------------------------------------------------------------------------
@@ -376,35 +432,7 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
-        // return true if we're running main loop, i.e. if the events can
-        // (already) be dispatched
-    bool IsMainLoopRunning() const
-    {
-#if wxUSE_EVTLOOP_IN_APP
-        return m_mainLoop != NULL;
-#else
-        return false;
-#endif
-    }
 
-        // execute the main GUI loop, the function returns when the loop ends
-    virtual int MainLoop();
-
-        // exit the main loop thus terminating the application
-    virtual void Exit();
-
-        // exit the main GUI loop during the next iteration (i.e. it does not
-        // stop the program immediately!)
-    virtual void ExitMainLoop();
-
-        // returns true if there are unprocessed events in the event queue
-    virtual bool Pending();
-
-        // process the first event in the event queue (blocks until an event
-        // appears if there are none currently, use Pending() if this is not
-        // wanted), returns false if the event loop should stop and true
-        // otherwise
-    virtual bool Dispatch();
 
         // process all currently pending events right now
         //
@@ -428,9 +456,6 @@ public:
         // Returns true if more idle time is requested.
     virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
 
-        // Perform standard OnIdle behaviour: call from port's OnIdle
-    void OnIdle(wxIdleEvent& event);
-
 
     // top level window functions
     // --------------------------
@@ -444,15 +469,7 @@ public:
         // return the "main" top level window (if it hadn't been set previously
         // with SetTopWindow(), will return just some top level window and, if
         // there are none, will return NULL)
-    virtual wxWindow *GetTopWindow() const
-    {
-        if (m_topWindow)
-            return m_topWindow;
-        else if (wxTopLevelWindows.GetCount() > 0)
-            return wxTopLevelWindows.GetFirst()->GetData();
-        else
-            return (wxWindow *)NULL;
-    }
+    virtual wxWindow *GetTopWindow() const;
 
         // control the exit behaviour: by default, the program will exit the
         // main loop (and so, usually, terminate) when the last top-level
@@ -469,15 +486,16 @@ public:
     // ------------------------------------------------------------------------
 
         // Get display mode that is used use. This is only used in framebuffer
-        // wxWin ports (such as wxMGL).
-    virtual wxVideoMode GetDisplayMode() const { return wxVideoMode(); }
+        // wxWin ports (such as wxMGL or wxDFB).
+    virtual wxVideoMode GetDisplayMode() const;
         // Set display mode to use. This is only used in framebuffer wxWin
-        // ports (such as wxMGL). This method should be called from
+        // ports (such as wxMGL or wxDFB). This method should be called from
         // wxApp::OnInitGui
     virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
 
         // set use of best visual flag (see below)
-    void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }
+    void SetUseBestVisual( bool flag, bool forceTrueColour = false )
+        { m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
     bool GetUseBestVisual() const { return m_useBestVisual; }
 
         // set/get printing mode: see wxPRINT_XXX constants.
@@ -487,6 +505,13 @@ public:
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
+    // Return the layout direction for the current locale or wxLayout_Default
+    // if it's unknown
+    virtual wxLayoutDirection GetLayoutDirection() const;
+
+    // Change the theme used by the application, return true on success.
+    virtual bool SetNativeTheme(const wxString& WXUNUSED(theme)) { return false; }
+
 
     // command line parsing (GUI-specific)
     // ------------------------------------------------------------------------
@@ -504,11 +529,12 @@ public:
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 
+#if WXWIN_COMPATIBILITY_2_6
     // OBSOLETE: don't use, always returns true
     //
     // returns true if the program is successfully initialized
-    bool Initialized() { return true; }
-
+    wxDEPRECATED( bool Initialized() );
+#endif // WXWIN_COMPATIBILITY_2_6
 
 protected:
     // delete all objects in wxPendingDelete list
@@ -518,12 +544,6 @@ protected:
     virtual wxAppTraits *CreateTraits();
 
 
-#if wxUSE_EVTLOOP_IN_APP
-    // the main event loop of the application (may be NULL if the loop hasn't
-    // been started yet or has already terminated)
-    wxEventLoop *m_mainLoop;
-#endif // wxUSE_EVTLOOP_IN_APP
-
     // the main top level window (may be NULL)
     wxWindow *m_topWindow;
 
@@ -538,44 +558,57 @@ protected:
         Yes
     } m_exitOnFrameDelete;
 
-    // true if the apps whats to use the best visual on systems where
+    // true if the app wants to use the best visual on systems where
     // more than one are available (Sun, SGI, XFree86 4.0 ?)
     bool m_useBestVisual;
+    // force TrueColour just in case "best" isn't TrueColour
+    bool m_forceTrueColour;
 
-    // does any of our windows has focus?
+    // does any of our windows have focus?
     bool m_isActive;
 
 
     DECLARE_NO_COPY_CLASS(wxAppBase)
 };
 
-#endif // wxUSE_GUI
+#if WXWIN_COMPATIBILITY_2_6
+    inline bool wxAppBase::Initialized() { return true; }
+#endif // WXWIN_COMPATIBILITY_2_6
 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 
-#if wxUSE_GUI
-    #if defined(__WXMSW__)
-        #include "wx/msw/app.h"
-    #elif defined(__WXMOTIF__)
-        #include "wx/motif/app.h"
-    #elif defined(__WXMGL__)
-        #include "wx/mgl/app.h"
-    #elif defined(__WXGTK__)
-        #include "wx/gtk/app.h"
-    #elif defined(__WXX11__)
-        #include "wx/x11/app.h"
-    #elif defined(__WXMAC__)
-        #include "wx/mac/app.h"
-    #elif defined(__WXCOCOA__)
-        #include "wx/cocoa/app.h"
-    #elif defined(__WXPM__)
-        #include "wx/os2/app.h"
-    #endif
+#if defined(__WXPALMOS__)
+    #include "wx/palmos/app.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/app.h"
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/app.h"
+#elif defined(__WXMGL__)
+    #include "wx/mgl/app.h"
+#elif defined(__WXDFB__)
+    #include "wx/dfb/app.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/app.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/app.h"
+#elif defined(__WXX11__)
+    #include "wx/x11/app.h"
+#elif defined(__WXMAC__)
+    #include "wx/mac/app.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/app.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/app.h"
+#endif
+
 #else // !GUI
-    // allow using just wxApp (instead of wxAppConsole) in console programs
-    typedef wxAppConsole wxApp;
+
+// wxApp is defined in core and we cannot define another one in wxBase,
+// so use the preprocessor to allow using wxApp in console programs too
+#define wxApp wxAppConsole
+
 #endif // GUI/!GUI
 
 // ----------------------------------------------------------------------------
@@ -591,7 +624,7 @@ protected:
 //
 // the cast is safe as in GUI build we only use wxApp, not wxAppConsole, and in
 // console mode it does nothing at all
-#define wxTheApp ((wxApp *)wxApp::GetInstance())
+#define wxTheApp wx_static_cast(wxApp*, wxApp::GetInstance())
 
 // ----------------------------------------------------------------------------
 // global functions
@@ -603,9 +636,16 @@ protected:
 // Force an exit from main loop
 extern void WXDLLIMPEXP_BASE wxExit();
 
+// avoid redeclaring this function here if it had been already declated by
+// wx/utils.h, this results in warnings from g++ with -Wredundant-decls
+#ifndef wx_YIELD_DECLARED
+#define wx_YIELD_DECLARED
+
 // Yield to other apps/messages
 extern bool WXDLLIMPEXP_BASE wxYield();
 
+#endif // wx_YIELD_DECLARED
+
 // Yield to other apps/messages
 extern void WXDLLIMPEXP_BASE wxWakeUpIdle();
 
@@ -631,7 +671,7 @@ public:
 #define IMPLEMENT_WXWIN_MAIN_CONSOLE \
         int main(int argc, char **argv) { return wxEntry(argc, argv); }
 
-// port-specific header could have defined it already in some special wau
+// port-specific header could have defined it already in some special way
 #ifndef IMPLEMENT_WXWIN_MAIN
     #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
 #endif // defined(IMPLEMENT_WXWIN_MAIN)
@@ -639,9 +679,12 @@ public:
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"
 
-    #define IMPLEMENT_WX_THEME_SUPPORT \
-        WX_USE_THEME(win32); \
-        WX_USE_THEME(gtk);
+    #ifdef wxUNIV_DEFAULT_THEME
+        #define IMPLEMENT_WX_THEME_SUPPORT \
+            WX_USE_THEME(wxUNIV_DEFAULT_THEME);
+    #else
+        #define IMPLEMENT_WX_THEME_SUPPORT
+    #endif
 #else
     #define IMPLEMENT_WX_THEME_SUPPORT
 #endif
@@ -657,7 +700,8 @@ public:
     }                                                                       \
     wxAppInitializer                                                        \
         wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp);        \
-    appname& wxGetApp() { return *(appname *)wxTheApp; }
+    DECLARE_APP(appname)                                                    \
+    appname& wxGetApp() { return *wx_static_cast(appname*, wxApp::GetInstance()); }
 
 // Same as IMPLEMENT_APP() normally but doesn't include themes support in
 // wxUniversal builds
@@ -680,5 +724,12 @@ public:
 // function
 #define DECLARE_APP(appname) extern appname& wxGetApp();
 
-#endif // _WX_APP_H_BASE_
 
+// declare the stuff defined by IMPLEMENT_APP() macro, it's not really needed
+// anywhere else but at the very least it suppresses icc warnings about
+// defining extern symbols without prior declaration, and it shouldn't do any
+// harm
+extern wxAppConsole *wxCreateApp();
+extern wxAppInitializer wxTheAppInitializer;
+
+#endif // _WX_APP_H_BASE_