X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/41e2b43ea4fd82f188cf6f62b71c67bca8844ae9..cdb501108b32bf390d82f4840aad520030621228:/wxPython/src/gtk/_core.py diff --git a/wxPython/src/gtk/_core.py b/wxPython/src/gtk/_core.py index 3f3be5105d..2ff23bec9a 100644 --- a/wxPython/src/gtk/_core.py +++ b/wxPython/src/gtk/_core.py @@ -2322,10 +2322,13 @@ def Image_GetImageExtWildcard(*args, **kwargs): """Image_GetImageExtWildcard() -> String""" return _core_.Image_GetImageExtWildcard(*args, **kwargs) +def InitAllImageHandlers(): + """ + The former functionality of InitAllImageHanders is now done internal to + the _core_ extension module and so this function has become a simple NOP. + """ + pass -def InitAllImageHandlers(*args, **kwargs): - """InitAllImageHandlers()""" - return _core_.InitAllImageHandlers(*args, **kwargs) IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM BMP_24BPP = _core_.BMP_24BPP @@ -2593,22 +2596,27 @@ class EvtHandler(Object): """ Bind an event to an event handler. - event One of the EVT_* objects that specifies the - type of event to bind, + :param event: One of the EVT_* objects that specifies the + type of event to bind, - handler A callable object to be invoked when the event - is delivered to self. Pass None to disconnect an - event handler. + :param handler: A callable object to be invoked when the + event is delivered to self. Pass None to + disconnect an event handler. - source Sometimes the event originates from a different window - than self, but you still want to catch it in self. (For - example, a button event delivered to a frame.) By - passing the source of the event, the event handling - system is able to differentiate between the same event - type from different controls. + :param source: Sometimes the event originates from a + different window than self, but you still + want to catch it in self. (For example, a + button event delivered to a frame.) By + passing the source of the event, the event + handling system is able to differentiate + between the same event type from different + controls. - id,id2 Used for menu IDs or for event types that require a - range of IDs + :param id: Used to spcify the event source by ID instead + of instance. + + :param id2: Used when it is desirable to bind a handler + to a range of IDs, such as with EVT_MENU_RANGE. """ if source is not None: id = source.GetId() @@ -5193,7 +5201,6 @@ class PySimpleApp(wx.App): wx.App.__init__(self, redirect, filename, useBestVisual, clearSigInt) def OnInit(self): - wx.InitAllImageHandlers() return True @@ -5766,7 +5773,7 @@ class Window(EvtHandler): """ GetClientRect(self) -> Rect - Get the client area position and size as a wx.Rect object. + Get the client area position and size as a `wx.Rect` object. """ return _core_.Window_GetClientRect(*args, **kwargs) @@ -6680,7 +6687,7 @@ class Window(EvtHandler): useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of - place on the users system, especially if it uses themes. + place on the user's system, especially if it uses themes. """ return _core_.Window_GetDefaultAttributes(*args, **kwargs) @@ -6691,12 +6698,13 @@ class Window(EvtHandler): Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the users - system, especially if it uses themes. + colours or fonts which might look completely out of place on the + user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of - the returned font. See SetWindowVariant for more about this. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _core_.Window_GetClassDefaultAttributes(*args, **kwargs) @@ -6710,7 +6718,7 @@ class Window(EvtHandler): EVT_ERASE_BACKGROUND event handler function under Windows and automatically under GTK. - Note that setting the background colour does not cause an immediate + Note that setting the background colour may not cause an immediate refresh, so you may wish to call ClearBackground or Refresh after calling this function. @@ -7364,12 +7372,13 @@ def Window_GetClassDefaultAttributes(*args, **kwargs): Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the users - system, especially if it uses themes. + colours or fonts which might look completely out of place on the + user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of - the returned font. See SetWindowVariant for more about this. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _core_.Window_GetClassDefaultAttributes(*args, **kwargs) @@ -8107,12 +8116,13 @@ class Control(Window): Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the users - system, especially if it uses themes. + colours or fonts which might look completely out of place on the + user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of - the returned font. See SetWindowVariant for more about this. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) @@ -8143,12 +8153,13 @@ def Control_GetClassDefaultAttributes(*args, **kwargs): Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific - colours or fonts which might look completely out of place on the users - system, especially if it uses themes. + colours or fonts which might look completely out of place on the + user's system, especially if it uses themes. The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of - the returned font. See SetWindowVariant for more about this. + the returned font. See `wx.Window.SetWindowVariant` for more about + this. """ return _core_.Control_GetClassDefaultAttributes(*args, **kwargs) @@ -9602,7 +9613,10 @@ def CallAfter(callable, *args, **kw): """ Call the specified function after the current and pending event handlers have been completed. This is also good for making GUI - method calls from non-GUI threads. + method calls from non-GUI threads. Any extra positional or + keyword args are passed on to the callable when it is called. + + :see: `wx.FutureCall` """ app = wx.GetApp() assert app, 'No wxApp created yet' @@ -9628,7 +9642,7 @@ class FutureCall: A convenience class for wx.Timer, that calls the given callable object once after the given amount of milliseconds, passing any positional or keyword args. The return value of the callable is - availbale after it has been run with the GetResult method. + availbale after it has been run with the `GetResult` method. If you don't need to get the return value or restart the timer then there is no need to hold a reference to this object. It will @@ -9636,6 +9650,8 @@ class FutureCall: has a reference to self.Notify) but the cycle will be broken when the timer completes, automatically cleaning up the wx.FutureCall object. + + :see: `wx.CallAfter` """ def __init__(self, millis, callable, *args, **kwargs): self.millis = millis