made wxStringInputStream::GetSize() public instead of protected

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

diff --git a/include/wx/app.h b/include/wx/app.h
index c541b9015a7cd182880fdf207eee4b4d6a33a359..d4648e873d2d58853740a7141341b301ffddff96 100644 (file)
--- a/include/wx/app.h
+++ b/include/wx/app.h
@@ -21,23 +21,35 @@
 
 #if wxUSE_GUI
     #include "wx/window.h"  // for wxTopLevelWindows
 
 #if wxUSE_GUI
     #include "wx/window.h"  // for wxTopLevelWindows

+
+    #include "wx/vidmode.h"

 #endif // wxUSE_GUI
 
 #include "wx/build.h"
 #include "wx/init.h"        // we must declare wxEntry()
 
 #endif // wxUSE_GUI
 
 #include "wx/build.h"
 #include "wx/init.h"        // we must declare wxEntry()
 

-class WXDLLIMPEXP_CORE wxApp;
+class WXDLLIMPEXP_BASE wxAppConsole;

 class WXDLLIMPEXP_BASE wxAppTraits;
 class WXDLLIMPEXP_BASE wxCmdLineParser;
 class WXDLLIMPEXP_BASE wxLog;
 class WXDLLIMPEXP_BASE wxMessageOutput;
 
 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;
+#endif
+

 // ----------------------------------------------------------------------------
 // typedefs
 // ----------------------------------------------------------------------------
 
 // the type of the function used to create a wxApp object on program start up
 // ----------------------------------------------------------------------------
 // typedefs
 // ----------------------------------------------------------------------------
 
 // the type of the function used to create a wxApp object on program start up

-typedef wxApp* (*wxAppInitializerFunction)();
+typedef wxAppConsole* (*wxAppInitializerFunction)();

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


@@ -49,32 +61,6 @@ enum
     wxPRINT_POSTSCRIPT = 2
 };
 
     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 WXDLLIMPEXP_CORE 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 // wxUSE_GUI
-

 // ----------------------------------------------------------------------------
 // wxAppConsole: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxAppConsole: wxApp for non-GUI applications
 // ----------------------------------------------------------------------------


@@ -106,7 +92,7 @@ public:
     // class OnInit() to do it.
     virtual bool OnInit();
 
     // class OnInit() to do it.
     virtual bool OnInit();
 

-    // this is here only temproary hopefully (FIXME)
+    // this is here only temporary hopefully (FIXME)

     virtual bool OnInitGui() { return true; }
 
     // This is the replacement for the normal main(): all program work should
     virtual bool OnInitGui() { return true; }
 
     // This is the replacement for the normal main(): all program work should


@@ -130,6 +116,20 @@ public:
     // crash.
     virtual void OnFatalException() { }
 
     // 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();
 
     // Called from wxExit() function, should terminate the application a.s.a.p.
     virtual void Exit();
 


@@ -169,19 +169,21 @@ public:
 
 #if wxUSE_CMDLINE_PARSER
     // this one is called from OnInit() to add all supported options
 
 #if wxUSE_CMDLINE_PARSER
     // this one is called from OnInit() to add all supported options

-    // to the given parser
+    // to the given parser (don't forget to call the base class version if you
+    // override it!)

     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 
     virtual void OnInitCmdLine(wxCmdLineParser& parser);
 

-    // called after successfully parsing the command line, return TRUE
-    // to continue and FALSE to exit
+    // called after successfully parsing the command line, return true
+    // to continue and false to exit (don't forget to call the base class
+    // version if you override it!)

     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 
     virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
 

-    // called if "--help" option was specified, return TRUE to continue
-    // and FALSE to exit
+    // called if "--help" option was specified, return true to continue
+    // and false to exit

     virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
 
     // called if incorrect command line options were given, return
     virtual bool OnCmdLineHelp(wxCmdLineParser& parser);
 
     // called if incorrect command line options were given, return

-    // FALSE to abort and TRUE to continue
+    // false to abort and true to continue

     virtual bool OnCmdLineError(wxCmdLineParser& parser);
 #endif // wxUSE_CMDLINE_PARSER
 
     virtual bool OnCmdLineError(wxCmdLineParser& parser);
 #endif // wxUSE_CMDLINE_PARSER
 


@@ -226,6 +228,17 @@ public:
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 
     // had been already processed or won't be processed at all, respectively
     virtual int FilterEvent(wxEvent& event);
 

+#if wxUSE_EXCEPTIONS
+    // call the specified handler on the given object with the given event
+    //
+    // this method only exists to allow catching the exceptions thrown by any
+    // event handler, it would lead to an extra (useless) virtual function call
+    // if the exceptions were not used, so it doesn't even exist in that case
+    virtual void HandleEvent(wxEvtHandler *handler,
+                             wxEventFunction func,
+                             wxEvent& event) const;
+#endif // wxUSE_EXCEPTIONS
+

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


@@ -258,8 +271,14 @@ public:
     // 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
     // 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);
-
+    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
     // -------------------------------
 
     // implementation only from now on
     // -------------------------------


@@ -270,6 +289,13 @@ public:
     static wxAppInitializerFunction GetInitializerFunction()
         { return ms_appInitFn; }
 
     static wxAppInitializerFunction GetInitializerFunction()
         { return ms_appInitFn; }
 

+    // accessors for ms_appInstance field (external code might wish to modify
+    // it, this is why we provide a setter here as well, but you should really
+    // know what you're doing if you call it), wxTheApp is usually used instead
+    // of GetInstance()
+    static wxAppConsole *GetInstance() { return ms_appInstance; }
+    static void SetInstance(wxAppConsole *app) { ms_appInstance = app; }
+

 
     // command line arguments (public for backwards compatibility)
     int      argc;
 
     // command line arguments (public for backwards compatibility)
     int      argc;


@@ -284,6 +310,10 @@ protected:
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 
     // function used for dynamic wxApp creation
     static wxAppInitializerFunction ms_appInitFn;
 

+    // the one and only global application object
+    static wxAppConsole *ms_appInstance;
+
+

     // application info (must be set from the user code)
     wxString m_vendorName,      // vendor name (ACME Inc)
              m_appName,         // app name
     // application info (must be set from the user code)
     wxString m_vendorName,      // vendor name (ACME Inc)
              m_appName,         // app name


@@ -334,6 +364,9 @@ public:
         // Override: rarely in GUI applications, always in console ones.
     virtual int OnRun();
 
         // Override: rarely in GUI applications, always in console ones.
     virtual int OnRun();
 

+        // a matching function for OnInit()
+    virtual int OnExit();
+

         // very last clean up function
         //
         // Override: very rarely
         // very last clean up function
         //
         // Override: very rarely


@@ -344,48 +377,54 @@ public:
     // -----------------------------------------------------------------
 
         // execute the main GUI loop, the function returns when the loop ends
     // -----------------------------------------------------------------
 
         // execute the main GUI loop, the function returns when the loop ends

-    virtual int MainLoop() = 0;
+    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!)
 
         // 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() = 0;
-
-        // returns TRUE if the program is initialized
-    virtual bool Initialized() = 0;
+    virtual void ExitMainLoop();

 
 

-        // returns TRUE if there are unprocessed events in the event queue
-    virtual bool Pending() = 0;
+        // 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
 
         // process the first event in the event queue (blocks until an event

-        // apperas if there are none currently)
-    virtual void Dispatch() = 0;
+        // 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
         //
         // it is an error to call Yield() recursively unless the value of
 
         // process all currently pending events right now
         //
         // it is an error to call Yield() recursively unless the value of

-        // onlyIfNeeded is TRUE
+        // 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!
         //
         // 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;
+    virtual bool Yield(bool onlyIfNeeded = false) = 0;

 
         // this virtual function is called in the GUI mode when the application
         // becomes idle and normally just sends wxIdleEvent to all interested
         // parties
         //
 
         // this virtual function is called in the GUI mode 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() = 0;
+        // it should return true if more idle events are needed, false if not
+    virtual bool ProcessIdle();
+
+        // Send idle event to window and all subwindows
+        // 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
     // --------------------------
 
 
 
     // top level window functions
     // --------------------------
 

-        // return TRUE if our app has focus
+        // return true if our app has focus

     virtual bool IsActive() const { return m_isActive; }
 
         // set the "main" top level window
     virtual bool IsActive() const { return m_isActive; }
 
         // set the "main" top level window


@@ -407,7 +446,7 @@ public:
         // control the exit behaviour: by default, the program will exit the
         // main loop (and so, usually, terminate) when the last top-level
         // program window is deleted. Beware that if you disable this behaviour
         // control the exit behaviour: by default, the program will exit the
         // main loop (and so, usually, terminate) when the last top-level
         // program window is deleted. Beware that if you disable this behaviour

-        // (with SetExitOnFrameDelete(FALSE)), you'll have to call
+        // (with SetExitOnFrameDelete(false)), you'll have to call

         // ExitMainLoop() explicitly from somewhere.
     void SetExitOnFrameDelete(bool flag)
         { m_exitOnFrameDelete = flag ? Yes : No; }
         // ExitMainLoop() explicitly from somewhere.
     void SetExitOnFrameDelete(bool flag)
         { m_exitOnFrameDelete = flag ? Yes : No; }


@@ -420,11 +459,11 @@ public:
 
         // Get display mode that is used use. This is only used in framebuffer
         // wxWin ports (such as wxMGL).
 
         // Get display mode that is used use. This is only used in framebuffer
         // wxWin ports (such as wxMGL).

-    virtual wxDisplayModeInfo GetDisplayMode() const { return wxDisplayModeInfo(); }
+    virtual wxVideoMode GetDisplayMode() const { return wxVideoMode(); }

         // Set display mode to use. This is only used in framebuffer wxWin
         // ports (such as wxMGL). This method should be called from
         // wxApp::OnInitGui
         // 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; }
+    virtual bool SetDisplayMode(const wxVideoMode& 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; }


@@ -438,6 +477,14 @@ public:
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
 
     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 
 

+    // command line parsing (GUI-specific)
+    // ------------------------------------------------------------------------
+
+#if wxUSE_CMDLINE_PARSER
+    virtual bool OnCmdLineParsed(wxCmdLineParser& parser);
+    virtual void OnInitCmdLine(wxCmdLineParser& parser);
+#endif
+

     // miscellaneous other stuff
     // ------------------------------------------------------------------------
 
     // miscellaneous other stuff
     // ------------------------------------------------------------------------
 


@@ -446,6 +493,11 @@ public:
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 
     // deactivated
     virtual void SetActive(bool isActive, wxWindow *lastFocus);
 

+    // OBSOLETE: don't use, always returns true
+    //
+    // returns true if the program is successfully initialized
+    bool Initialized() { return true; }
+

 
 protected:
     // delete all objects in wxPendingDelete list
 
 protected:
     // delete all objects in wxPendingDelete list


@@ -455,6 +507,12 @@ protected:
     virtual wxAppTraits *CreateTraits();
 
 
     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;
 
     // the main top level window (may be NULL)
     wxWindow *m_topWindow;
 


@@ -469,7 +527,7 @@ protected:
         Yes
     } m_exitOnFrameDelete;
 
         Yes
     } m_exitOnFrameDelete;
 

-    // TRUE if the apps whats to use the best visual on systems where
+    // 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;
 
     // more than one are available (Sun, SGI, XFree86 4.0 ?)
     bool m_useBestVisual;
 


@@ -505,21 +563,24 @@ protected:
         #include "wx/os2/app.h"
     #endif
 #else // !GUI
         #include "wx/os2/app.h"
     #endif
 #else // !GUI

-    // can't use typedef because wxApp forward declared as a class
-    class WXDLLIMPEXP_BASE wxApp : public wxAppConsole
-    {
-    };
+    // allow using just wxApp (instead of wxAppConsole) in console programs
+    typedef wxAppConsole wxApp;

 #endif // GUI/!GUI
 
 // ----------------------------------------------------------------------------
 // the global data
 // ----------------------------------------------------------------------------
 
 #endif // GUI/!GUI
 
 // ----------------------------------------------------------------------------
 // the global data
 // ----------------------------------------------------------------------------
 

-// the one and only application object - use of wxTheApp in application code
-// is discouraged, consider using DECLARE_APP() after which you may call
-// wxGetApp() which will return the object of the correct type (i.e. MyApp and
-// not wxApp)
-WXDLLIMPEXP_DATA_BASE(extern wxApp*) wxTheApp;
+// for compatibility, we define this macro to access the global application
+// object of type wxApp
+//
+// note that instead of using of wxTheApp in application code you should
+// consider using DECLARE_APP() after which you may call wxGetApp() which will
+// return the object of the correct type (i.e. MyApp and not wxApp)
+//
+// 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())

 
 // ----------------------------------------------------------------------------
 // global functions
 
 // ----------------------------------------------------------------------------
 // global functions


@@ -552,33 +613,17 @@ public:
         { wxApp::SetInitializerFunction(fn); }
 };
 
         { wxApp::SetInitializerFunction(fn); }
 };
 

-// Here's a macro you can use if your compiler really, really wants main() to
-// be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
-// code if required.
+// the code below defines a IMPLEMENT_WXWIN_MAIN macro which you can use if
+// your compiler really, really wants main() to be in your main program (e.g.
+// hello.cpp). Now IMPLEMENT_APP should add this code if required.

 
 

-#if !wxUSE_GUI || !defined(__WXMSW__)
-    #define IMPLEMENT_WXWIN_MAIN                                              \
+#define IMPLEMENT_WXWIN_MAIN_CONSOLE \

         int main(int argc, char **argv) { return wxEntry(argc, argv); }
         int main(int argc, char **argv) { return wxEntry(argc, argv); }

-#elif defined(__WXMSW__) && defined(WXUSINGDLL)
-    // we need HINSTANCE declaration to define WinMain()
-    #include <windows.h>
-    #include "wx/msw/winundef.h"
-
-    #define IMPLEMENT_WXWIN_MAIN \
-        extern int wxEntry(HINSTANCE hInstance,                               \
-                           HINSTANCE hPrevInstance = NULL,                    \
-                           char *pCmdLine = NULL,                             \
-                           int nCmdShow = SW_NORMAL);                         \
-        extern "C" int WINAPI WinMain(HINSTANCE hInstance,                    \
-                                      HINSTANCE hPrevInstance,                \
-                                      char *lpCmdLine,                        \
-                                      int nCmdShow)                           \
-        {                                                                     \
-            return wxEntry(hInstance, hPrevInstance, lpCmdLine, nCmdShow);    \
-        }
-#else
-    #define IMPLEMENT_WXWIN_MAIN
-#endif
+
+// port-specific header could have defined it already in some special wau
+#ifndef IMPLEMENT_WXWIN_MAIN
+    #define IMPLEMENT_WXWIN_MAIN IMPLEMENT_WXWIN_MAIN_CONSOLE
+#endif // defined(IMPLEMENT_WXWIN_MAIN)

 
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"
 
 #ifdef __WXUNIVERSAL__
     #include "wx/univ/theme.h"


@@ -593,9 +638,10 @@ 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()                                                    \
+    wxAppConsole *wxCreateApp()                                             \

     {                                                                       \
     {                                                                       \

-        wxApp::CheckBuildOptions(wxBuildOptions());                         \
+        wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE,         \
+                                        "your program");                    \

         return new appname;                                                 \
     }                                                                       \
     wxAppInitializer                                                        \
         return new appname;                                                 \
     }                                                                       \
     wxAppInitializer                                                        \


@@ -614,6 +660,11 @@ public:
     IMPLEMENT_APP_NO_THEMES(appname)        \
     IMPLEMENT_WX_THEME_SUPPORT
 
     IMPLEMENT_APP_NO_THEMES(appname)        \
     IMPLEMENT_WX_THEME_SUPPORT
 

+// Same as IMPLEMENT_APP(), but for console applications.
+#define IMPLEMENT_APP_CONSOLE(appname)      \
+    IMPLEMENT_APP_NO_MAIN(appname)          \
+    IMPLEMENT_WXWIN_MAIN_CONSOLE
+

 // this macro can be used multiple times and just allows you to use wxGetApp()
 // function
 #define DECLARE_APP(appname) extern appname& wxGetApp();
 // this macro can be used multiple times and just allows you to use wxGetApp()
 // function
 #define DECLARE_APP(appname) extern appname& wxGetApp();