]> git.saurik.com Git - wxWidgets.git/blob - include/wx/mac/app.h
added and documented wxDEFINE_SCOPED_PTR_TYPE; improved docs a bit
[wxWidgets.git] / include / wx / mac / 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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
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 wxWindowMac;
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 wxAppBase
44 {
45 DECLARE_DYNAMIC_CLASS(wxApp)
46
47 wxApp();
48 virtual ~wxApp() {}
49
50 virtual int MainLoop();
51 virtual void ExitMainLoop();
52 virtual bool Initialized();
53 virtual bool Pending() ;
54 virtual void Dispatch() ;
55
56 virtual void Exit();
57
58 virtual bool Yield(bool onlyIfNeeded = FALSE);
59 virtual void WakeUpIdle();
60
61 virtual void SetPrintMode(int mode) { m_printMode = mode; }
62 virtual int GetPrintMode() const { return m_printMode; }
63
64 #if wxUSE_GUI
65 // setting up all MacOS Specific Event-Handlers etc
66 virtual bool OnInitGui();
67 #endif // wxUSE_GUI
68 // implementation only
69 void OnIdle(wxIdleEvent& event);
70 void OnEndSession(wxCloseEvent& event);
71 void OnQueryEndSession(wxCloseEvent& event);
72
73 // Windows only, but for compatibility...
74 inline void SetAuto3D(bool flag) { m_auto3D = flag; }
75 inline bool GetAuto3D() const { return m_auto3D; }
76
77 protected:
78 bool m_showOnInit;
79 int m_printMode; // wxPRINT_WINDOWS, wxPRINT_POSTSCRIPT
80 bool m_auto3D ; // Always use 3D controls, except
81 // where overriden
82 public:
83
84 // Implementation
85 virtual bool Initialize(int& argc, wxChar **argv);
86 virtual void CleanUp();
87
88 bool IsExiting() { return !m_keepGoing ; }
89 #if TARGET_CARBON
90 // the installed application event handler
91 WXEVENTHANDLERREF MacGetEventHandler() { return m_macEventHandler ; }
92 WXEVENTHANDLERREF MacGetCurrentEventHandlerCallRef() { return m_macCurrentEventHandlerCallRef ; }
93 void MacSetCurrentEvent( WXEVENTREF event , WXEVENTHANDLERCALLREF handler )
94 { m_macCurrentEvent = event ; m_macCurrentEventHandlerCallRef = handler ; }
95 #endif
96
97 public:
98 static long sm_lastMessageTime;
99 static wxWindow* s_captureWindow ;
100 static int s_lastMouseDown ; // 0 = none , 1 = left , 2 = right
101 static WXHRGN s_macCursorRgn ;
102 static long s_lastModifiers ;
103
104 int m_nCmdShow;
105
106 private:
107 bool m_keepGoing ;
108
109 // mac specifics
110 #if TARGET_CARBON
111 WXEVENTHANDLERREF m_macEventHandler ;
112 WXEVENTHANDLERCALLREF m_macCurrentEventHandlerCallRef ;
113 #endif
114 WXEVENTREF m_macCurrentEvent ;
115
116 public:
117 static bool s_macSupportPCMenuShortcuts ;
118 static long s_macAboutMenuItemId ;
119 static long s_macPreferencesMenuItemId ;
120 static long s_macExitMenuItemId ;
121 static wxString s_macHelpMenuTitleName ;
122
123 static bool s_macHasAppearance ;
124 static long s_macAppearanceVersion ;
125 static bool s_macHasNavigation ;
126 static bool s_macNavigationVersion ;
127 static bool s_macHasWindowManager ;
128 static long s_macWindowManagerVersion ;
129 static bool s_macHasMenuManager ;
130 static long s_macMenuManagerVersion ;
131 static bool s_macHasDialogManager ;
132 static long s_macDialogManagerVersion ;
133
134 WXHRGN m_macCursorRgn ;
135 WXHRGN m_macSleepRgn ;
136 WXHRGN m_macHelpRgn ;
137
138 virtual void MacSuspend( bool convertClipboard ) ;
139 virtual void MacResume( bool convertClipboard ) ;
140 virtual void MacConvertPrivateToPublicScrap() ;
141 virtual void MacConvertPublicToPrivateScrap() ;
142
143 void MacDoOneEvent() ;
144 WXEVENTREF MacGetCurrentEvent() { return m_macCurrentEvent ; }
145 void MacHandleOneEvent( WXEVENTREF ev ) ;
146 #if !TARGET_CARBON
147 virtual void MacHandleMenuSelect( int menuid , int menuitem ) ;
148 virtual void MacHandleMouseUpEvent( WXEVENTREF ev ) ;
149 virtual void MacHandleOSEvent( WXEVENTREF ev ) ;
150 virtual void MacHandleDiskEvent( WXEVENTREF ev ) ;
151 virtual void MacHandleActivateEvent( WXEVENTREF ev ) ;
152 virtual void MacHandleUpdateEvent( WXEVENTREF ev ) ;
153 virtual void MacHandleMouseDownEvent( WXEVENTREF ev ) ;
154
155 void MacHandleModifierEvents( WXEVENTREF ev ) ;
156
157 virtual void MacHandleKeyDownEvent( WXEVENTREF ev ) ;
158 virtual void MacHandleKeyUpEvent( WXEVENTREF ev ) ;
159 virtual void MacHandleHighLevelEvent( WXEVENTREF ev ) ;
160
161 #else
162 virtual void MacHandleMouseMovedEvent( wxInt32 x , wxInt32 y ,wxUint32 modifiers , long timestamp ) ;
163 #endif
164
165 void MacHandleMenuCommand( wxUint32 command ) ;
166 bool MacSendKeyDownEvent( wxWindow* focus , long keyval , long modifiers , long when , short wherex , short wherey ) ;
167 bool MacSendKeyUpEvent( wxWindow* focus , long keyval , long modifiers , long when , short wherex , short wherey ) ;
168
169 virtual short MacHandleAEODoc(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
170 virtual short MacHandleAEPDoc(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
171 virtual short MacHandleAEOApp(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
172 virtual short MacHandleAEQuit(const WXAPPLEEVENTREF event , WXAPPLEEVENTREF reply) ;
173
174 // in response of an open-document apple event
175 virtual void MacOpenFile(const wxString &fileName) ;
176 // in response of a print-document apple event
177 virtual void MacPrintFile(const wxString &fileName) ;
178 // in response of a open-application apple event
179 virtual void MacNewFile() ;
180
181 DECLARE_EVENT_TABLE()
182 };
183
184 class WXDLLEXPORT wxStAppResource
185 {
186 public:
187 wxStAppResource() ;
188 ~wxStAppResource() ;
189
190 // opaque pointer for CFragInitBlock
191 static void OpenSharedLibraryResource(const void *) ;
192 static void CloseSharedLibraryResource() ;
193
194 private:
195 short m_currentRefNum ;
196 } ;
197
198 #endif
199 // _WX_APP_H_
200