Various little tweaks

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 36e9e1979064857be0e44169246541d53fbee75a..fc770fe7f55f31be13c90342cb8c5fe8da0a8218 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        app.h
+// Name:        wx/app.h

 // Purpose:     wxAppBase class and macros used for declaration of wxApp
 //              derived class in the user code
 // Author:      Julian Smart
 // Purpose:     wxAppBase class and macros used for declaration of wxApp
 //              derived class in the user code
 // Author:      Julian Smart


@@ -47,6 +47,12 @@ class WXDLLEXPORT wxCmdLineParser;
     #include "wx/log.h"
 #endif
 
     #include "wx/log.h"
 #endif
 

+#if WXWIN_COMPATIBILITY_2_2
+    #include "wx/icon.h"
+#endif
+
+#include "wx/build.h"
+

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


@@ -54,20 +60,46 @@ class WXDLLEXPORT wxCmdLineParser;
 static const int wxPRINT_WINDOWS = 1;
 static const int wxPRINT_POSTSCRIPT = 2;
 
 static const int wxPRINT_WINDOWS = 1;
 static const int wxPRINT_POSTSCRIPT = 2;
 

+// ----------------------------------------------------------------------------
+// support for framebuffer ports
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+// VS: Fullscreen/framebuffer application needs to choose display mode prior
+//     to wxWindows initialization. This class holds information about display
+//     mode. It is used by  wxApp::Set/GetDisplayMode.
+class WXDLLEXPORT wxDisplayModeInfo
+{
+public:
+    wxDisplayModeInfo() : m_ok(FALSE) {}
+    wxDisplayModeInfo(unsigned width, unsigned height, unsigned depth) 
+        : m_width(width), m_height(height), m_depth(depth), m_ok(TRUE) {}
+    
+    unsigned GetWidth() const { return m_width; }
+    unsigned GetHeight() const { return m_height; }
+    unsigned GetDepth() const { return m_depth; }
+    bool IsOk() const { return m_ok; }
+
+private:
+    unsigned m_width, m_height, m_depth;
+    bool     m_ok;
+};
+#endif
+

 // ----------------------------------------------------------------------------
 // the common part of wxApp implementations for all platforms
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxAppBase : public wxEvtHandler
 {
 // ----------------------------------------------------------------------------
 // the common part of wxApp implementations for all platforms
 // ----------------------------------------------------------------------------
 
 class WXDLLEXPORT wxAppBase : public wxEvtHandler
 {

+    DECLARE_NO_COPY_CLASS(wxAppBase)
+        

 public:
     wxAppBase();
 public:
     wxAppBase();

+    virtual ~wxAppBase();

 
     // the virtual functions which may/must be overridden in the derived class
     // -----------------------------------------------------------------------
 
     // the virtual functions which may/must be overridden in the derived class
     // -----------------------------------------------------------------------

-#ifdef __DARWIN__
-    virtual ~wxAppBase() { }
-#endif

 
         // called during the program initialization, returning FALSE from here
         // prevents the program from continuing - it's a good place to create
 
         // called during the program initialization, returning FALSE from here
         // prevents the program from continuing - it's a good place to create


@@ -135,6 +167,17 @@ public:
         // process the first event in the event queue (blocks until an event
         // apperas if there are none currently)
     virtual void Dispatch() = 0;
         // process the first event in the event queue (blocks until an event
         // apperas if there are none currently)
     virtual void Dispatch() = 0;

+
+        // process all currently pending events right now
+        //
+        // it is an error to call Yield() recursively unless the value of
+        // onlyIfNeeded is TRUE
+        //
+        // WARNING: this function is dangerous as it can lead to unexpected
+        //          reentrancies (i.e. when called from an event handler it
+        //          may result in calling the same event handler again), use
+        //          with _extreme_ care or, better, don't use at all!
+    virtual bool Yield(bool onlyIfNeeded = FALSE) = 0;

 #endif // wxUSE_GUI
 
     // application info: name, description, vendor
 #endif // wxUSE_GUI
 
     // application info: name, description, vendor


@@ -240,14 +283,20 @@ public:
 #endif // wxUSE_LOG
 
 #if wxUSE_GUI
 #endif // wxUSE_LOG
 
 #if wxUSE_GUI

+
+  #if WXWIN_COMPATIBILITY_2_2

         // get the standard icon used by wxWin dialogs - this allows the user
         // to customize the standard dialogs. The 'which' parameter is one of
         // wxICON_XXX values
         // get the standard icon used by wxWin dialogs - this allows the user
         // to customize the standard dialogs. The 'which' parameter is one of
         // wxICON_XXX values

-    virtual wxIcon GetStdIcon(int which) const = 0;
+    virtual wxIcon GetStdIcon(int WXUNUSED(which)) const { return wxNullIcon; }
+  #endif

 
 

-        // VZ: what does this do exactly?
-    void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
-    bool GetWantDebugOutput() const { return m_wantDebugOutput; }
+        // Get display mode that is used use. This is only used in framebuffer wxWin ports
+        // (such as wxMGL).
+    virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); }
+        // Set display mode to use. This is only used in framebuffer wxWin ports
+        // (such as wxMGL). This method should be called from wxApp:OnInitGui
+    virtual bool SetDisplayMode(const wxDisplayModeInfo& WXUNUSED(info)) { return TRUE; }

 
         // set use of best visual flag (see below)
     void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }
 
         // set use of best visual flag (see below)
     void SetUseBestVisual( bool flag ) { m_useBestVisual = flag; }


@@ -266,16 +315,48 @@ public:
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 #endif // wxUSE_GUI
 
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 #endif // wxUSE_GUI
 

+    // this method allows to filter all the events processed by the program, so
+    // you should try to return quickly from it to avoid slowing down the
+    // program to the crawl
+    //
+    // return value should be -1 to continue with the normal event processing,
+    // or TRUE or FALSE to stop further processing and pretend that the event
+    // had been already processed or won't be processed at all, respectively
+    virtual int FilterEvent(wxEvent& event);
+

     // debugging support
     // -----------------
 
     // 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)
     // debugging support
     // -----------------
 
     // 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
+    // assert itself and the user-specified message

 #ifdef __WXDEBUG__
 #ifdef __WXDEBUG__

-    virtual void OnAssert(const wxChar *file, int line, const wxChar *msg);
+    virtual void OnAssert(const wxChar *file,
+                          int line,
+                          const wxChar *cond,
+                          const wxChar *msg);

 #endif // __WXDEBUG__
 
 #endif // __WXDEBUG__
 

+    // check that the wxBuildOptions object (constructed in the application
+    // itself, usually the one from IMPLEMENT_APP() macro) matches the build
+    // options of the library and abort if it doesn't
+    static bool CheckBuildOptions(const wxBuildOptions& buildOptions);
+
+    // deprecated functions, please updae your code to not use them!
+    // -------------------------------------------------------------
+
+#if WXWIN_COMPATIBILITY_2_2
+    // used by obsolete wxDebugMsg only
+    void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
+    bool GetWantDebugOutput() const { return m_wantDebugOutput; }
+
+    // TRUE if the application wants to get debug output
+    bool m_wantDebugOutput;
+#endif // WXWIN_COMPATIBILITY_2_2
+

     // implementation only from now on
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------
 


@@ -301,9 +382,6 @@ protected:
              m_appName,         // app name
              m_className;       // class name
 
              m_appName,         // app name
              m_className;       // class name
 

-    // TRUE if the application wants to get debug output
-    bool m_wantDebugOutput;
-

 #if wxUSE_GUI
     // the main top level window - may be NULL
     wxWindow *m_topWindow;
 #if wxUSE_GUI
     // the main top level window - may be NULL
     wxWindow *m_topWindow;


@@ -333,6 +411,8 @@ protected:
         #include "wx/mgl/app.h"
     #elif defined(__WXGTK__)
         #include "wx/gtk/app.h"
         #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(__WXPM__)
     #elif defined(__WXMAC__)
         #include "wx/mac/app.h"
     #elif defined(__WXPM__)


@@ -486,7 +566,11 @@ public:
 // Use this macro if you want to define your own main() or WinMain() function
 // and call wxEntry() from there.
 #define IMPLEMENT_APP_NO_MAIN(appname)                   \
 // Use this macro if you want to define your own main() or WinMain() function
 // and call wxEntry() from there.
 #define IMPLEMENT_APP_NO_MAIN(appname)                   \

-    wxApp *wxCreateApp() { return new appname; }         \
+    wxApp *wxCreateApp()                                 \
+    {                                                    \
+        wxApp::CheckBuildOptions(wxBuildOptions());      \
+        return new appname;                              \
+    }                                                    \

     wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
     appname& wxGetApp() { return *(appname *)wxTheApp; }
 
     wxAppInitializer wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
     appname& wxGetApp() { return *(appname *)wxTheApp; }