include/wx/gtk/app.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        app.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling, Julian Smart
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef __GTKAPPH__
  11 #define __GTKAPPH__
  12
  13 #ifdef __GNUG__
  14 #pragma interface
  15 #endif
  16
  17 #include "wx/defs.h"
  18 #include "wx/window.h"
  19 #include "wx/frame.h"
  20
  21 //-----------------------------------------------------------------------------
  22 // classes
  23 //-----------------------------------------------------------------------------
  24
  25 class wxApp;
  26 class wxLog;
  27
  28 //-----------------------------------------------------------------------------
  29 // global data
  30 //-----------------------------------------------------------------------------
  31
  32 extern wxApp *wxTheApp;
  33
  34 //-----------------------------------------------------------------------------
  35 // global functions
  36 //-----------------------------------------------------------------------------
  37
  38 void wxExit(void);
  39 bool wxYield(void);
  40
  41 //-----------------------------------------------------------------------------
  42 // constants
  43 //-----------------------------------------------------------------------------
  44
  45 #define wxPRINT_WINDOWS         1
  46 #define wxPRINT_POSTSCRIPT      2
  47
  48 //-----------------------------------------------------------------------------
  49 // wxApp
  50 //-----------------------------------------------------------------------------
  51
  52 class wxApp: public wxEvtHandler
  53 {
  54   DECLARE_DYNAMIC_CLASS(wxApp)
  55
  56   public:
  57
  58     wxApp();
  59     ~wxApp();
  60
  61     static void SetInitializerFunction(wxAppInitializerFunction fn) { m_appInitFn = fn; }
  62     static wxAppInitializerFunction GetInitializerFunction() { return m_appInitFn; }
  63
  64     /* override for altering the way wxGTK intializes the GUI (palette/visual/colorcube).
  65      * under wxMSW, OnInitGui() does nothing by default. when overriding this method,
  66      * the code in it is likely to be platform dependent, otherwise use OnInit(). */
  67     virtual bool OnInitGui();
  68
  69     /* override to create top level frame, display splash screen etc. */
  70     virtual bool OnInit() { return FALSE; }
  71
  72     virtual int OnRun() { return MainLoop(); }
  73     virtual int OnExit() { return 0; }
  74
  75     wxWindow *GetTopWindow();
  76     void SetTopWindow( wxWindow *win );
  77
  78     virtual int MainLoop();
  79     void ExitMainLoop();
  80     bool Initialized();
  81     virtual bool Pending();
  82     virtual void Dispatch();
  83
  84     inline void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
  85     inline bool GetWantDebugOutput() { return m_wantDebugOutput; }
  86
  87     void OnIdle( wxIdleEvent &event );
  88     bool SendIdleEvents();
  89     bool SendIdleEvents( wxWindow* win );
  90
  91     inline wxString GetAppName() const
  92       { if (m_appName != "") return m_appName; else return m_className; }
  93     inline void SetAppName( const wxString& name ) { m_appName = name; }
  94
  95     inline wxString GetClassName() const { return m_className; }
  96     inline void SetClassName( const wxString& name ) { m_className = name; }
  97
  98     const wxString& GetVendorName() const { return m_vendorName; }
  99     void SetVendorName( const wxString& name ) { m_vendorName = name; }
 100
 101     inline void SetExitOnFrameDelete( bool flag ) { m_exitOnFrameDelete = flag; }
 102     inline bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }
 103
 104     void SetPrintMode( int WXUNUSED(mode) ) {}
 105     int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }
 106
 107     /* override this function to create default log target of arbitrary
 108      * user-defined classv (default implementation creates a wxLogGui object) */
 109     virtual wxLog *CreateLogTarget();
 110
 111   // implementation
 112
 113     static bool Initialize();
 114     static bool InitialzeVisual();
 115     static void CleanUp();
 116
 117     bool ProcessIdle();
 118 #if wxUSE_THREADS
 119     void ProcessPendingEvents();
 120 #endif
 121     void DeletePendingObjects();
 122
 123     /// This can be used to suppress the generation of Idle events.
 124     inline void SuppressIdleEvents(bool arg = TRUE) { m_suppressIdleEvents = arg; }
 125     inline bool GetSuppressIdleEvents() const { return m_suppressIdleEvents; }
 126
 127     bool            m_initialized;
 128     bool            m_exitOnFrameDelete;
 129     bool            m_wantDebugOutput;
 130     wxWindow       *m_topWindow;
 131
 132     gint            m_idleTag;
 133 #if wxUSE_THREADS
 134     gint            m_wakeUpTimerTag;
 135 #endif
 136     unsigned char  *m_colorCube;
 137
 138     int             argc;
 139     char          **argv;
 140
 141     wxString        m_vendorName;
 142     wxString        m_appName;
 143     wxString        m_className;
 144
 145     static wxAppInitializerFunction m_appInitFn;
 146  private:
 147     /// Set to TRUE while we are in wxYield().
 148     bool m_suppressIdleEvents;
 149   DECLARE_EVENT_TABLE()
 150 };
 151
 152 #endif // __GTKAPPH__