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