/////////////////////////////////////////////////////////////////////////////
-// 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
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
-// Copyright: (c) Julian Smart and Markus Holzem
+// Copyright: (c) Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_APP_H_BASE_
#define _WX_APP_H_BASE_
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(__APPLE__)
#pragma interface "appbase.h"
#endif
-// ----------------------------------------------------------------------------
-// typedefs
-// ----------------------------------------------------------------------------
-
-#if (defined(__WXMSW__) && !defined(__WXMICROWIN__)) || defined (__WXPM__)
- class WXDLLEXPORT wxApp;
- typedef wxApp* (*wxAppInitializerFunction)();
-#else
- // returning wxApp* won't work with gcc
- #include "wx/object.h"
-
- typedef wxObject* (*wxAppInitializerFunction)();
-#endif
-
-class WXDLLEXPORT wxCmdLineParser;
-
// ----------------------------------------------------------------------------
// headers we have to include here
// ----------------------------------------------------------------------------
#include "wx/window.h" // for wxTopLevelWindows
#endif // wxUSE_GUI
-#if wxUSE_LOG
- #include "wx/log.h"
+#if WXWIN_COMPATIBILITY_2_2
+ #include "wx/icon.h"
#endif
+#include "wx/build.h"
+
+class WXDLLEXPORT wxApp;
+class WXDLLEXPORT wxCmdLineParser;
+class WXDLLEXPORT wxLog;
+class WXDLLEXPORT wxMessageOutput;
+
+// ----------------------------------------------------------------------------
+// typedefs
+// ----------------------------------------------------------------------------
+
+// the type of the function used to create a wxApp object on program start up
+typedef wxApp* (*wxAppInitializerFunction)();
+
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
{
public:
wxDisplayModeInfo() : m_ok(FALSE) {}
- wxDisplayModeInfo(unsigned width, unsigned height, unsigned depth)
+ 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; }
class WXDLLEXPORT wxAppBase : public wxEvtHandler
{
+ DECLARE_NO_COPY_CLASS(wxAppBase)
+
public:
wxAppBase();
+ virtual ~wxAppBase();
// the virtual functions which may/must be overridden in the derived class
// -----------------------------------------------------------------------
//
// Override: rarely in GUI applications, always in console ones.
#if wxUSE_GUI
- virtual int OnRun() { return MainLoop(); };
+ virtual int OnRun();
#else // !GUI
virtual int OnRun() = 0;
#endif // wxUSE_GUI
// 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;
+
+ // 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;
#endif // wxUSE_GUI
// application info: name, description, vendor
// 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 disabel this (with
- // SetExitOnFrameDelete(FALSE)), you'll have to call ExitMainLoop()
- // explicitly from somewhere.
- void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
- bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
+ // program window is deleted. Beware that if you disable this behaviour
+ // (with SetExitOnFrameDelete(FALSE)), you'll have to call
+ // ExitMainLoop() explicitly from somewhere.
+ void SetExitOnFrameDelete(bool flag)
+ { m_exitOnFrameDelete = flag ? Yes : No; }
+ bool GetExitOnFrameDelete() const
+ { return m_exitOnFrameDelete == Yes; }
#endif // wxUSE_GUI
// user-defined class (default implementation creates a wxLogGui
// object) - this log object is used by default by all wxLogXXX()
// functions.
- virtual wxLog *CreateLogTarget()
- #if wxUSE_GUI && wxUSE_LOGGUI && !defined(__WXMICROWIN__)
- { return new wxLogGui; }
- #else // !GUI
- { return new wxLogStderr; }
- #endif // wxUSE_GUI
+ virtual wxLog *CreateLogTarget();
#endif // wxUSE_LOG
+ // similar to CreateLogTarget() but for the global wxMessageOutput
+ // object
+ virtual wxMessageOutput *CreateMessageOutput();
+
#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
- virtual wxIcon GetStdIcon(int which) const = 0;
+ virtual wxIcon GetStdIcon(int WXUNUSED(which)) const { return wxNullIcon; }
+#endif
// Get display mode that is used use. This is only used in framebuffer wxWin ports
// (such as wxMGL).
// (such as wxMGL). This method should be called from wxApp:OnInitGui
virtual bool SetDisplayMode(const wxDisplayModeInfo& WXUNUSED(info)) { return TRUE; }
- // VZ: what does this do exactly?
- 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; }
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)
+ //
+ // the arguments are the place where the assert occured, the text of the
+ // assert itself and the user-specified message
#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__
+ // 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
// -------------------------------
static wxAppInitializerFunction GetInitializerFunction()
{ return m_appInitFn; }
- // needed to avoid link errors
-#ifdef __DARWIN__
- virtual ~wxAppBase() { }
-#endif
-
// process all events in the wxPendingEvents list
virtual void ProcessPendingEvents();
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 TRUE, exit the main loop when the last top level window is deleted
- bool m_exitOnFrameDelete;
+ // if Yes, exit the main loop when the last top level window is deleted, if
+ // No don't do it and if Later -- only do it once we reach our OnRun()
+ //
+ // the explanation for using this strange scheme is given in appcmn.cpp
+ enum
+ {
+ Later = -1,
+ No,
+ Yes
+ } m_exitOnFrameDelete;
// TRUE if the apps whats to use the best visual on systems where
// more than one are available (Sun, SGI, XFree86 4.0 ?)
#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"
- #elif defined(__WXSTUBS__)
- #include "wx/stubs/app.h"
#endif
#else // !GUI
// can't use typedef because wxApp forward declared as a class
// be in your main program (e.g. hello.cpp). Now IMPLEMENT_APP should add this
// code if required.
-#if !wxUSE_GUI || defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMGL__)
+#if !wxUSE_GUI || defined(__WXMOTIF__) || defined(__WXGTK__) || defined(__WXPM__) || defined(__WXMGL__) || defined(__WXCOCOA__)
#define IMPLEMENT_WXWIN_MAIN \
- extern int wxEntry( int argc, char *argv[] ); \
- int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
-#elif defined(__WXMAC__) && defined(__UNIX__)
+ extern int wxEntry( int argc, char **argv ); \
+ int main(int argc, char **argv) { return wxEntry(argc, argv); }
+#elif defined(__WXMAC__)
// wxMac seems to have a specific wxEntry prototype
#define IMPLEMENT_WXWIN_MAIN \
- extern int wxEntry( int argc, char *argv[], bool enterLoop = 1 ); \
- int main(int argc, char *argv[]) { return wxEntry(argc, argv); }
+ extern int wxEntry( int argc, char **argv, bool enterLoop = TRUE ); \
+ int main(int argc, char **argv) { return wxEntry(argc, argv); }
#elif defined(__WXMSW__) && defined(WXUSINGDLL)
// NT defines APIENTRY, 3.x not
#if !defined(WXAPIENTRY)
// 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; }
projects / wxWidgets.git / blobdiff