wx._core.PyApp

Package wx :: Module _core :: Class PyApp

[show private | hide private]

Type PyApp

object --+        
         |        
    Object --+    
             |    
    EvtHandler --+
                 |
                PyApp

Known Subclasses:: App

The ``wx.PyApp`` class is an *implementation detail*, please use the `wx.App` class (or some other derived class) instead.

Method Summary
	`__init__(self, args, *kwargs)` __init__(self) -> PyApp
	`__del__(self, destroy)` __del__(self)
	`__repr__(self)`
	`_BootstrapApp(args, *kwargs)` _BootstrapApp(self)
	`_setCallbackInfo(args, *kwargs)` _setCallbackInfo(self, PyObject self, PyObject _class)
	`Dispatch(args, *kwargs)` Dispatch(self) -> bool
	`Exit(args, *kwargs)` Exit(self)
	`ExitMainLoop(args, *kwargs)` ExitMainLoop(self)
	`GetAppName(args, *kwargs)` GetAppName(self) -> String
	`GetAssertMode(args, *kwargs)` GetAssertMode(self) -> int
	`GetClassName(args, *kwargs)` GetClassName(self) -> String
	`GetComCtl32Version(args, kwargs)` GetComCtl32Version() -> int (Static method)*
	`GetExitOnFrameDelete(args, *kwargs)` GetExitOnFrameDelete(self) -> bool
	`GetMacAboutMenuItemId(args, kwargs)` GetMacAboutMenuItemId() -> long (Static method)*
	`GetMacExitMenuItemId(args, kwargs)` GetMacExitMenuItemId() -> long (Static method)*
	`GetMacHelpMenuTitleName(args, kwargs)` GetMacHelpMenuTitleName() -> String (Static method)*
	`GetMacPreferencesMenuItemId(args, kwargs)` GetMacPreferencesMenuItemId() -> long (Static method)*
	`GetMacSupportPCMenuShortcuts(args, kwargs)` GetMacSupportPCMenuShortcuts() -> bool (Static method)*
	`GetPrintMode(args, *kwargs)` GetPrintMode(self) -> int
	`GetTopWindow(args, *kwargs)` GetTopWindow(self) -> Window
	`GetTraits(args, *kwargs)` GetTraits(self) -> wxAppTraits
	`GetUseBestVisual(args, *kwargs)` GetUseBestVisual(self) -> bool
	`GetVendorName(args, *kwargs)` GetVendorName(self) -> String
	`IsActive(args, *kwargs)` IsActive(self) -> bool
	`IsMainLoopRunning(args, kwargs)` IsMainLoopRunning() -> bool (Static method)*
	`MainLoop(args, *kwargs)` MainLoop(self) -> int
	`Pending(args, *kwargs)` Pending(self) -> bool
	`ProcessIdle(args, *kwargs)` ProcessIdle(self) -> bool
	`ProcessPendingEvents(args, *kwargs)` ProcessPendingEvents(self)
	`SendIdleEvents(args, *kwargs)` SendIdleEvents(self, Window win, IdleEvent event) -> bool
	`SetAppName(args, *kwargs)` SetAppName(self, String name)
	`SetAssertMode(args, *kwargs)` SetAssertMode(self, int mode)
	`SetClassName(args, *kwargs)` SetClassName(self, String name)
	`SetExitOnFrameDelete(args, *kwargs)` SetExitOnFrameDelete(self, bool flag)
	`SetMacAboutMenuItemId(args, kwargs)` SetMacAboutMenuItemId(long val) (Static method)*
	`SetMacExitMenuItemId(args, kwargs)` SetMacExitMenuItemId(long val) (Static method)*
	`SetMacHelpMenuTitleName(args, kwargs)` SetMacHelpMenuTitleName(String val) (Static method)*
	`SetMacPreferencesMenuItemId(args, kwargs)` SetMacPreferencesMenuItemId(long val) (Static method)*
	`SetMacSupportPCMenuShortcuts(args, kwargs)` SetMacSupportPCMenuShortcuts(bool val) (Static method)*
	`SetPrintMode(args, *kwargs)` SetPrintMode(self, int mode)
	`SetTopWindow(args, *kwargs)` SetTopWindow(self, Window win)
	`SetUseBestVisual(args, *kwargs)` SetUseBestVisual(self, bool flag)
	`SetVendorName(args, *kwargs)` SetVendorName(self, String name)
	`WakeUpIdle(args, *kwargs)` WakeUpIdle(self)
	`Yield(args, *kwargs)` Yield(self, bool onlyIfNeeded=False) -> bool Process all currently pending events right now, instead of waiting until return to the event loop.
Inherited from EvtHandler
	`_setOORInfo(args, *kwargs)` _setOORInfo(self, PyObject _self)
	`AddPendingEvent(args, *kwargs)` AddPendingEvent(self, Event event)
	`Bind(self, event, handler, source, id, id2)` Bind an event to an event handler.
	`Connect(args, *kwargs)` Connect(self, int id, int lastId, int eventType, PyObject func)
	`Disconnect(args, *kwargs)` Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool
	`GetEvtHandlerEnabled(args, *kwargs)` GetEvtHandlerEnabled(self) -> bool
	`GetNextHandler(args, *kwargs)` GetNextHandler(self) -> EvtHandler
	`GetPreviousHandler(args, *kwargs)` GetPreviousHandler(self) -> EvtHandler
	`ProcessEvent(args, *kwargs)` ProcessEvent(self, Event event) -> bool
	`SetEvtHandlerEnabled(args, *kwargs)` SetEvtHandlerEnabled(self, bool enabled)
	`SetNextHandler(args, *kwargs)` SetNextHandler(self, EvtHandler handler)
	`SetPreviousHandler(args, *kwargs)` SetPreviousHandler(self, EvtHandler handler)
	`Unbind(self, event, source, id, id2)` Disconencts the event handler binding for event from self.
Inherited from Object
	`Destroy(args, *kwargs)` Destroy(self)
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
Inherited from EvtHandler
`Implements`	`__implemented__` = `<implementedBy wx._core.EvtHandler>`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
Inherited from Object
`ClassProvides`	`__providedBy__` = `<zope.interface.declarations.ClassProvi...`

Instance Method Details

init(self, *args, **kwargs)
(Constructor)

__init__(self) -> PyApp

Create a new application object, starting the bootstrap process.

Overrides:: wx._core.EvtHandler.__init__

del(self, destroy=<built-in function delete_PyApp>)
(Destructor)

__del__(self)

_BootstrapApp(*args, **kwargs)

_BootstrapApp(self)

For internal use only

_setCallbackInfo(*args, **kwargs)

_setCallbackInfo(self, PyObject self, PyObject _class)

Dispatch(*args, **kwargs)

Dispatch(self) -> bool

Process the first event in the event queue (blocks until an event appears if there are none currently)

Exit(*args, **kwargs)

Exit(self)

Exit the main loop thus terminating the application. :see: `wx.Exit`

ExitMainLoop(*args, **kwargs)

ExitMainLoop(self)

Exit the main GUI loop during the next iteration of the main loop, (i.e. it does not stop the program immediately!)

GetAppName(*args, **kwargs)

GetAppName(self) -> String

Get the application name.

GetAssertMode(*args, **kwargs)

GetAssertMode(self) -> int

Get the current OnAssert behaviour setting.

GetClassName(*args, **kwargs)

GetClassName(self) -> String

Get the application's class name.

Overrides:: wx._core.Object.GetClassName

GetExitOnFrameDelete(*args, **kwargs)

GetExitOnFrameDelete(self) -> bool

Get the current exit behaviour setting.

GetPrintMode(*args, **kwargs)

GetPrintMode(self) -> int

GetTopWindow(*args, **kwargs)

GetTopWindow(self) -> Window

Return the *main* top level window (if it hadn't been set previously with SetTopWindow(), will return just some top level window and, if there not any, will return None)

GetTraits(*args, **kwargs)

GetTraits(self) -> wxAppTraits

Return (and create if necessary) the app traits object to which we delegate for everything which either should be configurable by the user (then he can change the default behaviour simply by overriding CreateTraits() and returning his own traits object) or which is GUI/console dependent as then wx.AppTraits allows us to abstract the differences behind the common facade.

:todo: Add support for overriding CreateAppTraits in wxPython.

GetUseBestVisual(*args, **kwargs)

GetUseBestVisual(self) -> bool

Get current UseBestVisual setting.

GetVendorName(*args, **kwargs)

GetVendorName(self) -> String

Get the application's vendor name.

IsActive(*args, **kwargs)

IsActive(self) -> bool

Return True if our app has focus.

MainLoop(*args, **kwargs)

MainLoop(self) -> int

Execute the main GUI loop, the function doesn't normally return until all top level windows have been closed and destroyed.

Pending(*args, **kwargs)

Pending(self) -> bool

Returns True if there are unprocessed events in the event queue.

ProcessIdle(*args, **kwargs)

ProcessIdle(self) -> bool

Called from the MainLoop when the application becomes idle (there are no pending events) and sends a `wx.IdleEvent` to all interested parties. Returns True if more idle events are needed, False if not.

ProcessPendingEvents(*args, **kwargs)

ProcessPendingEvents(self)

Process all events in the Pending Events list -- it is necessary to call this function to process posted events. This normally happens during each event loop iteration.

Overrides:: wx._core.EvtHandler.ProcessPendingEvents

SendIdleEvents(*args, **kwargs)

SendIdleEvents(self, Window win, IdleEvent event) -> bool

Send idle event to window and all subwindows. Returns True if more idle time is requested.

SetAppName(*args, **kwargs)

SetAppName(self, String name)

Set the application name. This value may be used automatically by `wx.Config` and such.

SetAssertMode(*args, **kwargs)

SetAssertMode(self, int mode)

Set the OnAssert behaviour for debug and hybrid builds.

SetClassName(*args, **kwargs)

SetClassName(self, String name)

Set the application's class name. This value may be used for X-resources if applicable for the platform

SetExitOnFrameDelete(*args, **kwargs)

SetExitOnFrameDelete(self, bool flag)

Control the exit behaviour: by default, the program will exit the main loop (and so, usually, terminate) when the last top-level program window is deleted. Beware that if you disable this behaviour (with SetExitOnFrameDelete(False)), you'll have to call ExitMainLoop() explicitly from somewhere.

SetPrintMode(*args, **kwargs)

SetPrintMode(self, int mode)

SetTopWindow(*args, **kwargs)

SetTopWindow(self, Window win)

Set the *main* top level window

SetUseBestVisual(*args, **kwargs)

SetUseBestVisual(self, bool flag)

Set whether the app should try to use the best available visual on systems where more than one is available, (Sun, SGI, XFree86 4, etc.)

SetVendorName(*args, **kwargs)

SetVendorName(self, String name)

Set the application's vendor name. This value may be used automatically by `wx.Config` and such.

WakeUpIdle(*args, **kwargs)

WakeUpIdle(self)

Make sure that idle events are sent again. :see: `wx.WakeUpIdle`

Yield(*args, **kwargs)

Yield(self, bool onlyIfNeeded=False) -> bool

Process all currently pending events right now, instead of waiting
until return to the event loop.  It is an error to call ``Yield``
recursively unless the value of ``onlyIfNeeded`` is True.

:warning: This function is dangerous as it can lead to unexpected
      reentrancies (i.e. when called from an event handler it may
      result in calling the same event handler again), use with
      extreme care or, better, don't use at all!

:see: `wx.Yield`, `wx.YieldIfNeeded`, `wx.SafeYield`

Static Method Details

GetComCtl32Version(*args, **kwargs)

GetComCtl32Version() -> int

Returns 400, 470, 471, etc. for comctl32.dll 4.00, 4.70, 4.71 or 0 if it wasn't found at all. Raises an exception on non-Windows platforms.

GetMacAboutMenuItemId(*args, **kwargs)

GetMacAboutMenuItemId() -> long

GetMacExitMenuItemId(*args, **kwargs)

GetMacExitMenuItemId() -> long

GetMacHelpMenuTitleName(*args, **kwargs)

GetMacHelpMenuTitleName() -> String

GetMacPreferencesMenuItemId(*args, **kwargs)

GetMacPreferencesMenuItemId() -> long

GetMacSupportPCMenuShortcuts(*args, **kwargs)

GetMacSupportPCMenuShortcuts() -> bool

IsMainLoopRunning(*args, **kwargs)

IsMainLoopRunning() -> bool

Returns True if we're running the main loop, i.e. if the events can currently be dispatched.

SetMacAboutMenuItemId(*args, **kwargs)

SetMacAboutMenuItemId(long val)

SetMacExitMenuItemId(*args, **kwargs)

SetMacExitMenuItemId(long val)

SetMacHelpMenuTitleName(*args, **kwargs)

SetMacHelpMenuTitleName(String val)

SetMacPreferencesMenuItemId(*args, **kwargs)

SetMacPreferencesMenuItemId(long val)

SetMacSupportPCMenuShortcuts(*args, **kwargs)

SetMacSupportPCMenuShortcuts(bool val)

Generated by Epydoc 2.1 on Fri Jun 24 12:01:20 2005

http://epydoc.sf.net

Method Summary
	`__init__(self, args, *kwargs)` __init__(self) -> PyApp
	`__del__(self, destroy)` __del__(self)
	`__repr__(self)`
	`_BootstrapApp(args, *kwargs)` _BootstrapApp(self)
	`_setCallbackInfo(args, *kwargs)` _setCallbackInfo(self, PyObject self, PyObject _class)
	`Dispatch(args, *kwargs)` Dispatch(self) -> bool
	`Exit(args, *kwargs)` Exit(self)
	`ExitMainLoop(args, *kwargs)` ExitMainLoop(self)
	`GetAppName(args, *kwargs)` GetAppName(self) -> String
	`GetAssertMode(args, *kwargs)` GetAssertMode(self) -> int
	`GetClassName(args, *kwargs)` GetClassName(self) -> String
	`GetComCtl32Version(args, kwargs)` GetComCtl32Version() -> int (Static method)*
	`GetExitOnFrameDelete(args, *kwargs)` GetExitOnFrameDelete(self) -> bool
	`GetMacAboutMenuItemId(args, kwargs)` GetMacAboutMenuItemId() -> long (Static method)*
	`GetMacExitMenuItemId(args, kwargs)` GetMacExitMenuItemId() -> long (Static method)*
	`GetMacHelpMenuTitleName(args, kwargs)` GetMacHelpMenuTitleName() -> String (Static method)*
	`GetMacPreferencesMenuItemId(args, kwargs)` GetMacPreferencesMenuItemId() -> long (Static method)*
	`GetMacSupportPCMenuShortcuts(args, kwargs)` GetMacSupportPCMenuShortcuts() -> bool (Static method)*
	`GetPrintMode(args, *kwargs)` GetPrintMode(self) -> int
	`GetTopWindow(args, *kwargs)` GetTopWindow(self) -> Window
	`GetTraits(args, *kwargs)` GetTraits(self) -> wxAppTraits
	`GetUseBestVisual(args, *kwargs)` GetUseBestVisual(self) -> bool
	`GetVendorName(args, *kwargs)` GetVendorName(self) -> String
	`IsActive(args, *kwargs)` IsActive(self) -> bool
	`IsMainLoopRunning(args, kwargs)` IsMainLoopRunning() -> bool (Static method)*
	`MainLoop(args, *kwargs)` MainLoop(self) -> int
	`Pending(args, *kwargs)` Pending(self) -> bool
	`ProcessIdle(args, *kwargs)` ProcessIdle(self) -> bool
	`ProcessPendingEvents(args, *kwargs)` ProcessPendingEvents(self)
	`SendIdleEvents(args, *kwargs)` SendIdleEvents(self, Window win, IdleEvent event) -> bool
	`SetAppName(args, *kwargs)` SetAppName(self, String name)
	`SetAssertMode(args, *kwargs)` SetAssertMode(self, int mode)
	`SetClassName(args, *kwargs)` SetClassName(self, String name)
	`SetExitOnFrameDelete(args, *kwargs)` SetExitOnFrameDelete(self, bool flag)
	`SetMacAboutMenuItemId(args, kwargs)` SetMacAboutMenuItemId(long val) (Static method)*
	`SetMacExitMenuItemId(args, kwargs)` SetMacExitMenuItemId(long val) (Static method)*
	`SetMacHelpMenuTitleName(args, kwargs)` SetMacHelpMenuTitleName(String val) (Static method)*
	`SetMacPreferencesMenuItemId(args, kwargs)` SetMacPreferencesMenuItemId(long val) (Static method)*
	`SetMacSupportPCMenuShortcuts(args, kwargs)` SetMacSupportPCMenuShortcuts(bool val) (Static method)*
	`SetPrintMode(args, *kwargs)` SetPrintMode(self, int mode)
	`SetTopWindow(args, *kwargs)` SetTopWindow(self, Window win)
	`SetUseBestVisual(args, *kwargs)` SetUseBestVisual(self, bool flag)
	`SetVendorName(args, *kwargs)` SetVendorName(self, String name)
	`WakeUpIdle(args, *kwargs)` WakeUpIdle(self)
	`Yield(args, *kwargs)` Yield(self, bool onlyIfNeeded=False) -> bool Process all currently pending events right now, instead of waiting until return to the event loop.
Inherited from EvtHandler
	`_setOORInfo(args, *kwargs)` _setOORInfo(self, PyObject _self)
	`AddPendingEvent(args, *kwargs)` AddPendingEvent(self, Event event)
	`Bind(self, event, handler, source, id, id2)` Bind an event to an event handler.
	`Connect(args, *kwargs)` Connect(self, int id, int lastId, int eventType, PyObject func)
	`Disconnect(args, *kwargs)` Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool
	`GetEvtHandlerEnabled(args, *kwargs)` GetEvtHandlerEnabled(self) -> bool
	`GetNextHandler(args, *kwargs)` GetNextHandler(self) -> EvtHandler
	`GetPreviousHandler(args, *kwargs)` GetPreviousHandler(self) -> EvtHandler
	`ProcessEvent(args, *kwargs)` ProcessEvent(self, Event event) -> bool
	`SetEvtHandlerEnabled(args, *kwargs)` SetEvtHandlerEnabled(self, bool enabled)
	`SetNextHandler(args, *kwargs)` SetNextHandler(self, EvtHandler handler)
	`SetPreviousHandler(args, *kwargs)` SetPreviousHandler(self, EvtHandler handler)
	`Unbind(self, event, source, id, id2)` Disconencts the event handler binding for event from self.
Inherited from Object
	`Destroy(args, *kwargs)` Destroy(self)
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)