Added BMP files for wxPlotWindow,

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

diff --git a/include/wx/app.h b/include/wx/app.h
index 85e28145a8221978ec37ba58495d01440eeda1e7..4b682d6aa80d0f91d9c0dc896350789f857da361 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -37,7 +37,9 @@
 
 #include "wx/event.h"       // for the base class
 
 
 #include "wx/event.h"       // for the base class
 

-#include "wx/window.h"      // for wxTopLevelWindows
+#if wxUSE_GUI
+    #include "wx/window.h"      // for wxTopLevelWindows
+#endif // wxUSE_GUI

 
 #if wxUSE_LOG
     #include "wx/log.h"
 
 #if wxUSE_LOG
     #include "wx/log.h"


@@ -64,22 +66,33 @@ public:
         // prevents the program from continuing - it's a good place to create
         // the top level program window and return TRUE.
         //
         // prevents the program from continuing - it's a good place to create
         // the top level program window and return TRUE.
         //

-        // Override: always.
+        // Override: always in GUI application, rarely in console ones.
+#if wxUSE_GUI

     virtual bool OnInit() { return FALSE; };
     virtual bool OnInit() { return FALSE; };

+#else // !GUI
+    virtual bool OnInit() { return TRUE; };
+#endif // wxUSE_GUI

 
 

+#if wxUSE_GUI

         // a platform-dependent version of OnInit(): the code here is likely to
         // depend on the toolkit. default version does nothing.
         //
         // Override: rarely.
     virtual bool OnInitGui() { return TRUE; }
         // a platform-dependent version of OnInit(): the code here is likely to
         // depend on the toolkit. default version does nothing.
         //
         // Override: rarely.
     virtual bool OnInitGui() { return TRUE; }

+#endif // wxUSE_GUI

 
         // called to start program execution - the default version just enters
         // the main GUI loop in which events are received and processed until
         // the last window is not deleted (if GetExitOnFrameDelete) or
 
         // called to start program execution - the default version just enters
         // the main GUI loop in which events are received and processed until
         // the last window is not deleted (if GetExitOnFrameDelete) or

-        // ExitMainLoop() is called.
+        // ExitMainLoop() is called. In console mode programs, the execution
+        // of the program really starts here

         //
         //

-        // Override: rarely.
+        // Override: rarely in GUI applications, always in console ones.
+#if wxUSE_GUI

     virtual int OnRun() { return MainLoop(); };
     virtual int OnRun() { return MainLoop(); };

+#else // !GUI
+    virtual int OnRun() = 0;
+#endif // wxUSE_GUI

 
         // called after the main loop termination. This is a good place for
         // cleaning up (it may be too late in dtor) and is also useful if you
 
         // called after the main loop termination. This is a good place for
         // cleaning up (it may be too late in dtor) and is also useful if you


@@ -87,7 +100,7 @@ public:
         // value of this method.
         //
         // Override: often.
         // value of this method.
         //
         // Override: often.

-    virtual int OnExit() { return 0; }
+    virtual int OnExit();

 
         // called when a fatal exception occurs, this function should take care
         // not to do anything which might provoke a nested exception! It may be
 
         // called when a fatal exception occurs, this function should take care
         // not to do anything which might provoke a nested exception! It may be


@@ -102,6 +115,7 @@ public:
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 
     // the worker functions - usually not used directly by the user code
     // -----------------------------------------------------------------
 

+#if wxUSE_GUI

         // execute the main GUI loop, the function returns when the loop ends
     virtual int MainLoop() = 0;
 
         // execute the main GUI loop, the function returns when the loop ends
     virtual int MainLoop() = 0;
 


@@ -118,6 +132,7 @@ 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;

+#endif // wxUSE_GUI

 
     // application info: name, description, vendor
     // -------------------------------------------
 
     // application info: name, description, vendor
     // -------------------------------------------


@@ -144,6 +159,7 @@ public:
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 
     const wxString& GetVendorName() const { return m_vendorName; }
     void SetVendorName(const wxString& name) { m_vendorName = name; }
 

+#if wxUSE_GUI

     // top level window functions
     // --------------------------
 
     // top level window functions
     // --------------------------
 


@@ -171,6 +187,8 @@ public:
     void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
     bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
 
     void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
     bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
 

+#endif // wxUSE_GUI
+

     // miscellaneous customization functions
     // -------------------------------------
 
     // miscellaneous customization functions
     // -------------------------------------
 


@@ -179,10 +197,15 @@ public:
         // user-defined class (default implementation creates a wxLogGui
         // object) - this log object is used by default by all wxLogXXX()
         // functions.
         // user-defined class (default implementation creates a wxLogGui
         // object) - this log object is used by default by all wxLogXXX()
         // functions.

-    virtual wxLog *CreateLogTarget() { return new wxLogGui; }
+    virtual wxLog *CreateLogTarget()
+#if wxUSE_GUI
+        { return new wxLogGui; }
+#else // !GUI
+        { return new wxLogStderr; }
+#endif // wxUSE_GUI

 #endif // wxUSE_LOG
 
 #endif // wxUSE_LOG
 

-
+#if wxUSE_GUI

         // 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


@@ -192,12 +215,17 @@ public:
     void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
     bool GetWantDebugOutput() const { return m_wantDebugOutput; }
 
     void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
     bool GetWantDebugOutput() const { return m_wantDebugOutput; }
 

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

         // set/get printing mode: see wxPRINT_XXX constants.
         //
         // default behaviour is the normal one for Unix: always use PostScript
         // printing.
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
         // set/get printing mode: see wxPRINT_XXX constants.
         //
         // default behaviour is the normal one for Unix: always use PostScript
         // printing.
     virtual void SetPrintMode(int WXUNUSED(mode)) { }
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }

+#endif // wxUSE_GUI

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


@@ -208,6 +236,9 @@ public:
     static wxAppInitializerFunction GetInitializerFunction()
         { return m_appInitFn; }
 
     static wxAppInitializerFunction GetInitializerFunction()
         { return m_appInitFn; }
 

+    // process all events in the wxPendingEvents list
+    virtual void ProcessPendingEvents();
+

     // access to the command line arguments
     int      argc;
     wxChar **argv;
     // access to the command line arguments
     int      argc;
     wxChar **argv;


@@ -227,28 +258,43 @@ protected:
 
     // TRUE if the application wants to get debug output
     bool m_wantDebugOutput;
 
     // TRUE if the application wants to get debug output
     bool m_wantDebugOutput;

+    
+    // TRUE if the apps whats to use the best visual on systems where
+    // more than one are available (Sun, SGI, XFree86 4.0 ?)
+    bool m_useBestVisual;

 
 

+#if wxUSE_GUI

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

+#endif // wxUSE_GUI

 };
 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // now include the declaration of the real class
 // ----------------------------------------------------------------------------
 

-#if defined(__WXMSW__)
-    #include "wx/msw/app.h"
-#elif defined(__WXMOTIF__)
-    #include "wx/motif/app.h"
-#elif defined(__WXQT__)
-    #include "wx/qt/app.h"
-#elif defined(__WXGTK__)
-    #include "wx/gtk/app.h"
-#elif defined(__WXMAC__)
-    #include "wx/mac/app.h"
-#elif defined(__WXSTUBS__)
-    #include "wx/stubs/app.h"
-#endif
+#if wxUSE_GUI
+    #if defined(__WXMSW__)
+        #include "wx/msw/app.h"
+    #elif defined(__WXMOTIF__)
+        #include "wx/motif/app.h"
+    #elif defined(__WXQT__)
+        #include "wx/qt/app.h"
+    #elif defined(__WXGTK__)
+        #include "wx/gtk/app.h"
+    #elif defined(__WXMAC__)
+        #include "wx/mac/app.h"
+    #elif defined(__WXPM__)
+        #include "wx/os2/app.h"
+    #elif defined(__WXSTUBS__)
+        #include "wx/stubs/app.h"
+    #endif
+#else // !GUI
+    // can't use typedef because wxApp forward declared as a class
+    class WXDLLEXPORT wxApp : public wxAppBase
+    {
+    };
+#endif // GUI/!GUI

 
 // ----------------------------------------------------------------------------
 // the global data
 
 // ----------------------------------------------------------------------------
 // the global data


@@ -264,11 +310,46 @@ WXDLLEXPORT_DATA(extern wxApp*) wxTheApp;
 // global functions
 // ----------------------------------------------------------------------------
 
 // global functions
 // ----------------------------------------------------------------------------
 

+// event loop related functions only work in GUI programs
+// ------------------------------------------------------
+

 // Force an exit from main loop
 // Force an exit from main loop

-void WXDLLEXPORT wxExit();
+extern void WXDLLEXPORT wxExit();
+
+// Yield to other apps/messages
+extern bool WXDLLEXPORT wxYield();

 
 // Yield to other apps/messages
 
 // Yield to other apps/messages

-bool WXDLLEXPORT wxYield();
+extern void WXDLLEXPORT wxWakeUpIdle();
+
+#if wxUSE_GUI
+
+// Post a message to the given eventhandler which will be processed during the
+// next event loop iteration
+inline void WXDLLEXPORT wxPostEvent(wxEvtHandler *dest, wxEvent& event)
+{
+    wxCHECK_RET( dest, wxT("need an object to post event to in wxPostEvent") );
+
+    dest->AddPendingEvent(event);
+}
+
+#endif // wxUSE_GUI
+
+// console applications may avoid using DECLARE_APP and IMPLEMENT_APP macros
+// and call these functions instead at the program startup and termination
+// -------------------------------------------------------------------------
+
+#if !wxUSE_GUI
+
+// initialize the library (may be called as many times as needed, but each
+// call to wxInitialize() must be matched by wxUninitialize())
+extern bool WXDLLEXPORT wxInitialize();
+
+// clean up - the library can't be used any more after the last call to
+// wxUninitialize()
+extern void WXDLLEXPORT wxUninitialize();
+
+#endif // !wxUSE_GUI

 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object
 
 // ----------------------------------------------------------------------------
 // macros for dynamic creation of the application object


@@ -289,18 +370,14 @@ public:
 // be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
 // code if required.
 
 // be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
 // code if required.
 

-#if defined(__AIX__) || defined(__HPUX__)
+#if !wxUSE_GUI || defined(__AIX__) || defined(__HPUX__) || defined( __VMS__ ) || defined(__WXPM__)

     #define IMPLEMENT_WXWIN_MAIN \
         extern int wxEntry( int argc, char *argv[] ); \
         int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
     // NT defines APIENTRY, 3.x not
     #if !defined(WXAPIENTRY)
     #define IMPLEMENT_WXWIN_MAIN \
         extern int wxEntry( int argc, char *argv[] ); \
         int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
 #elif defined(__WXMSW__) && defined(WXUSINGDLL)
     // NT defines APIENTRY, 3.x not
     #if !defined(WXAPIENTRY)

-        #ifdef __WATCOMC__
-            #define WXAPIENTRY PASCAL
-        #else
-            #define WXAPIENTRY FAR PASCAL
-        #endif
+        #define WXAPIENTRY WXFAR wxSTDCALL

     #endif
 
     #define IMPLEMENT_WXWIN_MAIN \
     #endif
 
     #define IMPLEMENT_WXWIN_MAIN \