wxPython/src/_app.i

   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
  28 enum {
  29     wxPYAPP_ASSERT_SUPPRESS  = 1,
  30     wxPYAPP_ASSERT_EXCEPTION = 2,
  31     wxPYAPP_ASSERT_DIALOG    = 4,
  32     wxPYAPP_ASSERT_LOG       = 8
  33 };
  34
  35 enum
  36 {
  37     wxPRINT_WINDOWS = 1,
  38     wxPRINT_POSTSCRIPT = 2
  39 };
  40
  41
  42
  43 DocStr(wxPyApp,
  44 "The ``wx.PyApp`` class is an *implementation detail*, please use the
  45 `wx.App` class (or some other derived class) instead.", "");
  46
  47 class wxPyApp : public wxEvtHandler {
  48 public:
  49
  50     %pythonAppend wxPyApp
  51        "self._setCallbackInfo(self, PyApp)
  52         self._setOORInfo(self)";
  53
  54     DocStr(wxPyApp,
  55            "Create a new application object, starting the bootstrap process.", "");
  56     %extend {
  57         wxPyApp() {
  58             wxPythonApp = new wxPyApp();
  59             return wxPythonApp;
  60         }
  61     }
  62
  63     ~wxPyApp();
  64
  65     void _setCallbackInfo(PyObject* self, PyObject* _class);
  66
  67
  68     DocDeclStr(
  69         wxString, GetAppName() const,
  70         "Get the application name.", "");
  71     DocDeclStr(
  72         void, SetAppName(const wxString& name),
  73         "Set the application name. This value may be used automatically by
  74 `wx.Config` and such.", "");
  75
  76     DocDeclStr(
  77         wxString, GetClassName() const,
  78         "Get the application's class name.", "");
  79     DocDeclStr(
  80         void, SetClassName(const wxString& name),
  81         "Set the application's class name. This value may be used for
  82 X-resources if applicable for the platform", "");
  83
  84     DocDeclStr(
  85         const wxString&, GetVendorName() const,
  86         "Get the application's vendor name.", "");
  87     DocDeclStr(
  88         void, SetVendorName(const wxString& name),
  89         "Set the application's vendor name. This value may be used
  90 automatically by `wx.Config` and such.", "");
  91
  92
  93     DocDeclStr(
  94         wxAppTraits*, GetTraits(),
  95         "Return (and create if necessary) the app traits object to which we
  96 delegate for everything which either should be configurable by the
  97 user (then he can change the default behaviour simply by overriding
  98 CreateTraits() and returning his own traits object) or which is
  99 GUI/console dependent as then wx.AppTraits allows us to abstract the
 100 differences behind the common facade.
 101
 102 :todo: Add support for overriding CreateAppTraits in wxPython.", "");
 103
 104
 105     DocDeclStr(
 106         virtual void, ProcessPendingEvents(),
 107         "Process all events in the Pending Events list -- it is necessary to
 108 call this function to process posted events. This normally happens
 109 during each event loop iteration.", "");
 110
 111
 112     DocDeclStr(
 113         virtual bool, Yield(bool onlyIfNeeded = False),
 114         "Process all currently pending events right now, instead of waiting
 115 until return to the event loop.  It is an error to call ``Yield``
 116 recursively unless the value of ``onlyIfNeeded`` is True.
 117
 118 :warning: This function is dangerous as it can lead to unexpected
 119       reentrancies (i.e. when called from an event handler it may
 120       result in calling the same event handler again), use with
 121       extreme care or, better, don't use at all!
 122
 123 :see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`
 124 ", "");
 125
 126
 127     DocDeclStr(
 128         virtual void, WakeUpIdle(),
 129         "Make sure that idle events are sent again.
 130 :see: `wx.WakeUpIdle`", "");
 131
 132
 133     DocDeclStr(
 134         virtual int, MainLoop(),
 135         "Execute the main GUI loop, the function doesn't normally return until
 136 all top level windows have been closed and destroyed.", "");
 137
 138
 139     DocDeclStr(
 140         virtual void, Exit(),
 141         "Exit the main loop thus terminating the application.
 142 :see: `wx.Exit`", "");
 143
 144
 145     DocDeclStr(
 146         virtual void, ExitMainLoop(),
 147         "Exit the main GUI loop during the next iteration of the main
 148 loop, (i.e. it does not stop the program immediately!)", "");
 149
 150
 151     DocDeclStr(
 152         virtual bool, Pending(),
 153         "Returns True if there are unprocessed events in the event queue.", "");
 154
 155
 156     DocDeclStr(
 157         virtual bool, Dispatch(),
 158         "Process the first event in the event queue (blocks until an event
 159 appears if there are none currently)", "");
 160
 161
 162     DocDeclStr(
 163         virtual bool, ProcessIdle(),
 164         "Called from the MainLoop when the application becomes idle (there are
 165 no pending events) and sends a `wx.IdleEvent` to all interested
 166 parties.  Returns True if more idle events are needed, False if not.", "");
 167
 168
 169     DocDeclStr(
 170         virtual bool, SendIdleEvents(wxWindow* win, wxIdleEvent& event),
 171         "Send idle event to window and all subwindows.  Returns True if more
 172 idle time is requested.", "");
 173
 174
 175     DocDeclStr(
 176         virtual bool, IsActive() const,
 177         "Return True if our app has focus.", "");
 178
 179
 180     DocDeclStr(
 181         void, SetTopWindow(wxWindow *win),
 182         "Set the *main* top level window", "");
 183
 184     DocDeclStr(
 185         virtual wxWindow*, GetTopWindow() const,
 186         "Return the *main* top level window (if it hadn't been set previously
 187 with SetTopWindow(), will return just some top level window and, if
 188 there not any, will return None)", "");
 189
 190
 191     DocDeclStr(
 192         void, SetExitOnFrameDelete(bool flag),
 193         "Control the exit behaviour: by default, the program will exit the main
 194 loop (and so, usually, terminate) when the last top-level program
 195 window is deleted.  Beware that if you disable this behaviour (with
 196 SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop()
 197 explicitly from somewhere.", "");
 198
 199
 200     DocDeclStr(
 201         bool, GetExitOnFrameDelete() const,
 202         "Get the current exit behaviour setting.", "");
 203
 204 #if 0
 205     // Get display mode that is in use. This is only used in framebuffer
 206     // wxWin ports (such as wxMGL).
 207     virtual wxVideoMode GetDisplayMode() const;
 208
 209     // Set display mode to use. This is only used in framebuffer wxWin
 210     // ports (such as wxMGL). This method should be called from
 211     // wxApp::OnInitGui
 212     virtual bool SetDisplayMode(const wxVideoMode& info);
 213 #endif
 214
 215
 216     DocDeclStr(
 217         void, SetUseBestVisual( bool flag ),
 218         "Set whether the app should try to use the best available visual on
 219 systems where more than one is available, (Sun, SGI, XFree86 4, etc.)", "");
 220
 221     DocDeclStr(
 222         bool, GetUseBestVisual() const,
 223         "Get current UseBestVisual setting.", "");
 224
 225
 226     // set/get printing mode: see wxPRINT_XXX constants.
 227     //
 228     // default behaviour is the normal one for Unix: always use PostScript
 229     // printing.
 230     virtual void SetPrintMode(int mode);
 231     int GetPrintMode() const;
 232
 233
 234     DocDeclStr(
 235         void, SetAssertMode(int mode),
 236         "Set the OnAssert behaviour for debug and hybrid builds.",
 237         "The following flags may be or'd together:
 238
 239    =========================   =======================================
 240    wx.PYAPP_ASSERT_SUPPRESS    Don't do anything
 241    wx.PYAPP_ASSERT_EXCEPTION   Turn it into a Python exception if possible
 242                                (default)
 243    wx.PYAPP_ASSERT_DIALOG      Display a message dialog
 244    wx.PYAPP_ASSERT_LOG         Write the assertion info to the wx.Log
 245    =========================   =======================================
 246
 247 ");
 248
 249     DocDeclStr(
 250         int,  GetAssertMode(),
 251         "Get the current OnAssert behaviour setting.", "");
 252
 253
 254     static bool GetMacSupportPCMenuShortcuts();
 255     static long GetMacAboutMenuItemId();
 256     static long GetMacPreferencesMenuItemId();
 257     static long GetMacExitMenuItemId();
 258     static wxString GetMacHelpMenuTitleName();
 259
 260     static void SetMacSupportPCMenuShortcuts(bool val);
 261     static void SetMacAboutMenuItemId(long val);
 262     static void SetMacPreferencesMenuItemId(long val);
 263     static void SetMacExitMenuItemId(long val);
 264     static void SetMacHelpMenuTitleName(const wxString& val);
 265
 266
 267     DocDeclStr(
 268         void, _BootstrapApp(),
 269         "For internal use only", "");
 270
 271     DocStr(GetComCtl32Version,
 272            "Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if
 273 it wasn't found at all.  Raises an exception on non-Windows platforms.", "");
 274 #ifdef __WXMSW__
 275     static int GetComCtl32Version();
 276 #else
 277     %extend {
 278         static int GetComCtl32Version()
 279             { wxPyRaiseNotImplemented(); return 0; }
 280     }
 281 #endif
 282 };
 283
 284
 285
 286 //---------------------------------------------------------------------------
 287 %newgroup;
 288
 289
 290 DocDeclStr(
 291     void,  wxExit(),
 292     "Force an exit of the application.  Convenience for wx.GetApp().Exit()", "");
 293
 294
 295 DocDeclStr(
 296     bool, wxYield(),
 297     "Yield to other apps/messages.  Convenience for wx.GetApp().Yield()", "");
 298
 299 DocDeclStr(
 300     bool, wxYieldIfNeeded(),
 301     "Yield to other apps/messages.  Convenience for wx.GetApp().Yield(True)", "");
 302
 303
 304 DocDeclStr(
 305     bool, wxSafeYield(wxWindow* win=NULL, bool onlyIfNeeded=False),
 306     "This function is similar to `wx.Yield`, except that it disables the
 307 user input to all program windows before calling `wx.Yield` and
 308 re-enables it again afterwards. If ``win`` is not None, this window
 309 will remain enabled, allowing the implementation of some limited user
 310 interaction.
 311
 312 :Returns: the result of the call to `wx.Yield`.", "");
 313
 314
 315 DocDeclStr(
 316     void,  wxWakeUpIdle(),
 317     "Cause the message queue to become empty again, so idle events will be
 318 sent.", "");
 319
 320
 321 DocDeclStr(
 322     void, wxPostEvent(wxEvtHandler *dest, wxEvent& event),
 323     "Send an event to a window or other wx.EvtHandler to be processed
 324 later.", "");
 325
 326
 327 DocStr(wxApp_CleanUp,
 328        "For internal use only, it is used to cleanup after wxWidgets when
 329 Python shuts down.", "");
 330 %inline %{
 331     void wxApp_CleanUp() {
 332         __wxPyCleanup();
 333     }
 334 %}
 335
 336
 337 DocDeclStrName(
 338     wxPyApp* , wxPyGetApp(),
 339     "Return a reference to the current wx.App object.", "",
 340     GetApp);
 341 %{
 342     wxPyApp* wxPyGetApp() { return (wxPyApp*)wxTheApp; }
 343 %}
 344
 345
 346
 347 //---------------------------------------------------------------------------
 348 // Include some extra wxApp related python code here
 349
 350 %pythoncode "_app_ex.py"
 351
 352 //---------------------------------------------------------------------------
 353