]> git.saurik.com Git - wxWidgets.git/blame - wxPython/src/_app.i
ComputeScaleAndOrigin not protected anymore
[wxWidgets.git] / wxPython / src / _app.i
CommitLineData
d14a1e28
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: _app.i
3// Purpose: SWIG interface for wxApp
4//
5// Author: Robin Dunn
6//
7// Created: 9-Aug-2003
8// RCS-ID: $Id$
9// Copyright: (c) 2003 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
13// Not a %module
14
15
16//---------------------------------------------------------------------------
17// TODOs:
18//
19// 1. Provide another app object that allows FilterEvent to be overloaded.
20// 2. Wrap wxAppTraits and allow wxApp::CreateTraits to be overloaded.
21//
22//---------------------------------------------------------------------------
23%newgroup;
24
25%{
26%}
27
28enum {
29 wxPYAPP_ASSERT_SUPPRESS = 1,
30 wxPYAPP_ASSERT_EXCEPTION = 2,
31 wxPYAPP_ASSERT_DIALOG = 4,
32 wxPYAPP_ASSERT_LOG = 8
33};
34
35enum
36{
37 wxPRINT_WINDOWS = 1,
38 wxPRINT_POSTSCRIPT = 2
39};
40
41
42
dce2bd22
RD
43DocStr(wxPyApp,
44"The ``wx.PyApp`` class is an *implementation detail*, please use the
d07d2bc9 45`wx.App` class (or some other derived class) instead.", "");
d14a1e28
RD
46
47class wxPyApp : public wxEvtHandler {
48public:
49
2b9048c5 50 %pythonAppend wxPyApp
69ac96fd
RD
51 "self._setCallbackInfo(self, PyApp, False)
52 self._setOORInfo(self, False)";
b39c3fa0 53 %typemap(out) wxPyApp*; // turn off this typemap
d14a1e28 54
856bf319 55 DocStr(wxPyApp,
d07d2bc9 56 "Create a new application object, starting the bootstrap process.", "");
d14a1e28
RD
57 %extend {
58 wxPyApp() {
59 wxPythonApp = new wxPyApp();
60 return wxPythonApp;
61 }
62 }
63
64 ~wxPyApp();
65
b39c3fa0
RD
66 // Turn it back on again
67 %typemap(out) wxPyApp* { $result = wxPyMake_wxObject($1, $owner); }
68
69
69ac96fd 70 void _setCallbackInfo(PyObject* self, PyObject* _class, bool incref);
d14a1e28 71
d14a1e28 72
6c3b4aae
RD
73 DocDeclStr(
74 wxString, GetAppName() const,
d07d2bc9 75 "Get the application name.", "");
6c3b4aae
RD
76 DocDeclStr(
77 void, SetAppName(const wxString& name),
dce2bd22 78 "Set the application name. This value may be used automatically by
d07d2bc9 79`wx.Config` and such.", "");
6c3b4aae
RD
80
81 DocDeclStr(
82 wxString, GetClassName() const,
d07d2bc9 83 "Get the application's class name.", "");
6c3b4aae
RD
84 DocDeclStr(
85 void, SetClassName(const wxString& name),
dce2bd22 86 "Set the application's class name. This value may be used for
d07d2bc9 87X-resources if applicable for the platform", "");
6c3b4aae
RD
88
89 DocDeclStr(
90 const wxString&, GetVendorName() const,
d07d2bc9 91 "Get the application's vendor name.", "");
6c3b4aae
RD
92 DocDeclStr(
93 void, SetVendorName(const wxString& name),
dce2bd22 94 "Set the application's vendor name. This value may be used
d07d2bc9 95automatically by `wx.Config` and such.", "");
6c3b4aae
RD
96
97
98 DocDeclStr(
99 wxAppTraits*, GetTraits(),
dce2bd22
RD
100 "Return (and create if necessary) the app traits object to which we
101delegate for everything which either should be configurable by the
102user (then he can change the default behaviour simply by overriding
103CreateTraits() and returning his own traits object) or which is
104GUI/console dependent as then wx.AppTraits allows us to abstract the
105differences behind the common facade.
106
d07d2bc9 107:todo: Add support for overriding CreateAppTraits in wxPython.", "");
6c3b4aae
RD
108
109
110 DocDeclStr(
111 virtual void, ProcessPendingEvents(),
dce2bd22
RD
112 "Process all events in the Pending Events list -- it is necessary to
113call this function to process posted events. This normally happens
d07d2bc9 114during each event loop iteration.", "");
6c3b4aae
RD
115
116
117 DocDeclStr(
a72f4631 118 virtual bool, Yield(bool onlyIfNeeded = false),
dce2bd22
RD
119 "Process all currently pending events right now, instead of waiting
120until return to the event loop. It is an error to call ``Yield``
121recursively unless the value of ``onlyIfNeeded`` is True.
122
123:warning: This function is dangerous as it can lead to unexpected
d07d2bc9
RD
124 reentrancies (i.e. when called from an event handler it may
125 result in calling the same event handler again), use with
126 extreme care or, better, don't use at all!
dce2bd22 127
d07d2bc9
RD
128:see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
129", "");
d14a1e28 130
6c3b4aae
RD
131
132 DocDeclStr(
133 virtual void, WakeUpIdle(),
dce2bd22 134 "Make sure that idle events are sent again.
d07d2bc9 135:see: `wx.WakeUpIdle`", "");
d14a1e28 136
45c82204
RD
137
138 DocDeclStr(
139 static bool , IsMainLoopRunning() const,
140 "Returns True if we're running the main loop, i.e. if the events can
141currently be dispatched.", "");
142
d14a1e28 143
6c3b4aae
RD
144 DocDeclStr(
145 virtual int, MainLoop(),
dce2bd22 146 "Execute the main GUI loop, the function doesn't normally return until
d07d2bc9 147all top level windows have been closed and destroyed.", "");
d14a1e28 148
6c3b4aae
RD
149
150 DocDeclStr(
151 virtual void, Exit(),
dce2bd22 152 "Exit the main loop thus terminating the application.
d07d2bc9 153:see: `wx.Exit`", "");
d14a1e28 154
6c3b4aae
RD
155
156 DocDeclStr(
157 virtual void, ExitMainLoop(),
dce2bd22 158 "Exit the main GUI loop during the next iteration of the main
d07d2bc9 159loop, (i.e. it does not stop the program immediately!)", "");
d14a1e28 160
6c3b4aae
RD
161
162 DocDeclStr(
163 virtual bool, Pending(),
d07d2bc9 164 "Returns True if there are unprocessed events in the event queue.", "");
d14a1e28 165
6c3b4aae
RD
166
167 DocDeclStr(
168 virtual bool, Dispatch(),
dce2bd22 169 "Process the first event in the event queue (blocks until an event
d07d2bc9 170appears if there are none currently)", "");
d14a1e28 171
d14a1e28 172
6c3b4aae
RD
173 DocDeclStr(
174 virtual bool, ProcessIdle(),
dce2bd22
RD
175 "Called from the MainLoop when the application becomes idle (there are
176no pending events) and sends a `wx.IdleEvent` to all interested
d07d2bc9 177parties. Returns True if more idle events are needed, False if not.", "");
6c3b4aae
RD
178
179
180 DocDeclStr(
181 virtual bool, SendIdleEvents(wxWindow* win, wxIdleEvent& event),
dce2bd22 182 "Send idle event to window and all subwindows. Returns True if more
d07d2bc9 183idle time is requested.", "");
d14a1e28 184
d14a1e28 185
6c3b4aae
RD
186 DocDeclStr(
187 virtual bool, IsActive() const,
d07d2bc9 188 "Return True if our app has focus.", "");
d14a1e28 189
6c3b4aae
RD
190
191 DocDeclStr(
192 void, SetTopWindow(wxWindow *win),
d07d2bc9 193 "Set the *main* top level window", "");
d14a1e28 194
6c3b4aae
RD
195 DocDeclStr(
196 virtual wxWindow*, GetTopWindow() const,
dce2bd22
RD
197 "Return the *main* top level window (if it hadn't been set previously
198with SetTopWindow(), will return just some top level window and, if
d07d2bc9 199there not any, will return None)", "");
d14a1e28 200
d14a1e28 201
6c3b4aae
RD
202 DocDeclStr(
203 void, SetExitOnFrameDelete(bool flag),
dce2bd22
RD
204 "Control the exit behaviour: by default, the program will exit the main
205loop (and so, usually, terminate) when the last top-level program
206window is deleted. Beware that if you disable this behaviour (with
207SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
d07d2bc9 208explicitly from somewhere.", "");
6c3b4aae
RD
209
210
211 DocDeclStr(
212 bool, GetExitOnFrameDelete() const,
d07d2bc9 213 "Get the current exit behaviour setting.", "");
d14a1e28
RD
214
215#if 0
856bf319 216 // Get display mode that is in use. This is only used in framebuffer
d14a1e28
RD
217 // wxWin ports (such as wxMGL).
218 virtual wxVideoMode GetDisplayMode() const;
219
220 // Set display mode to use. This is only used in framebuffer wxWin
221 // ports (such as wxMGL). This method should be called from
222 // wxApp::OnInitGui
223 virtual bool SetDisplayMode(const wxVideoMode& info);
224#endif
225
6c3b4aae
RD
226
227 DocDeclStr(
228 void, SetUseBestVisual( bool flag ),
dce2bd22 229 "Set whether the app should try to use the best available visual on
d07d2bc9 230systems where more than one is available, (Sun, SGI, XFree86 4, etc.)", "");
6c3b4aae
RD
231
232 DocDeclStr(
233 bool, GetUseBestVisual() const,
d07d2bc9 234 "Get current UseBestVisual setting.", "");
6c3b4aae 235
d14a1e28
RD
236
237 // set/get printing mode: see wxPRINT_XXX constants.
238 //
239 // default behaviour is the normal one for Unix: always use PostScript
240 // printing.
241 virtual void SetPrintMode(int mode);
242 int GetPrintMode() const;
243
6c3b4aae
RD
244
245 DocDeclStr(
246 void, SetAssertMode(int mode),
d07d2bc9
RD
247 "Set the OnAssert behaviour for debug and hybrid builds.",
248 "The following flags may be or'd together:
dce2bd22
RD
249
250 ========================= =======================================
251 wx.PYAPP_ASSERT_SUPPRESS Don't do anything
252 wx.PYAPP_ASSERT_EXCEPTION Turn it into a Python exception if possible
253 (default)
254 wx.PYAPP_ASSERT_DIALOG Display a message dialog
255 wx.PYAPP_ASSERT_LOG Write the assertion info to the wx.Log
256 ========================= =======================================
257
258");
6c3b4aae
RD
259
260 DocDeclStr(
261 int, GetAssertMode(),
d07d2bc9 262 "Get the current OnAssert behaviour setting.", "");
d14a1e28
RD
263
264
265 static bool GetMacSupportPCMenuShortcuts();
266 static long GetMacAboutMenuItemId();
267 static long GetMacPreferencesMenuItemId();
268 static long GetMacExitMenuItemId();
269 static wxString GetMacHelpMenuTitleName();
270
271 static void SetMacSupportPCMenuShortcuts(bool val);
272 static void SetMacAboutMenuItemId(long val);
273 static void SetMacPreferencesMenuItemId(long val);
274 static void SetMacExitMenuItemId(long val);
275 static void SetMacHelpMenuTitleName(const wxString& val);
276
d14a1e28 277
6c3b4aae
RD
278 DocDeclStr(
279 void, _BootstrapApp(),
d07d2bc9 280 "For internal use only", "");
6c3b4aae
RD
281
282 DocStr(GetComCtl32Version,
dce2bd22 283 "Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
d07d2bc9 284it wasn't found at all. Raises an exception on non-Windows platforms.", "");
d14a1e28 285#ifdef __WXMSW__
d14a1e28
RD
286 static int GetComCtl32Version();
287#else
288 %extend {
289 static int GetComCtl32Version()
81cfe5e1 290 { wxPyRaiseNotImplemented(); return 0; }
d14a1e28
RD
291 }
292#endif
4d9de110
RD
293
294 %extend {
295 DocStr(DisplayAvailable,
296 "Tests if it is possible to create a GUI in the current environment.
297This will mean different things on the different platforms.
298
299 * On X Windows systems this function will return ``False`` if it is
300 not able to open a connection to the X display, which can happen
301 if $DISPLAY is not set, or is not set correctly.
302
303 * On Mac OS X a ``False`` return value will mean that wx is not
304 able to access the window manager, which can happen if logged in
305 remotely or if running from the normal version of python instead
306 of the framework version, (i.e., pythonw.)
307
308 * On MS Windows...
309", "");
310 static bool DisplayAvailable() {
311 return wxPyTestDisplayAvailable();
312 }
313 }
d14a1e28
RD
314};
315
316
317
318//---------------------------------------------------------------------------
319%newgroup;
320
d14a1e28 321
6c3b4aae
RD
322DocDeclStr(
323 void, wxExit(),
d07d2bc9 324 "Force an exit of the application. Convenience for wx.GetApp().Exit()", "");
6c3b4aae
RD
325
326
327DocDeclStr(
328 bool, wxYield(),
d07d2bc9 329 "Yield to other apps/messages. Convenience for wx.GetApp().Yield()", "");
d14a1e28 330
6c3b4aae
RD
331DocDeclStr(
332 bool, wxYieldIfNeeded(),
d07d2bc9 333 "Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)", "");
d14a1e28 334
d14a1e28 335
6c3b4aae 336DocDeclStr(
a72f4631 337 bool, wxSafeYield(wxWindow* win=NULL, bool onlyIfNeeded=false),
dce2bd22
RD
338 "This function is similar to `wx.Yield`, except that it disables the
339user input to all program windows before calling `wx.Yield` and
340re-enables it again afterwards. If ``win`` is not None, this window
341will remain enabled, allowing the implementation of some limited user
342interaction.
343
d07d2bc9 344:Returns: the result of the call to `wx.Yield`.", "");
6c3b4aae
RD
345
346
347DocDeclStr(
348 void, wxWakeUpIdle(),
dce2bd22 349 "Cause the message queue to become empty again, so idle events will be
d07d2bc9 350sent.", "");
6c3b4aae
RD
351
352
353DocDeclStr(
354 void, wxPostEvent(wxEvtHandler *dest, wxEvent& event),
dce2bd22 355 "Send an event to a window or other wx.EvtHandler to be processed
d07d2bc9 356later.", "");
6c3b4aae
RD
357
358
359DocStr(wxApp_CleanUp,
d07d2bc9
RD
360 "For internal use only, it is used to cleanup after wxWidgets when
361Python shuts down.", "");
d14a1e28
RD
362%inline %{
363 void wxApp_CleanUp() {
364 __wxPyCleanup();
365 }
366%}
367
6c3b4aae 368
c92d9283
RD
369DocDeclStrName(
370 wxPyApp* , wxPyGetApp(),
371 "Return a reference to the current wx.App object.", "",
372 GetApp);
373%{
374 wxPyApp* wxPyGetApp() { return (wxPyApp*)wxTheApp; }
d14a1e28
RD
375%}
376
377
c92d9283 378
27c9e43c
RD
379
380
381DocDeclAStr(
382 void , wxSetDefaultPyEncoding(const char* encoding),
383 "SetDefaultPyEncoding(string encoding)",
384 "Sets the encoding that wxPython will use when it needs to convert a
669e06d7
RD
385Python string or unicode object to or from a wxString.
386
387The default encoding is the value of ``locale.getdefaultlocale()[1]``
388but please be aware that the default encoding within the same locale
389may be slightly different on different platforms. For example, please
390see http://www.alanwood.net/demos/charsetdiffs.html for differences
391between the common latin/roman encodings.", "");
27c9e43c
RD
392
393DocDeclAStr(
394 const char* , wxGetDefaultPyEncoding(),
395 "GetDefaultPyEncoding() -> string",
396 "Gets the current encoding that wxPython will use when it needs to
397convert a Python string or unicode object to or from a wxString.", "");
398
399
d14a1e28
RD
400//---------------------------------------------------------------------------
401// Include some extra wxApp related python code here
402
403%pythoncode "_app_ex.py"
404
405//---------------------------------------------------------------------------
406