include/wx/stubs/app.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        app.h
   3 // Purpose:     wxApp class
   4 // Author:      AUTHOR
   5 // Modified by:
   6 // Created:     ??/??/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) AUTHOR
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_APP_H_
  13 #define _WX_APP_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "app.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/object.h"
  21 #include "wx/gdicmn.h"
  22 #include "wx/event.h"
  23
  24 class WXDLLEXPORT wxFrame;
  25 class WXDLLEXPORT wxWindow;
  26 class WXDLLEXPORT wxApp ;
  27 class WXDLLEXPORT wxKeyEvent;
  28 class WXDLLEXPORT wxLog;
  29
  30 #define wxPRINT_WINDOWS         1
  31 #define wxPRINT_POSTSCRIPT      2
  32
  33 WXDLLEXPORT_DATA(extern wxApp*) wxTheApp;
  34
  35 // Force an exit from main loop
  36 void WXDLLEXPORT wxExit();
  37
  38 // Yield to other apps/messages
  39 bool WXDLLEXPORT wxYield();
  40
  41 // Represents the application. Derive OnInit and declare
  42 // a new App object to start application
  43 class WXDLLEXPORT wxApp: public wxEvtHandler
  44 {
  45   DECLARE_DYNAMIC_CLASS(wxApp)
  46   wxApp();
  47   inline ~wxApp() {}
  48
  49   static void SetInitializerFunction(wxAppInitializerFunction fn) { m_appInitFn = fn; }
  50   static wxAppInitializerFunction GetInitializerFunction() { return m_appInitFn; }
  51
  52   virtual int MainLoop();
  53   void ExitMainLoop();
  54   bool Initialized();
  55   virtual bool Pending() ;
  56   virtual void Dispatch() ;
  57
  58   void OnIdle(wxIdleEvent& event);
  59
  60 // Generic
  61   virtual bool OnInit() { return FALSE; };
  62
  63   // No specific tasks to do here.
  64   virtual bool OnInitGui() { return TRUE; }
  65
  66   // Called to set off the main loop
  67   virtual int OnRun() { return MainLoop(); };
  68   virtual int OnExit() { return 0; }
  69
  70   /** Returns the standard icons for the msg dialogs, implemented in
  71       src/generic/msgdlgg.cpp and src/gtk/app.cpp. */
  72   virtual wxIcon GetStdIcon(int which) const;
  73
  74   inline void SetPrintMode(int mode) { m_printMode = mode; }
  75   inline int GetPrintMode() const { return m_printMode; }
  76
  77   inline void SetExitOnFrameDelete(bool flag) { m_exitOnFrameDelete = flag; }
  78   inline bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
  79
  80   inline wxString GetAppName() const {
  81       if (m_appName != "")
  82         return m_appName;
  83       else return m_className;
  84     }
  85
  86   inline void SetAppName(const wxString& name) { m_appName = name; };
  87   inline wxString GetClassName() const { return m_className; }
  88   inline void SetClassName(const wxString& name) { m_className = name; }
  89
  90   void SetVendorName(const wxString& vendorName) { m_vendorName = vendorName; }
  91   const wxString& GetVendorName() const { return m_vendorName; }
  92
  93   wxWindow *GetTopWindow() const ;
  94   inline void SetTopWindow(wxWindow *win) { m_topWindow = win; }
  95
  96   inline void SetWantDebugOutput(bool flag) { m_wantDebugOutput = flag; }
  97   inline bool GetWantDebugOutput() { return m_wantDebugOutput; }
  98
  99   // Send idle event to all top-level windows.
 100   // Returns TRUE if more idle time is requested.
 101   bool SendIdleEvents();
 102
 103   // Send idle event to window and all subwindows
 104   // Returns TRUE if more idle time is requested.
 105   bool SendIdleEvents(wxWindow* win);
 106
 107   // Windows only, but for compatibility...
 108   inline void SetAuto3D(bool flag) { m_auto3D = flag; }
 109   inline bool GetAuto3D() const { return m_auto3D; }
 110
 111   // Creates a log object
 112   virtual wxLog* CreateLogTarget();
 113
 114 public:
 115   // Will always be set to the appropriate, main-style values.
 116   int                   argc;
 117   char **               argv;
 118
 119 protected:
 120   bool                  m_wantDebugOutput ;
 121   wxString              m_className;
 122   wxString              m_appName,
 123                         m_vendorName;
 124   wxWindow *            m_topWindow;
 125   bool                  m_exitOnFrameDelete;
 126   bool                  m_showOnInit;
 127   int                   m_printMode; // wxPRINT_WINDOWS, wxPRINT_POSTSCRIPT
 128   bool                  m_auto3D ;   // Always use 3D controls, except
 129                                  // where overriden
 130   static wxAppInitializerFunction       m_appInitFn;
 131
 132 public:
 133
 134   // Implementation
 135   static bool Initialize();
 136   static void CleanUp();
 137
 138   void DeletePendingObjects();
 139   bool ProcessIdle();
 140
 141 public:
 142   static long           sm_lastMessageTime;
 143   int                   m_nCmdShow;
 144
 145 protected:
 146   bool                  m_keepGoing ;
 147
 148 DECLARE_EVENT_TABLE()
 149 };
 150
 151 // TODO: add platform-specific arguments
 152 int WXDLLEXPORT wxEntry( int argc, char *argv[] );
 153
 154 #endif
 155     // _WX_APP_H_
 156