X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/33d6fd3b4c38226d3859de4a29ab317f588ada22..0cf04a425fe081365237c97fec168b77ea6efd03:/wxPython/src/msw/_core.py diff --git a/wxPython/src/msw/_core.py b/wxPython/src/msw/_core.py index 27a932ec39..81c9364b07 100644 --- a/wxPython/src/msw/_core.py +++ b/wxPython/src/msw/_core.py @@ -678,6 +678,9 @@ MOD_ALL = _core_.MOD_ALL UPDATE_UI_NONE = _core_.UPDATE_UI_NONE UPDATE_UI_RECURSE = _core_.UPDATE_UI_RECURSE UPDATE_UI_FROMIDLE = _core_.UPDATE_UI_FROMIDLE +Layout_Default = _core_.Layout_Default +Layout_LeftToRight = _core_.Layout_LeftToRight +Layout_RightToLeft = _core_.Layout_RightToLeft #--------------------------------------------------------------------------- class Object(object): @@ -702,9 +705,8 @@ class Object(object): Deletes the C++ object this Python object is a proxy for. """ - val = _core_.Object_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _core_.Object_Destroy(*args, **kwargs) ClassName = property(GetClassName,doc="See `GetClassName`") _core_.Object_swigregister(Object) @@ -838,6 +840,14 @@ class Size(object): """ return _core_.Size_DecTo(*args, **kwargs) + def IncBy(*args, **kwargs): + """IncBy(self, int dx, int dy)""" + return _core_.Size_IncBy(*args, **kwargs) + + def DecBy(*args, **kwargs): + """DecBy(self, int dx, int dy)""" + return _core_.Size_DecBy(*args, **kwargs) + def Scale(*args, **kwargs): """ Scale(self, float xscale, float yscale) @@ -1181,6 +1191,22 @@ class Rect(object): """SetBottomRight(self, Point p)""" return _core_.Rect_SetBottomRight(*args, **kwargs) + def GetTopRight(*args, **kwargs): + """GetTopRight(self) -> Point""" + return _core_.Rect_GetTopRight(*args, **kwargs) + + def SetTopRight(*args, **kwargs): + """SetTopRight(self, Point p)""" + return _core_.Rect_SetTopRight(*args, **kwargs) + + def GetBottomLeft(*args, **kwargs): + """GetBottomLeft(self) -> Point""" + return _core_.Rect_GetBottomLeft(*args, **kwargs) + + def SetBottomLeft(*args, **kwargs): + """SetBottomLeft(self, Point p)""" + return _core_.Rect_SetBottomLeft(*args, **kwargs) + def GetLeft(*args, **kwargs): """GetLeft(self) -> int""" return _core_.Rect_GetLeft(*args, **kwargs) @@ -1346,9 +1372,12 @@ class Rect(object): """ return _core_.Rect_ContainsRect(*args, **kwargs) - Inside = wx._deprecated(Contains, "Use `Contains` instead.") - InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.") - InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.") + #Inside = wx._deprecated(Contains, "Use `Contains` instead.") + #InsideXY = wx._deprecated(ContainsXY, "Use `ContainsXY` instead.") + #InsideRect = wx._deprecated(ContainsRect, "Use `ContainsRect` instead.") + Inside = Contains + InsideXY = ContainsXY + InsideRect = ContainsRect def Intersects(*args, **kwargs): """ @@ -1405,6 +1434,7 @@ class Rect(object): Bottom = property(GetBottom,SetBottom,doc="See `GetBottom` and `SetBottom`") BottomRight = property(GetBottomRight,SetBottomRight,doc="See `GetBottomRight` and `SetBottomRight`") + BottomLeft = property(GetBottomLeft,SetBottomLeft,doc="See `GetBottomLeft` and `SetBottomLeft`") Height = property(GetHeight,SetHeight,doc="See `GetHeight` and `SetHeight`") Left = property(GetLeft,SetLeft,doc="See `GetLeft` and `SetLeft`") Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`") @@ -1412,6 +1442,7 @@ class Rect(object): Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`") Top = property(GetTop,SetTop,doc="See `GetTop` and `SetTop`") TopLeft = property(GetTopLeft,SetTopLeft,doc="See `GetTopLeft` and `SetTopLeft`") + TopRight = property(GetTopRight,SetTopRight,doc="See `GetTopRight` and `SetTopRight`") Width = property(GetWidth,SetWidth,doc="See `GetWidth` and `SetWidth`") X = property(GetX,SetX,doc="See `GetX` and `SetX`") Y = property(GetY,SetY,doc="See `GetY` and `SetY`") @@ -1469,6 +1500,8 @@ class Point2D(object): Create a w.Point2D object. """ _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs)) + __swig_destroy__ = _core_.delete_Point2D + __del__ = lambda self : None; def GetFloor(*args, **kwargs): """ GetFloor() -> (x,y) @@ -2007,6 +2040,8 @@ def MemoryFSHandler_RemoveFile(*args, **kwargs): IMAGE_ALPHA_TRANSPARENT = _core_.IMAGE_ALPHA_TRANSPARENT IMAGE_ALPHA_THRESHOLD = _core_.IMAGE_ALPHA_THRESHOLD IMAGE_ALPHA_OPAQUE = _core_.IMAGE_ALPHA_OPAQUE +IMAGE_QUALITY_NORMAL = _core_.IMAGE_QUALITY_NORMAL +IMAGE_QUALITY_HIGH = _core_.IMAGE_QUALITY_HIGH #--------------------------------------------------------------------------- class ImageHandler(Object): @@ -2285,20 +2320,61 @@ class Image(Object): Destroys the image data. """ - val = _core_.Image_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _core_.Image_Destroy(*args, **kwargs) def Scale(*args, **kwargs): """ - Scale(self, int width, int height) -> Image + Scale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image Returns a scaled version of the image. This is also useful for scaling bitmaps in general as the only other way to scale bitmaps is to blit a - `wx.MemoryDC` into another `wx.MemoryDC`. + `wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter + specifies what method to use for resampling the image. It can be + either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling + method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses + bicubic and box averaging resampling methods for upsampling and + downsampling respectively. """ return _core_.Image_Scale(*args, **kwargs) + def ResampleBox(*args, **kwargs): + """ResampleBox(self, int width, int height) -> Image""" + return _core_.Image_ResampleBox(*args, **kwargs) + + def ResampleBicubic(*args, **kwargs): + """ResampleBicubic(self, int width, int height) -> Image""" + return _core_.Image_ResampleBicubic(*args, **kwargs) + + def Blur(*args, **kwargs): + """ + Blur(self, int radius) -> Image + + Blurs the image in both horizontal and vertical directions by the + specified pixel ``radius``. This should not be used when using a + single mask colour for transparency. + """ + return _core_.Image_Blur(*args, **kwargs) + + def BlurHorizontal(*args, **kwargs): + """ + BlurHorizontal(self, int radius) -> Image + + Blurs the image in the horizontal direction only. This should not be + used when using a single mask colour for transparency. + + """ + return _core_.Image_BlurHorizontal(*args, **kwargs) + + def BlurVertical(*args, **kwargs): + """ + BlurVertical(self, int radius) -> Image + + Blurs the image in the vertical direction only. This should not be + used when using a single mask colour for transparency. + """ + return _core_.Image_BlurVertical(*args, **kwargs) + def ShrinkBy(*args, **kwargs): """ ShrinkBy(self, int xFactor, int yFactor) -> Image @@ -2309,7 +2385,7 @@ class Image(Object): def Rescale(*args, **kwargs): """ - Rescale(self, int width, int height) -> Image + Rescale(self, int width, int height, int quality=IMAGE_QUALITY_NORMAL) -> Image Changes the size of the image in-place by scaling it: after a call to this function, the image will have the given width and height. @@ -2573,14 +2649,15 @@ class Image(Object): """ return _core_.Image_LoadMimeStream(*args, **kwargs) - def Ok(*args, **kwargs): + def IsOk(*args, **kwargs): """ - Ok(self) -> bool + IsOk(self) -> bool Returns true if image data is present. """ - return _core_.Image_Ok(*args, **kwargs) + return _core_.Image_IsOk(*args, **kwargs) + Ok = IsOk def GetWidth(*args, **kwargs): """ GetWidth(self) -> int @@ -2958,7 +3035,7 @@ class Image(Object): return _core_.Image_HSVtoRGB(*args, **kwargs) HSVtoRGB = staticmethod(HSVtoRGB) - def __nonzero__(self): return self.Ok() + def __nonzero__(self): return self.IsOk() AlphaBuffer = property(GetAlphaBuffer,SetAlphaBuffer,doc="See `GetAlphaBuffer` and `SetAlphaBuffer`") AlphaData = property(GetAlphaData,SetAlphaData,doc="See `GetAlphaData` and `SetAlphaData`") Data = property(GetData,SetData,doc="See `GetData` and `SetData`") @@ -2967,7 +3044,6 @@ class Image(Object): MaskBlue = property(GetMaskBlue,doc="See `GetMaskBlue`") MaskGreen = property(GetMaskGreen,doc="See `GetMaskGreen`") MaskRed = property(GetMaskRed,doc="See `GetMaskRed`") - Size = property(GetSize,doc="See `GetSize`") Width = property(GetWidth,doc="See `GetWidth`") _core_.Image_swigregister(Image) @@ -3366,6 +3442,8 @@ class EvtHandler(Object): def __init__(self, *args, **kwargs): """__init__(self) -> EvtHandler""" _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs)) + self._setOORInfo(self) + def GetNextHandler(*args, **kwargs): """GetNextHandler(self) -> EvtHandler""" return _core_.EvtHandler_GetNextHandler(*args, **kwargs) @@ -3402,6 +3480,18 @@ class EvtHandler(Object): """ProcessPendingEvents(self)""" return _core_.EvtHandler_ProcessPendingEvents(*args, **kwargs) + def AllowReentrance(*args, **kwargs): + """AllowReentrance(self, bool allow=True)""" + return _core_.EvtHandler_AllowReentrance(*args, **kwargs) + + def IsReentranceAllowed(*args, **kwargs): + """IsReentranceAllowed(self) -> bool""" + return _core_.EvtHandler_IsReentranceAllowed(*args, **kwargs) + + def IsEventHandlingInProgress(*args, **kwargs): + """IsEventHandlingInProgress(self) -> bool""" + return _core_.EvtHandler_IsEventHandlingInProgress(*args, **kwargs) + def Connect(*args, **kwargs): """Connect(self, int id, int lastId, int eventType, PyObject func)""" return _core_.EvtHandler_Connect(*args, **kwargs) @@ -5871,6 +5961,10 @@ class UpdateUIEvent(CommandEvent): return _core_.UpdateUIEvent_GetMode(*args, **kwargs) GetMode = staticmethod(GetMode) + Checked = property(GetChecked,Check,doc="See `GetChecked`") + Enabled = property(GetEnabled,Enable,doc="See `GetEnabled`") + Shown = property(GetShown,Show,doc="See `GetShown`") + Text = property(GetText,SetText,doc="See `GetText` and `SetText`") _core_.UpdateUIEvent_swigregister(UpdateUIEvent) def UpdateUIEvent_SetUpdateInterval(*args, **kwargs): @@ -6275,6 +6369,7 @@ class WindowCreateEvent(CommandEvent): """ return _core_.WindowCreateEvent_GetWindow(*args, **kwargs) + Window = property(GetWindow,doc="See `GetWindow`") _core_.WindowCreateEvent_swigregister(WindowCreateEvent) class WindowDestroyEvent(CommandEvent): @@ -6314,6 +6409,7 @@ class WindowDestroyEvent(CommandEvent): """ return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs) + Window = property(GetWindow,doc="See `GetWindow`") _core_.WindowDestroyEvent_swigregister(WindowDestroyEvent) #--------------------------------------------------------------------------- @@ -6788,7 +6884,7 @@ class PyApp(EvtHandler): def GetLayoutDirection(*args, **kwargs): """ - GetLayoutDirection(self) -> wxLayoutDirection + GetLayoutDirection(self) -> int Return the layout direction for the current locale. """ @@ -7399,8 +7495,8 @@ in on the main display of your Mac.""" destroy(self) def Destroy(self): + self.this.own(False) wx.PyApp.Destroy(self) - self.thisown = 0 def SetTopWindow(self, frame): """Set the \"main\" top level window""" @@ -7715,10 +7811,11 @@ class AcceleratorTable(Object): _core_.AcceleratorTable_swiginit(self,_core_.new_AcceleratorTable(*args, **kwargs)) __swig_destroy__ = _core_.delete_AcceleratorTable __del__ = lambda self : None; - def Ok(*args, **kwargs): - """Ok(self) -> bool""" - return _core_.AcceleratorTable_Ok(*args, **kwargs) + def IsOk(*args, **kwargs): + """IsOk(self) -> bool""" + return _core_.AcceleratorTable_IsOk(*args, **kwargs) + Ok = IsOk _core_.AcceleratorTable_swigregister(AcceleratorTable) @@ -7805,9 +7902,8 @@ class Window(EvtHandler): Returns True if the window has either been successfully deleted, or it has been added to the list of windows pending real deletion. """ - val = _core_.Window_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _core_.Window_Destroy(*args, **kwargs) def DestroyChildren(*args, **kwargs): """ @@ -7932,7 +8028,7 @@ class Window(EvtHandler): PrevControlId = staticmethod(PrevControlId) def GetLayoutDirection(*args, **kwargs): """ - GetLayoutDirection(self) -> wxLayoutDirection + GetLayoutDirection(self) -> int Get the layout direction (LTR or RTL) for this window. Returns ``wx.Layout_Default`` if layout direction is not supported. @@ -7941,7 +8037,7 @@ class Window(EvtHandler): def SetLayoutDirection(*args, **kwargs): """ - SetLayoutDirection(self, wxLayoutDirection dir) + SetLayoutDirection(self, int dir) Set the layout direction (LTR or RTL) for this window. """ @@ -8792,14 +8888,16 @@ class Window(EvtHandler): SetEventHandler(self, EvtHandler handler) Sets the event handler for this window. An event handler is an object - that is capable of processing the events sent to a window. By default, - the window is its own event handler, but an application may wish to - substitute another, for example to allow central implementation of - event-handling for a variety of different window classes. + that is capable of processing the events sent to a window. (In other + words, is able to dispatch the events to handler function.) By + default, the window is its own event handler, but an application may + wish to substitute another, for example to allow central + implementation of event-handling for a variety of different window + classes. It is usually better to use `wx.Window.PushEventHandler` since this sets up a chain of event handlers, where an event not handled by one event - handler is handed to the next one in the chain. + handler is handed off to the next one in the chain. """ return _core_.Window_SetEventHandler(*args, **kwargs) @@ -8809,15 +8907,19 @@ class Window(EvtHandler): Pushes this event handler onto the event handler stack for the window. An event handler is an object that is capable of processing the events - sent to a window. By default, the window is its own event handler, but - an application may wish to substitute another, for example to allow - central implementation of event-handling for a variety of different - window classes. + sent to a window. (In other words, is able to dispatch the events to + handler function.) By default, the window is its own event handler, + but an application may wish to substitute another, for example to + allow central implementation of event-handling for a variety of + different window classes. wx.Window.PushEventHandler allows an application to set up a chain of event handlers, where an event not handled by one event handler is - handed to the next one in the chain. Use `wx.Window.PopEventHandler` to - remove the event handler. + handed to the next one in the chain. Use `wx.Window.PopEventHandler` + to remove the event handler. Ownership of the handler is *not* given + to the window, so you should be sure to pop the handler before the + window is destroyed and either let PopEventHandler destroy it, or call + its Destroy method yourself. """ return _core_.Window_PushEventHandler(*args, **kwargs) @@ -8827,7 +8929,7 @@ class Window(EvtHandler): Removes and returns the top-most event handler on the event handler stack. If deleteHandler is True then the wx.EvtHandler object will be - destroyed after it is popped. + destroyed after it is popped, and ``None`` will be returned instead. """ return _core_.Window_PopEventHandler(*args, **kwargs) @@ -8836,7 +8938,7 @@ class Window(EvtHandler): RemoveEventHandler(self, EvtHandler handler) -> bool Find the given handler in the event handler chain and remove (but not - delete) it from the event handler chain, return True if it was found + delete) it from the event handler chain, returns True if it was found and False otherwise (this also results in an assert failure so this function should only be called when the handler is supposed to be there.) @@ -9086,7 +9188,7 @@ class Window(EvtHandler): window instead of waiting for the EVT_PAINT event to happen, (normally this would usually only happen when the flow of control returns to the event loop.) Notice that this function doesn't refresh the window and - does nothing if the window has been already repainted. Use Refresh + does nothing if the window has been already repainted. Use `Refresh` first if you want to immediately redraw the window (or some portion of it) unconditionally. """ @@ -9149,6 +9251,17 @@ class Window(EvtHandler): """ return _core_.Window_PrepareDC(*args, **kwargs) + def IsDoubleBuffered(*args, **kwargs): + """ + IsDoubleBuffered(self) -> bool + + Returns ``True`` if the window contents is double-buffered by the + system, i.e. if any drawing done on the window is really done on a + temporary backing surface and transferred to the screen all at once + later. + """ + return _core_.Window_IsDoubleBuffered(*args, **kwargs) + def GetUpdateRegion(*args, **kwargs): """ GetUpdateRegion(self) -> Region @@ -9995,6 +10108,7 @@ class Window(EvtHandler): HelpText = property(GetHelpText,SetHelpText,doc="See `GetHelpText` and `SetHelpText`") Id = property(GetId,SetId,doc="See `GetId` and `SetId`") Label = property(GetLabel,SetLabel,doc="See `GetLabel` and `SetLabel`") + LayoutDirection = property(GetLayoutDirection,SetLayoutDirection,doc="See `GetLayoutDirection` and `SetLayoutDirection`") MaxHeight = property(GetMaxHeight,doc="See `GetMaxHeight`") MaxSize = property(GetMaxSize,SetMaxSize,doc="See `GetMaxSize` and `SetMaxSize`") MaxWidth = property(GetMaxWidth,doc="See `GetMaxWidth`") @@ -10210,6 +10324,7 @@ class Validator(EvtHandler): return _core_.Validator_SetBellOnError(*args, **kwargs) SetBellOnError = staticmethod(SetBellOnError) + Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`") _core_.Validator_swigregister(Validator) def Validator_IsSilent(*args): @@ -10359,29 +10474,16 @@ class Menu(EvtHandler): Deletes the C++ object this Python object is a proxy for. """ - val = _core_.Menu_Destroy(*args, **kwargs) - args[0].thisown = 0 - return val + args[0].this.own(False) + return _core_.Menu_Destroy(*args, **kwargs) def DestroyId(*args, **kwargs): - """ - DestroyId(self, int id) -> bool - - Deletes the C++ object this Python object is a proxy for. - """ - val = _core_.Menu_DestroyId(*args, **kwargs) - args[0].thisown = 0 - return val + """DestroyId(self, int id) -> bool""" + return _core_.Menu_DestroyId(*args, **kwargs) def DestroyItem(*args, **kwargs): - """ - DestroyItem(self, MenuItem item) -> bool - - Deletes the C++ object this Python object is a proxy for. - """ - val = _core_.Menu_DestroyItem(*args, **kwargs) - args[0].thisown = 0 - return val + """DestroyItem(self, MenuItem item) -> bool""" + return _core_.Menu_DestroyItem(*args, **kwargs) def GetMenuItemCount(*args, **kwargs): """GetMenuItemCount(self) -> size_t""" @@ -10923,14 +11025,6 @@ class Control(Window): """ return _core_.Control_Command(*args, **kwargs) - def GetLabel(*args, **kwargs): - """ - GetLabel(self) -> String - - Return a control's text. - """ - return _core_.Control_GetLabel(*args, **kwargs) - def GetClassDefaultAttributes(*args, **kwargs): """ GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes @@ -10950,7 +11044,6 @@ class Control(Window): GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes) Alignment = property(GetAlignment,doc="See `GetAlignment`") - Label = property(GetLabel,doc="See `GetLabel`") LabelText = property(GetLabelText,doc="See `GetLabelText`") _core_.Control_swigregister(Control) ControlNameStr = cvar.ControlNameStr @@ -13403,7 +13496,7 @@ def CallAfter(callable, *args, **kw): 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` + :see: `wx.CallLater` """ app = wx.GetApp() assert app is not None, 'No wx.App created yet' @@ -13422,7 +13515,7 @@ def CallAfter(callable, *args, **kw): #---------------------------------------------------------------------------- -class FutureCall: +class CallLater: """ A convenience class for `wx.Timer`, that calls the given callable object once after the given amount of milliseconds, passing any @@ -13433,7 +13526,7 @@ class FutureCall: then there is no need to hold a reference to this object. It will hold a reference to itself while the timer is running (the timer has a reference to self.Notify) but the cycle will be broken when - the timer completes, automatically cleaning up the wx.FutureCall + the timer completes, automatically cleaning up the wx.CallLater object. :see: `wx.CallAfter` @@ -13523,6 +13616,9 @@ class FutureCall: Result = property(GetResult) +class FutureCall(CallLater): + """A compatibility alias for `CallLater`.""" + #---------------------------------------------------------------------------- # Control which items in this module should be documented by epydoc. # We allow only classes and functions, which will help reduce the size