#include "wx/event.h" // for the base class
#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;
+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 WXDLLEXPORT wxEventLoop;
- struct WXDLLIMPEXP_CORE wxVideoMode;
+ struct WXDLLIMPEXP_FWD_CORE wxVideoMode;
#endif
// ----------------------------------------------------------------------------
};
// ----------------------------------------------------------------------------
-// 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
// 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.
}
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().Capitalize()
+ : 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; }
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
// ----------------------
// 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();
+ // this function provides safer access to traits object than
+ // wxTheApp->GetTraits() during startup or termination when the global
+ // application object itself may be unavailable
+ //
+ // of course, it still returns NULL in this case and the caller must check
+ // for it
+ static wxAppTraits *GetTraitsIfExists();
// event processing functions
// --------------------------
virtual int FilterEvent(wxEvent& event);
#if wxUSE_EXCEPTIONS
+ // execute the functor to handle the given event
+ //
+ // this is a generalization of HandleEvent() below and the base class
+ // implementation of CallEventHandler() still calls HandleEvent() for
+ // compatibility for functors which are just wxEventFunctions (i.e. methods
+ // of wxEvtHandler)
+ virtual void CallEventHandler(wxEvtHandler *handler,
+ wxEventFunctor& functor,
+ wxEvent& event) const;
+
// call the specified handler on the given object with the given event
//
// this method only exists to allow catching the exceptions thrown by any
wxEvent& event) const;
// 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 or use OnExceptionInMainLoop()
- virtual void OnUnhandledException() { }
+ // 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
- // process all events in the wxPendingEvents list -- it is necessary to
- // call this function to process posted events. This happens during each
+ // 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 wxHandlersWithPendingEvents 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();
- // this is just a convenience: by providing its implementation here we
- // avoid #ifdefs in the code using it
- static bool IsMainLoopRunning() { return false; }
+ // 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
// -----------------
// 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
// 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
// ----------------------------------------------------------------------------
// 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
- static bool IsMainLoopRunning()
- {
- wxAppBase *app = wx_static_cast(wxAppBase *, GetInstance());
- return app && app->m_mainLoop != NULL;
- }
- // 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
//
// with _extreme_ care or, better, don't use at all!
virtual bool Yield(bool onlyIfNeeded = false) = 0;
+ // returns true if the main thread is inside a Yield() call
+ bool IsYielding() const
+ { return m_isInsideYield; }
+
// this virtual function is called in the GUI mode when the application
// becomes idle and normally just sends wxIdleEvent to all interested
// parties
virtual bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
-#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
-
-
// top level window functions
// --------------------------
virtual bool SetDisplayMode(const wxVideoMode& WXUNUSED(info)) { return true; }
// set use of best visual flag (see below)
- void SetUseBestVisual( bool flag, bool forceTrueColour = false )
+ void SetUseBestVisual( bool flag, bool forceTrueColour = false )
{ m_useBestVisual = flag; m_forceTrueColour = forceTrueColour; }
bool GetUseBestVisual() const { return m_useBestVisual; }
// 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)
// ------------------------------------------------------------------------
wxDEPRECATED( bool Initialized() );
#endif // WXWIN_COMPATIBILITY_2_6
- // perform standard OnIdle behaviour, ensure that this is always called
- void OnIdle(wxIdleEvent& event);
-
-
protected:
// delete all objects in wxPendingDelete list
void DeletePendingObjects();
virtual wxAppTraits *CreateTraits();
- // 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;
-
// the main top level window (may be NULL)
wxWindow *m_topWindow;
// does any of our windows have focus?
bool m_isActive;
+ bool m_isInsideYield;
DECLARE_NO_COPY_CLASS(wxAppBase)
};
inline bool wxAppBase::Initialized() { return true; }
#endif // WXWIN_COMPATIBILITY_2_6
-#endif // wxUSE_GUI
-
// ----------------------------------------------------------------------------
// now include the declaration of the real class
// ----------------------------------------------------------------------------
-#if wxUSE_GUI
- #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
+#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/osx/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
// ----------------------------------------------------------------------------
//
// 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 wx_static_cast(wxApp*, wxApp::GetInstance())
+#define wxTheApp static_cast<wxApp*>(wxApp::GetInstance())
// ----------------------------------------------------------------------------
// global functions
// ------------------------------------------------------
// Force an exit from main loop
-extern void WXDLLIMPEXP_BASE wxExit();
+WXDLLIMPEXP_BASE void 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();
+WXDLLIMPEXP_CORE bool wxYield();
+
+#endif // wx_YIELD_DECLARED
// Yield to other apps/messages
-extern void WXDLLIMPEXP_BASE wxWakeUpIdle();
+WXDLLIMPEXP_BASE void wxWakeUpIdle();
// ----------------------------------------------------------------------------
// macros for dynamic creation of the application object
wxAppInitializer \
wxTheAppInitializer((wxAppInitializerFunction) wxCreateApp); \
DECLARE_APP(appname) \
- appname& wxGetApp() { return *wx_static_cast(appname*, wxApp::GetInstance()); }
+ appname& wxGetApp() { return *static_cast<appname*>(wxApp::GetInstance()); }
// Same as IMPLEMENT_APP() normally but doesn't include themes support in
// wxUniversal builds
projects / wxWidgets.git / blobdiff