include/wx/osx/app.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        app.h
   3 // Purpose:     wxApp class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_APP_H_
  13 #define _WX_APP_H_
  14
  15 #include "wx/defs.h"
  16 #include "wx/object.h"
  17 #include "wx/gdicmn.h"
  18 #include "wx/event.h"
  19
  20 class WXDLLIMPEXP_FWD_CORE wxFrame;
  21 class WXDLLIMPEXP_FWD_CORE wxWindowMac;
  22 class WXDLLIMPEXP_FWD_CORE wxApp ;
  23 class WXDLLIMPEXP_FWD_CORE wxKeyEvent;
  24 class WXDLLIMPEXP_FWD_BASE wxLog;
  25
  26 // Force an exit from main loop
  27 void WXDLLIMPEXP_CORE wxExit();
  28
  29 // Yield to other apps/messages
  30 bool WXDLLIMPEXP_CORE wxYield();
  31
  32 // Represents the application. Derive OnInit and declare
  33 // a new App object to start application
  34 class WXDLLIMPEXP_CORE wxApp: public wxAppBase
  35 {
  36     DECLARE_DYNAMIC_CLASS(wxApp)
  37
  38     wxApp();
  39     virtual ~wxApp() {}
  40
  41     virtual bool Yield(bool onlyIfNeeded = FALSE);
  42     virtual void WakeUpIdle();
  43
  44     virtual void SetPrintMode(int mode) { m_printMode = mode; }
  45     virtual int GetPrintMode() const { return m_printMode; }
  46
  47     // calling OnInit with an auto-release pool ready ...
  48     virtual bool CallOnInit();
  49 #if wxUSE_GUI
  50     // setting up all MacOS Specific Event-Handlers etc
  51     virtual bool OnInitGui();
  52 #endif // wxUSE_GUI
  53
  54     virtual bool ProcessIdle();
  55
  56     // implementation only
  57     void OnIdle(wxIdleEvent& event);
  58     void OnEndSession(wxCloseEvent& event);
  59     void OnQueryEndSession(wxCloseEvent& event);
  60
  61 protected:
  62     int                   m_printMode; // wxPRINT_WINDOWS, wxPRINT_POSTSCRIPT
  63
  64 public:
  65
  66     static bool           sm_isEmbedded;
  67     // Implementation
  68     virtual bool Initialize(int& argc, wxChar **argv);
  69     virtual void CleanUp();
  70
  71     // the installed application event handler
  72     WXEVENTHANDLERREF    MacGetEventHandler() { return m_macEventHandler ; }
  73     WXEVENTHANDLERREF    MacGetCurrentEventHandlerCallRef() { return m_macCurrentEventHandlerCallRef ; }
  74     void MacSetCurrentEvent( WXEVENTREF event , WXEVENTHANDLERCALLREF handler )
  75     { m_macCurrentEvent = event ; m_macCurrentEventHandlerCallRef = handler ; }
  76
  77     // adding a CFType object to be released only at the end of the current event cycle (increases the
  78     // refcount of the object passed), needed in case we are in the middle of an event concering an object
  79     // we want to delete and cannot do it immediately
  80     // TODO change semantics to be in line with cocoa (make autrelease NOT increase the count)
  81     void                  MacAddToAutorelease( void* cfrefobj );
  82 public:
  83     static wxWindow*      s_captureWindow ;
  84     static long           s_lastModifiers ;
  85
  86     int                   m_nCmdShow;
  87
  88 private:
  89     // mac specifics
  90     virtual bool        DoInitGui();
  91     virtual void        DoCleanUp();
  92
  93     WXEVENTHANDLERREF     m_macEventHandler ;
  94     WXEVENTHANDLERCALLREF m_macCurrentEventHandlerCallRef ;
  95     WXEVENTREF            m_macCurrentEvent ;
  96     CFRunLoopSourceRef    m_macEventPosted ;
  97
  98 public:
  99     static long           s_macAboutMenuItemId ;
 100     static long           s_macPreferencesMenuItemId ;
 101     static long           s_macExitMenuItemId ;
 102     static wxString       s_macHelpMenuTitleName ;
 103
 104     WXEVENTREF            MacGetCurrentEvent() { return m_macCurrentEvent ; }
 105
 106     // For embedded use. By default does nothing.
 107     virtual void          MacHandleUnhandledEvent( WXEVENTREF ev );
 108
 109     bool    MacSendKeyDownEvent( wxWindow* focus , long keyval , long modifiers , long when , short wherex , short wherey , wxChar uniChar ) ;
 110     bool    MacSendKeyUpEvent( wxWindow* focus , long keyval , long modifiers , long when , short wherex , short wherey , wxChar uniChar ) ;
 111     bool    MacSendCharEvent( wxWindow* focus , long keymessage , long modifiers , long when , short wherex , short wherey , wxChar uniChar ) ;
 112     void    MacCreateKeyEvent( wxKeyEvent& event, wxWindow* focus , long keymessage , long modifiers , long when , short wherex , short wherey , wxChar uniChar ) ;
 113 #if wxOSX_USE_CARBON
 114     // we only have applescript on these
 115     virtual short         MacHandleAEODoc(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
 116     virtual short         MacHandleAEGURL(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
 117     virtual short         MacHandleAEPDoc(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
 118     virtual short         MacHandleAEOApp(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
 119     virtual short         MacHandleAEQuit(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
 120     virtual short         MacHandleAERApp(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
 121 #endif
 122     // in response of an open-document apple event
 123     virtual void         MacOpenFile(const wxString &fileName) ;
 124     // in response of a get-url apple event
 125     virtual void         MacOpenURL(const wxString &url) ;
 126     // in response of a print-document apple event
 127     virtual void         MacPrintFile(const wxString &fileName) ;
 128     // in response of a open-application apple event
 129     virtual void         MacNewFile() ;
 130     // in response of a reopen-application apple event
 131     virtual void         MacReopenApp() ;
 132
 133     // Hide the application windows the same as the system hide command would do it.
 134     void MacHideApp();
 135
 136     DECLARE_EVENT_TABLE()
 137 };
 138
 139 #endif
 140     // _WX_APP_H_
 141