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):
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)
_wxPySetDictionary = _core_._wxPySetDictionary
cvar = _core_.cvar
"""
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)
"""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)
"""
return _core_.Rect___ne__(*args, **kwargs)
- def InsideXY(*args, **kwargs):
+ def ContainsXY(*args, **kwargs):
"""
- InsideXY(self, int x, int y) -> bool
+ ContainsXY(self, int x, int y) -> bool
- Return True if the point is (not strcitly) inside the rect.
+ Return True if the point is inside the rect.
"""
- return _core_.Rect_InsideXY(*args, **kwargs)
+ return _core_.Rect_ContainsXY(*args, **kwargs)
- def Inside(*args, **kwargs):
+ def Contains(*args, **kwargs):
"""
- Inside(self, Point pt) -> bool
+ Contains(self, Point pt) -> bool
- Return True if the point is (not strcitly) inside the rect.
+ Return True if the point is inside the rect.
"""
- return _core_.Rect_Inside(*args, **kwargs)
+ return _core_.Rect_Contains(*args, **kwargs)
- def InsideRect(*args, **kwargs):
+ def ContainsRect(*args, **kwargs):
"""
- InsideRect(self, Rect rect) -> bool
+ ContainsRect(self, Rect rect) -> bool
Returns ``True`` if the given rectangle is completely inside this
rectangle or touches its boundary.
"""
- return _core_.Rect_InsideRect(*args, **kwargs)
+ 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 = Contains
+ InsideXY = ContainsXY
+ InsideRect = ContainsRect
def Intersects(*args, **kwargs):
"""
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.Rect, self.Get())
+ 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`")
+ Right = property(GetRight,SetRight,doc="See `GetRight` and `SetRight`")
+ 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`")
+ Empty = property(IsEmpty,doc="See `IsEmpty`")
_core_.Rect_swigregister(Rect)
def RectPP(*args, **kwargs):
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)
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.Point2D, self.Get())
+ Floor = property(GetFloor,doc="See `GetFloor`")
+ Rounded = property(GetRounded,doc="See `GetRounded`")
+ VectorAngle = property(GetVectorAngle,SetVectorAngle,doc="See `GetVectorAngle` and `SetVectorAngle`")
+ VectorLength = property(GetVectorLength,SetVectorLength,doc="See `GetVectorLength` and `SetVectorLength`")
_core_.Point2D_swigregister(Point2D)
def Point2DCopy(*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):
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
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.
"""
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
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`")
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)
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)
"""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)
"""
Skip(self, bool skip=True)
- Called by an event handler, it controls whether additional event
- handlers bound to this event will be called after the current event
- handler returns. Skip(false) (the default setting) will prevent
- additional event handlers from being called and control will be
- returned to the sender of the event immediately after the current
- handler has finished. Skip(True) will cause the event processing
- system to continue searching for a handler function for this event.
-
+ This method can be used inside an event handler to control whether
+ further event handlers bound to this event will be called after the
+ current one returns. Without Skip() (or equivalently if Skip(False) is
+ used), the event will not be processed any more. If Skip(True) is
+ called, the event processing system continues searching for a further
+ handler function for this event, even though it has been processed
+ already in the current handler.
"""
return _core_.Event_Skip(*args, **kwargs)
"""SetPosition(self, int pos)"""
return _core_.ScrollEvent_SetPosition(*args, **kwargs)
+ Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
+ Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
_core_.ScrollEvent_swigregister(ScrollEvent)
#---------------------------------------------------------------------------
"""SetPosition(self, int pos)"""
return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
+ Orientation = property(GetOrientation,SetOrientation,doc="See `GetOrientation` and `SetOrientation`")
+ Position = property(GetPosition,SetPosition,doc="See `GetPosition` and `SetPosition`")
_core_.ScrollWinEvent_swigregister(ScrollWinEvent)
#---------------------------------------------------------------------------
"""
return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
+ Cursor = property(GetCursor,SetCursor,doc="See `GetCursor` and `SetCursor`")
+ X = property(GetX,doc="See `GetX`")
+ Y = property(GetY,doc="See `GetY`")
_core_.SetCursorEvent_swigregister(SetCursorEvent)
#---------------------------------------------------------------------------
m_size = property(_core_.SizeEvent_m_size_get, _core_.SizeEvent_m_size_set)
m_rect = property(_core_.SizeEvent_m_rect_get, _core_.SizeEvent_m_rect_set)
+ Rect = property(GetRect,SetRect,doc="See `GetRect` and `SetRect`")
+ Size = property(GetSize,SetSize,doc="See `GetSize` and `SetSize`")
_core_.SizeEvent_swigregister(SizeEvent)
#---------------------------------------------------------------------------
class ChildFocusEvent(CommandEvent):
"""
- wx.ChildFocusEvent notifies the parent that a child has received the
- focus. Unlike `wx.FocusEvent` it is propagated up the window
- heirarchy.
+ A child focus event is sent to a (parent-)window when one of its child
+ windows gains focus, so that the window could restore the focus back
+ to its corresponding child if it loses it now and regains later.
+
+ Notice that child window is the direct child of the window receiving
+ the event, and so may not be the actual widget recieving focus if it
+ is further down the containment heirarchy. Use `wx.Window.FindFocus`
+ to get the widget that is actually receiving focus.
"""
thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
__repr__ = _swig_repr
"""
GetWindow(self) -> Window
- The window which has just received the focus.
+ The window, or (grand)parent of the window which has just received the
+ focus.
"""
return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
"""GetShow(self) -> bool"""
return _core_.ShowEvent_GetShow(*args, **kwargs)
+ Show = property(GetShow,SetShow,doc="See `GetShow` and `SetShow`")
_core_.ShowEvent_swigregister(ShowEvent)
#---------------------------------------------------------------------------
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):
"""GetChangedWindow(self) -> Window"""
return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
+ ChangedWindow = property(GetChangedWindow,SetChangedWindow,doc="See `GetChangedWindow` and `SetChangedWindow`")
_core_.PaletteChangedEvent_swigregister(PaletteChangedEvent)
#---------------------------------------------------------------------------
"""GetPaletteRealized(self) -> bool"""
return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
+ PaletteRealized = property(GetPaletteRealized,SetPaletteRealized,doc="See `GetPaletteRealized` and `SetPaletteRealized`")
_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
#---------------------------------------------------------------------------
"""
return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
+ Window = property(GetWindow,doc="See `GetWindow`")
_core_.WindowCreateEvent_swigregister(WindowCreateEvent)
class WindowDestroyEvent(CommandEvent):
"""
return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
+ Window = property(GetWindow,doc="See `GetWindow`")
_core_.WindowDestroyEvent_swigregister(WindowDestroyEvent)
#---------------------------------------------------------------------------
def GetLayoutDirection(*args, **kwargs):
"""
- GetLayoutDirection(self) -> wxLayoutDirection
+ GetLayoutDirection(self) -> int
Return the layout direction for the current locale.
"""
return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
GetComCtl32Version = staticmethod(GetComCtl32Version)
- def DisplayAvailable(*args, **kwargs):
+ def IsDisplayAvailable(*args, **kwargs):
"""
- DisplayAvailable() -> bool
+ IsDisplayAvailable() -> bool
Tests if it is possible to create a GUI in the current environment.
This will mean different things on the different platforms.
* On MS Windows...
"""
- return _core_.PyApp_DisplayAvailable(*args, **kwargs)
-
- DisplayAvailable = staticmethod(DisplayAvailable)
+ return _core_.PyApp_IsDisplayAvailable(*args, **kwargs)
+
+ IsDisplayAvailable = staticmethod(IsDisplayAvailable)
+ AppName = property(GetAppName,SetAppName,doc="See `GetAppName` and `SetAppName`")
+ AssertMode = property(GetAssertMode,SetAssertMode,doc="See `GetAssertMode` and `SetAssertMode`")
+ ClassName = property(GetClassName,SetClassName,doc="See `GetClassName` and `SetClassName`")
+ ExitOnFrameDelete = property(GetExitOnFrameDelete,SetExitOnFrameDelete,doc="See `GetExitOnFrameDelete` and `SetExitOnFrameDelete`")
+ LayoutDirection = property(GetLayoutDirection,doc="See `GetLayoutDirection`")
+ PrintMode = property(GetPrintMode,SetPrintMode,doc="See `GetPrintMode` and `SetPrintMode`")
+ TopWindow = property(GetTopWindow,SetTopWindow,doc="See `GetTopWindow` and `SetTopWindow`")
+ Traits = property(GetTraits,doc="See `GetTraits`")
+ UseBestVisual = property(GetUseBestVisual,SetUseBestVisual,doc="See `GetUseBestVisual` and `SetUseBestVisual`")
+ VendorName = property(GetVendorName,SetVendorName,doc="See `GetVendorName` and `SetVendorName`")
+ Active = property(IsActive)
_core_.PyApp_swigregister(PyApp)
def PyApp_IsMainLoopRunning(*args):
"""
return _core_.PyApp_GetComCtl32Version(*args)
-def PyApp_DisplayAvailable(*args):
+def PyApp_IsDisplayAvailable(*args):
"""
- PyApp_DisplayAvailable() -> bool
+ PyApp_IsDisplayAvailable() -> bool
Tests if it is possible to create a GUI in the current environment.
This will mean different things on the different platforms.
* On MS Windows...
"""
- return _core_.PyApp_DisplayAvailable(*args)
+ return _core_.PyApp_IsDisplayAvailable(*args)
#---------------------------------------------------------------------------
wx.PyApp.__init__(self)
# make sure we can create a GUI
- if not self.DisplayAvailable():
+ if not self.IsDisplayAvailable():
if wx.Platform == "__WXMAC__":
msg = """This program needs access to the screen.
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"""
_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)
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):
"""
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.
def SetLayoutDirection(*args, **kwargs):
"""
- SetLayoutDirection(self, wxLayoutDirection dir)
+ SetLayoutDirection(self, int dir)
Set the layout direction (LTR or RTL) for this window.
"""
"""
return _core_.Window_IsEnabled(*args, **kwargs)
+ def IsShownOnScreen(*args, **kwargs):
+ """
+ IsShownOnScreen(self) -> bool
+
+ Returns ``True`` if the window is physically visible on the screen,
+ i.e. it is shown and all its parents up to the toplevel window are
+ shown as well.
+ """
+ return _core_.Window_IsShownOnScreen(*args, **kwargs)
+
def SetWindowStyleFlag(*args, **kwargs):
"""
SetWindowStyleFlag(self, long style)
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)
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)
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)
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.)
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.
"""
"""
return _core_.Window_Freeze(*args, **kwargs)
+ def IsFrozen(*args, **kwargs):
+ """
+ IsFrozen(self) -> bool
+
+ Returns ``True`` if the window has been frozen and not thawed yet.
+
+ :see: `Freeze` and `Thaw`
+ """
+ return _core_.Window_IsFrozen(*args, **kwargs)
+
def Thaw(*args, **kwargs):
"""
Thaw(self)
"""
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
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`")
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):
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"""
"""
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
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
"""
return _core_.SizerItem_SetUserData(*args, **kwargs)
+ Border = property(GetBorder,SetBorder,doc="See `GetBorder` and `SetBorder`")
+ Flag = property(GetFlag,SetFlag,doc="See `GetFlag` and `SetFlag`")
+ MinSize = property(GetMinSize,doc="See `GetMinSize`")
+ MinSizeWithBorder = property(GetMinSizeWithBorder,doc="See `GetMinSizeWithBorder`")
+ Position = property(GetPosition,doc="See `GetPosition`")
+ Proportion = property(GetProportion,SetProportion,doc="See `GetProportion` and `SetProportion`")
+ Ratio = property(GetRatio,SetRatio,doc="See `GetRatio` and `SetRatio`")
+ Rect = property(GetRect,doc="See `GetRect`")
+ Size = property(GetSize,doc="See `GetSize`")
+ Sizer = property(GetSizer,SetSizer,doc="See `GetSizer` and `SetSizer`")
+ Spacer = property(GetSpacer,SetSpacer,doc="See `GetSpacer` and `SetSpacer`")
+ UserData = property(GetUserData,SetUserData,doc="See `GetUserData` and `SetUserData`")
+ Window = property(GetWindow,SetWindow,doc="See `GetWindow` and `SetWindow`")
_core_.SizerItem_swigregister(SizerItem)
def SizerItemWindow(*args, **kwargs):
"""
return _core_.Sizer_ShowItems(*args, **kwargs)
+ Children = property(GetChildren,doc="See `GetChildren`")
+ ContainingWindow = property(GetContainingWindow,SetContainingWindow,doc="See `GetContainingWindow` and `SetContainingWindow`")
+ MinSize = property(GetMinSize,SetMinSize,doc="See `GetMinSize` and `SetMinSize`")
+ Position = property(GetPosition,doc="See `GetPosition`")
+ Size = property(GetSize,doc="See `GetSize`")
_core_.Sizer_swigregister(Sizer)
class PySizer(Sizer):
"""
return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
+ StaticBox = property(GetStaticBox,doc="See `GetStaticBox`")
_core_.StaticBoxSizer_swigregister(StaticBoxSizer)
#---------------------------------------------------------------------------
"""GetHelpButton(self) -> wxButton"""
return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
+ AffirmativeButton = property(GetAffirmativeButton,SetAffirmativeButton,doc="See `GetAffirmativeButton` and `SetAffirmativeButton`")
+ ApplyButton = property(GetApplyButton,doc="See `GetApplyButton`")
+ CancelButton = property(GetCancelButton,SetCancelButton,doc="See `GetCancelButton` and `SetCancelButton`")
+ HelpButton = property(GetHelpButton,doc="See `GetHelpButton`")
+ NegativeButton = property(GetNegativeButton,SetNegativeButton,doc="See `GetNegativeButton` and `SetNegativeButton`")
_core_.StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
#---------------------------------------------------------------------------
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'
#----------------------------------------------------------------------------
-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
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`
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
projects / wxWidgets.git / blobdiff