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):
"""
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_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):
"""
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`")
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`")
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):
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.
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)
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):
"""
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.
"""
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.
"""
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.)
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):
"""
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
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