-# This file was created automatically by SWIG.
+# This file was created automatically by SWIG 1.3.29.
# Don't modify this file, modify the SWIG interface instead.
import _core_
+import new
+new_instancemethod = new.instancemethod
+def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
+ if (name == "thisown"): return self.this.own(value)
+ if (name == "this"):
+ if type(value).__name__ == 'PySwigObject':
+ self.__dict__[name] = value
+ return
+ method = class_type.__swig_setmethods__.get(name,None)
+ if method: return method(self,value)
+ if (not static) or hasattr(self,name):
+ self.__dict__[name] = value
+ else:
+ raise AttributeError("You cannot add attributes to %s" % self)
+
+def _swig_setattr(self,class_type,name,value):
+ return _swig_setattr_nondynamic(self,class_type,name,value,0)
+
+def _swig_getattr(self,class_type,name):
+ if (name == "thisown"): return self.this.own()
+ method = class_type.__swig_getmethods__.get(name,None)
+ if method: return method(self)
+ raise AttributeError,name
+
+def _swig_repr(self):
+ try: strthis = "proxy of " + self.this.__repr__()
+ except: strthis = ""
+ return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)
+
+import types
+try:
+ _object = types.ObjectType
+ _newclass = 1
+except AttributeError:
+ class _object : pass
+ _newclass = 0
+del types
+
+
+def _swig_setattr_nondynamic_method(set):
+ def set_attr(self,name,value):
+ if (name == "thisown"): return self.this.own(value)
+ if hasattr(self,name) or (name == "this"):
+ set(self,name,value)
+ else:
+ raise AttributeError("You cannot add attributes to %s" % self)
+ return set_attr
+
#// Give a reference to the dictionary of this module to the C++ extension
#// code.
STATIC_BORDER = _core_.STATIC_BORDER
TRANSPARENT_WINDOW = _core_.TRANSPARENT_WINDOW
NO_BORDER = _core_.NO_BORDER
+DEFAULT_CONTROL_BORDER = _core_.DEFAULT_CONTROL_BORDER
+DEFAULT_STATUSBAR_STYLE = _core_.DEFAULT_STATUSBAR_STYLE
TAB_TRAVERSAL = _core_.TAB_TRAVERSAL
WANTS_CHARS = _core_.WANTS_CHARS
POPUP_WINDOW = _core_.POPUP_WINDOW
CENTER_FRAME = _core_.CENTER_FRAME
CENTRE_ON_SCREEN = _core_.CENTRE_ON_SCREEN
CENTER_ON_SCREEN = _core_.CENTER_ON_SCREEN
-ED_CLIENT_MARGIN = _core_.ED_CLIENT_MARGIN
-ED_BUTTONS_BOTTOM = _core_.ED_BUTTONS_BOTTOM
-ED_BUTTONS_RIGHT = _core_.ED_BUTTONS_RIGHT
-ED_STATIC_LINE = _core_.ED_STATIC_LINE
-EXT_DIALOG_STYLE = _core_.EXT_DIALOG_STYLE
CLIP_CHILDREN = _core_.CLIP_CHILDREN
CLIP_SIBLINGS = _core_.CLIP_SIBLINGS
ALWAYS_SHOW_SB = _core_.ALWAYS_SHOW_SB
RA_VERTICAL = _core_.RA_VERTICAL
RA_SPECIFY_ROWS = _core_.RA_SPECIFY_ROWS
RA_SPECIFY_COLS = _core_.RA_SPECIFY_COLS
+RA_USE_CHECKBOX = _core_.RA_USE_CHECKBOX
RB_GROUP = _core_.RB_GROUP
RB_SINGLE = _core_.RB_SINGLE
-SL_HORIZONTAL = _core_.SL_HORIZONTAL
-SL_VERTICAL = _core_.SL_VERTICAL
-SL_AUTOTICKS = _core_.SL_AUTOTICKS
-SL_LABELS = _core_.SL_LABELS
-SL_LEFT = _core_.SL_LEFT
-SL_TOP = _core_.SL_TOP
-SL_RIGHT = _core_.SL_RIGHT
-SL_BOTTOM = _core_.SL_BOTTOM
-SL_BOTH = _core_.SL_BOTH
-SL_SELRANGE = _core_.SL_SELRANGE
SB_HORIZONTAL = _core_.SB_HORIZONTAL
SB_VERTICAL = _core_.SB_VERTICAL
+RB_USE_CHECKBOX = _core_.RB_USE_CHECKBOX
ST_SIZEGRIP = _core_.ST_SIZEGRIP
ST_NO_AUTORESIZE = _core_.ST_NO_AUTORESIZE
FLOOD_SURFACE = _core_.FLOOD_SURFACE
SIZE_AUTO = _core_.SIZE_AUTO
SIZE_USE_EXISTING = _core_.SIZE_USE_EXISTING
SIZE_ALLOW_MINUS_ONE = _core_.SIZE_ALLOW_MINUS_ONE
+SIZE_FORCE = _core_.SIZE_FORCE
PORTRAIT = _core_.PORTRAIT
LANDSCAPE = _core_.LANDSCAPE
PRINT_QUALITY_HIGH = _core_.PRINT_QUALITY_HIGH
PRINT_QUALITY_DRAFT = _core_.PRINT_QUALITY_DRAFT
ID_ANY = _core_.ID_ANY
ID_SEPARATOR = _core_.ID_SEPARATOR
+ID_NONE = _core_.ID_NONE
ID_LOWEST = _core_.ID_LOWEST
ID_OPEN = _core_.ID_OPEN
ID_CLOSE = _core_.ID_CLOSE
ID_ABORT = _core_.ID_ABORT
ID_RETRY = _core_.ID_RETRY
ID_IGNORE = _core_.ID_IGNORE
+ID_ADD = _core_.ID_ADD
+ID_REMOVE = _core_.ID_REMOVE
+ID_UP = _core_.ID_UP
+ID_DOWN = _core_.ID_DOWN
+ID_HOME = _core_.ID_HOME
+ID_REFRESH = _core_.ID_REFRESH
+ID_STOP = _core_.ID_STOP
+ID_INDEX = _core_.ID_INDEX
+ID_BOLD = _core_.ID_BOLD
+ID_ITALIC = _core_.ID_ITALIC
+ID_JUSTIFY_CENTER = _core_.ID_JUSTIFY_CENTER
+ID_JUSTIFY_FILL = _core_.ID_JUSTIFY_FILL
+ID_JUSTIFY_RIGHT = _core_.ID_JUSTIFY_RIGHT
+ID_JUSTIFY_LEFT = _core_.ID_JUSTIFY_LEFT
+ID_UNDERLINE = _core_.ID_UNDERLINE
+ID_INDENT = _core_.ID_INDENT
+ID_UNINDENT = _core_.ID_UNINDENT
+ID_ZOOM_100 = _core_.ID_ZOOM_100
+ID_ZOOM_FIT = _core_.ID_ZOOM_FIT
+ID_ZOOM_IN = _core_.ID_ZOOM_IN
+ID_ZOOM_OUT = _core_.ID_ZOOM_OUT
+ID_UNDELETE = _core_.ID_UNDELETE
+ID_REVERT_TO_SAVED = _core_.ID_REVERT_TO_SAVED
ID_HIGHEST = _core_.ID_HIGHEST
OPEN = _core_.OPEN
SAVE = _core_.SAVE
PD_ELAPSED_TIME = _core_.PD_ELAPSED_TIME
PD_ESTIMATED_TIME = _core_.PD_ESTIMATED_TIME
PD_REMAINING_TIME = _core_.PD_REMAINING_TIME
+PD_SMOOTH = _core_.PD_SMOOTH
+PD_CAN_SKIP = _core_.PD_CAN_SKIP
DD_NEW_DIR_BUTTON = _core_.DD_NEW_DIR_BUTTON
DD_DEFAULT_STYLE = _core_.DD_DEFAULT_STYLE
MENU_TEAROFF = _core_.MENU_TEAROFF
BORDER_SUNKEN = _core_.BORDER_SUNKEN
BORDER_DOUBLE = _core_.BORDER_DOUBLE
BORDER_MASK = _core_.BORDER_MASK
+BG_STYLE_SYSTEM = _core_.BG_STYLE_SYSTEM
+BG_STYLE_COLOUR = _core_.BG_STYLE_COLOUR
+BG_STYLE_CUSTOM = _core_.BG_STYLE_CUSTOM
DEFAULT = _core_.DEFAULT
DECORATIVE = _core_.DECORATIVE
ROMAN = _core_.ROMAN
USER_DASH = _core_.USER_DASH
TRANSPARENT = _core_.TRANSPARENT
STIPPLE = _core_.STIPPLE
+STIPPLE_MASK = _core_.STIPPLE_MASK
+STIPPLE_MASK_OPAQUE = _core_.STIPPLE_MASK_OPAQUE
BDIAGONAL_HATCH = _core_.BDIAGONAL_HATCH
CROSSDIAG_HATCH = _core_.CROSSDIAG_HATCH
FDIAGONAL_HATCH = _core_.FDIAGONAL_HATCH
WXK_WINDOWS_LEFT = _core_.WXK_WINDOWS_LEFT
WXK_WINDOWS_RIGHT = _core_.WXK_WINDOWS_RIGHT
WXK_WINDOWS_MENU = _core_.WXK_WINDOWS_MENU
+WXK_COMMAND = _core_.WXK_COMMAND
+WXK_SPECIAL1 = _core_.WXK_SPECIAL1
+WXK_SPECIAL2 = _core_.WXK_SPECIAL2
+WXK_SPECIAL3 = _core_.WXK_SPECIAL3
+WXK_SPECIAL4 = _core_.WXK_SPECIAL4
+WXK_SPECIAL5 = _core_.WXK_SPECIAL5
+WXK_SPECIAL6 = _core_.WXK_SPECIAL6
+WXK_SPECIAL7 = _core_.WXK_SPECIAL7
+WXK_SPECIAL8 = _core_.WXK_SPECIAL8
+WXK_SPECIAL9 = _core_.WXK_SPECIAL9
+WXK_SPECIAL10 = _core_.WXK_SPECIAL10
+WXK_SPECIAL11 = _core_.WXK_SPECIAL11
+WXK_SPECIAL12 = _core_.WXK_SPECIAL12
+WXK_SPECIAL13 = _core_.WXK_SPECIAL13
+WXK_SPECIAL14 = _core_.WXK_SPECIAL14
+WXK_SPECIAL15 = _core_.WXK_SPECIAL15
+WXK_SPECIAL16 = _core_.WXK_SPECIAL16
+WXK_SPECIAL17 = _core_.WXK_SPECIAL17
+WXK_SPECIAL18 = _core_.WXK_SPECIAL18
+WXK_SPECIAL19 = _core_.WXK_SPECIAL19
+WXK_SPECIAL20 = _core_.WXK_SPECIAL20
PAPER_NONE = _core_.PAPER_NONE
PAPER_LETTER = _core_.PAPER_LETTER
PAPER_LEGAL = _core_.PAPER_LEGAL
PAPER_A2 = _core_.PAPER_A2
PAPER_A3_TRANSVERSE = _core_.PAPER_A3_TRANSVERSE
PAPER_A3_EXTRA_TRANSVERSE = _core_.PAPER_A3_EXTRA_TRANSVERSE
+PAPER_DBL_JAPANESE_POSTCARD = _core_.PAPER_DBL_JAPANESE_POSTCARD
+PAPER_A6 = _core_.PAPER_A6
+PAPER_JENV_KAKU2 = _core_.PAPER_JENV_KAKU2
+PAPER_JENV_KAKU3 = _core_.PAPER_JENV_KAKU3
+PAPER_JENV_CHOU3 = _core_.PAPER_JENV_CHOU3
+PAPER_JENV_CHOU4 = _core_.PAPER_JENV_CHOU4
+PAPER_LETTER_ROTATED = _core_.PAPER_LETTER_ROTATED
+PAPER_A3_ROTATED = _core_.PAPER_A3_ROTATED
+PAPER_A4_ROTATED = _core_.PAPER_A4_ROTATED
+PAPER_A5_ROTATED = _core_.PAPER_A5_ROTATED
+PAPER_B4_JIS_ROTATED = _core_.PAPER_B4_JIS_ROTATED
+PAPER_B5_JIS_ROTATED = _core_.PAPER_B5_JIS_ROTATED
+PAPER_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_JAPANESE_POSTCARD_ROTATED
+PAPER_DBL_JAPANESE_POSTCARD_ROTATED = _core_.PAPER_DBL_JAPANESE_POSTCARD_ROTATED
+PAPER_A6_ROTATED = _core_.PAPER_A6_ROTATED
+PAPER_JENV_KAKU2_ROTATED = _core_.PAPER_JENV_KAKU2_ROTATED
+PAPER_JENV_KAKU3_ROTATED = _core_.PAPER_JENV_KAKU3_ROTATED
+PAPER_JENV_CHOU3_ROTATED = _core_.PAPER_JENV_CHOU3_ROTATED
+PAPER_JENV_CHOU4_ROTATED = _core_.PAPER_JENV_CHOU4_ROTATED
+PAPER_B6_JIS = _core_.PAPER_B6_JIS
+PAPER_B6_JIS_ROTATED = _core_.PAPER_B6_JIS_ROTATED
+PAPER_12X11 = _core_.PAPER_12X11
+PAPER_JENV_YOU4 = _core_.PAPER_JENV_YOU4
+PAPER_JENV_YOU4_ROTATED = _core_.PAPER_JENV_YOU4_ROTATED
+PAPER_P16K = _core_.PAPER_P16K
+PAPER_P32K = _core_.PAPER_P32K
+PAPER_P32KBIG = _core_.PAPER_P32KBIG
+PAPER_PENV_1 = _core_.PAPER_PENV_1
+PAPER_PENV_2 = _core_.PAPER_PENV_2
+PAPER_PENV_3 = _core_.PAPER_PENV_3
+PAPER_PENV_4 = _core_.PAPER_PENV_4
+PAPER_PENV_5 = _core_.PAPER_PENV_5
+PAPER_PENV_6 = _core_.PAPER_PENV_6
+PAPER_PENV_7 = _core_.PAPER_PENV_7
+PAPER_PENV_8 = _core_.PAPER_PENV_8
+PAPER_PENV_9 = _core_.PAPER_PENV_9
+PAPER_PENV_10 = _core_.PAPER_PENV_10
+PAPER_P16K_ROTATED = _core_.PAPER_P16K_ROTATED
+PAPER_P32K_ROTATED = _core_.PAPER_P32K_ROTATED
+PAPER_P32KBIG_ROTATED = _core_.PAPER_P32KBIG_ROTATED
+PAPER_PENV_1_ROTATED = _core_.PAPER_PENV_1_ROTATED
+PAPER_PENV_2_ROTATED = _core_.PAPER_PENV_2_ROTATED
+PAPER_PENV_3_ROTATED = _core_.PAPER_PENV_3_ROTATED
+PAPER_PENV_4_ROTATED = _core_.PAPER_PENV_4_ROTATED
+PAPER_PENV_5_ROTATED = _core_.PAPER_PENV_5_ROTATED
+PAPER_PENV_6_ROTATED = _core_.PAPER_PENV_6_ROTATED
+PAPER_PENV_7_ROTATED = _core_.PAPER_PENV_7_ROTATED
+PAPER_PENV_8_ROTATED = _core_.PAPER_PENV_8_ROTATED
+PAPER_PENV_9_ROTATED = _core_.PAPER_PENV_9_ROTATED
+PAPER_PENV_10_ROTATED = _core_.PAPER_PENV_10_ROTATED
DUPLEX_SIMPLEX = _core_.DUPLEX_SIMPLEX
DUPLEX_HORIZONTAL = _core_.DUPLEX_HORIZONTAL
DUPLEX_VERTICAL = _core_.DUPLEX_VERTICAL
MOD_NONE = _core_.MOD_NONE
MOD_ALT = _core_.MOD_ALT
MOD_CONTROL = _core_.MOD_CONTROL
+MOD_ALTGR = _core_.MOD_ALTGR
MOD_SHIFT = _core_.MOD_SHIFT
+MOD_META = _core_.MOD_META
MOD_WIN = _core_.MOD_WIN
+MOD_CMD = _core_.MOD_CMD
+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
The base class for most wx objects, although in wxPython not
much functionality is needed nor exposed.
"""
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxObject instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
def GetClassName(*args, **kwargs):
"""
GetClassName(self) -> String
Deletes the C++ object this Python object is a proxy for.
"""
- return _core_.Object_Destroy(*args, **kwargs)
-
+ val = _core_.Object_Destroy(*args, **kwargs)
+ args[0].thisown = 0
+ return val
-class ObjectPtr(Object):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Object
-_core_.Object_swigregister(ObjectPtr)
+Object_swigregister = _core_.Object_swigregister
+Object_swigregister(Object)
_wxPySetDictionary = _core_._wxPySetDictionary
-
_wxPyFixStockObjects = _core_._wxPyFixStockObjects
-
cvar = _core_.cvar
EmptyString = cvar.EmptyString
class Size(object):
"""
wx.Size is a useful data structure used to represent the size of
- something. It simply contians integer width and height proprtites.
- In most places in wxPython where a wx.Size is expected a
- (width,height) tuple can be used instead.
+ something. It simply contains integer width and height
+ properties. In most places in wxPython where a wx.Size is
+ expected a (width, height) tuple can be used instead.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxSize instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
width = property(_core_.Size_width_get, _core_.Size_width_set)
height = property(_core_.Size_height_get, _core_.Size_height_set)
x = width; y = height
- def __init__(self, *args, **kwargs):
+ def __init__(self, *args, **kwargs):
"""
__init__(self, int w=0, int h=0) -> Size
Creates a size object.
"""
- newobj = _core_.new_Size(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_Size):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.Size_swiginit(self,_core_.new_Size(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_Size
+ __del__ = lambda self : None;
def __eq__(*args, **kwargs):
"""
__eq__(self, Size sz) -> bool
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.Size, self.Get())
-
-class SizePtr(Size):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Size
-_core_.Size_swigregister(SizePtr)
+Size_swigregister = _core_.Size_swigregister
+Size_swigregister(Size)
#---------------------------------------------------------------------------
point x and y properties. In wxPython most places that expect a
wx.RealPoint can also accept a (x,y) tuple.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxRealPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
x = property(_core_.RealPoint_x_get, _core_.RealPoint_x_set)
y = property(_core_.RealPoint_y_get, _core_.RealPoint_y_set)
- def __init__(self, *args, **kwargs):
+ def __init__(self, *args, **kwargs):
"""
__init__(self, double x=0.0, double y=0.0) -> RealPoint
Create a wx.RealPoint object
"""
- newobj = _core_.new_RealPoint(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_RealPoint):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.RealPoint_swiginit(self,_core_.new_RealPoint(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_RealPoint
+ __del__ = lambda self : None;
def __eq__(*args, **kwargs):
"""
__eq__(self, RealPoint pt) -> bool
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.RealPoint, self.Get())
-
-class RealPointPtr(RealPoint):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = RealPoint
-_core_.RealPoint_swigregister(RealPointPtr)
+RealPoint_swigregister = _core_.RealPoint_swigregister
+RealPoint_swigregister(RealPoint)
#---------------------------------------------------------------------------
and y properties. Most places in wxPython that expect a wx.Point can
also accept a (x,y) tuple.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPoint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
x = property(_core_.Point_x_get, _core_.Point_x_set)
y = property(_core_.Point_y_get, _core_.Point_y_set)
- def __init__(self, *args, **kwargs):
+ def __init__(self, *args, **kwargs):
"""
__init__(self, int x=0, int y=0) -> Point
Create a wx.Point object
"""
- newobj = _core_.new_Point(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_Point):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.Point_swiginit(self,_core_.new_Point(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_Point
+ __del__ = lambda self : None;
def __eq__(*args, **kwargs):
"""
__eq__(self, Point pt) -> bool
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.Point, self.Get())
-
-class PointPtr(Point):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Point
-_core_.Point_swigregister(PointPtr)
+Point_swigregister = _core_.Point_swigregister
+Point_swigregister(Point)
#---------------------------------------------------------------------------
width and height properties. In wxPython most palces that expect a
wx.Rect can also accept a (x,y,width,height) tuple.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxRect instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, int x=0, int y=0, int width=0, int height=0) -> Rect
Create a new Rect object.
"""
- newobj = _core_.new_Rect(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_Rect):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.Rect_swiginit(self,_core_.new_Rect(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_Rect
+ __del__ = lambda self : None;
def GetX(*args, **kwargs):
"""GetX(self) -> int"""
return _core_.Rect_GetX(*args, **kwargs)
"""SetSize(self, Size s)"""
return _core_.Rect_SetSize(*args, **kwargs)
+ def IsEmpty(*args, **kwargs):
+ """IsEmpty(self) -> bool"""
+ return _core_.Rect_IsEmpty(*args, **kwargs)
+
def GetTopLeft(*args, **kwargs):
"""GetTopLeft(self) -> Point"""
return _core_.Rect_GetTopLeft(*args, **kwargs)
"""
Inflate(self, int dx, int dy) -> Rect
- Increase the rectangle size by dx in x direction and dy in y
- direction. Both or one of) parameters may be negative to decrease the
- rectangle size.
+ Increases the size of the rectangle.
+
+ The left border is moved farther left and the right border is moved
+ farther right by ``dx``. The upper border is moved farther up and the
+ bottom border is moved farther down by ``dy``. (Note the the width and
+ height of the rectangle thus change by ``2*dx`` and ``2*dy``,
+ respectively.) If one or both of ``dx`` and ``dy`` are negative, the
+ opposite happens: the rectangle size decreases in the respective
+ direction.
+
+ The change is made to the rectangle inplace, if instead you need a
+ copy that is inflated, preserving the original then make the copy
+ first::
+
+ copy = wx.Rect(*original)
+ copy.Inflate(10,15)
+
+
"""
return _core_.Rect_Inflate(*args, **kwargs)
"""
Deflate(self, int dx, int dy) -> Rect
- Decrease the rectangle size by dx in x direction and dy in y
- direction. Both or one of) parameters may be negative to increase the
- rectngle size. This method is the opposite of Inflate.
+ Decrease the rectangle size. This method is the opposite of `Inflate`
+ in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
+ `Inflate` for a full description.
"""
return _core_.Rect_Deflate(*args, **kwargs)
"""
Offset(self, Point pt)
- Same as OffsetXY but uses dx,dy from Point
+ Same as `OffsetXY` but uses dx,dy from Point
"""
return _core_.Rect_Offset(*args, **kwargs)
"""
Intersect(self, Rect rect) -> Rect
- Return the intersectsion of this rectangle and rect.
+ Returns the intersectsion of this rectangle and rect.
"""
return _core_.Rect_Intersect(*args, **kwargs)
+ def Union(*args, **kwargs):
+ """
+ Union(self, Rect rect) -> Rect
+
+ Returns the union of this rectangle and rect.
+ """
+ return _core_.Rect_Union(*args, **kwargs)
+
def __add__(*args, **kwargs):
"""
__add__(self, Rect rect) -> Rect
"""
return _core_.Rect_Intersects(*args, **kwargs)
+ def CenterIn(*args, **kwargs):
+ """
+ CenterIn(self, Rect r, int dir=BOTH) -> Rect
+
+ Center this rectangle within the one passed to the method, which is
+ usually, but not necessarily, the larger one.
+ """
+ return _core_.Rect_CenterIn(*args, **kwargs)
+
+ CentreIn = CenterIn
x = property(_core_.Rect_x_get, _core_.Rect_x_set)
y = property(_core_.Rect_y_get, _core_.Rect_y_set)
width = property(_core_.Rect_width_get, _core_.Rect_width_set)
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.Rect, self.Get())
-
-class RectPtr(Rect):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Rect
-_core_.Rect_swigregister(RectPtr)
+Rect_swigregister = _core_.Rect_swigregister
+Rect_swigregister(Rect)
def RectPP(*args, **kwargs):
"""
Create a new Rect object from Points representing two corners.
"""
val = _core_.new_RectPP(*args, **kwargs)
- val.thisown = 1
return val
def RectPS(*args, **kwargs):
Create a new Rect from a position and size.
"""
val = _core_.new_RectPS(*args, **kwargs)
- val.thisown = 1
return val
+def RectS(*args, **kwargs):
+ """
+ RectS(Size size) -> Rect
-def IntersectRect(*args, **kwargs):
+ Create a new Rect from a size only.
"""
+ val = _core_.new_RectS(*args, **kwargs)
+ return val
+
+
+def IntersectRect(*args, **kwargs):
+ """
IntersectRect(Rect r1, Rect r2) -> Rect
Calculate and return the intersection of r1 and r2.
"""
- return _core_.IntersectRect(*args, **kwargs)
+ return _core_.IntersectRect(*args, **kwargs)
#---------------------------------------------------------------------------
class Point2D(object):
wx.Point2Ds represent a point or a vector in a 2d coordinate system
with floating point values.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPoint2D instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, double x=0.0, double y=0.0) -> Point2D
Create a w.Point2D object.
"""
- newobj = _core_.new_Point2D(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.Point2D_swiginit(self,_core_.new_Point2D(*args, **kwargs))
def GetFloor(*args, **kwargs):
- """GetFloor() -> (x,y)"""
+ """
+ GetFloor() -> (x,y)
+
+ Convert to integer
+ """
return _core_.Point2D_GetFloor(*args, **kwargs)
def GetRounded(*args, **kwargs):
- """GetRounded() -> (x,y)"""
+ """
+ GetRounded() -> (x,y)
+
+ Convert to integer
+ """
return _core_.Point2D_GetRounded(*args, **kwargs)
def GetVectorLength(*args, **kwargs):
__safe_for_unpickling__ = True
def __reduce__(self): return (wx.Point2D, self.Get())
-
-class Point2DPtr(Point2D):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Point2D
-_core_.Point2D_swigregister(Point2DPtr)
+Point2D_swigregister = _core_.Point2D_swigregister
+Point2D_swigregister(Point2D)
def Point2DCopy(*args, **kwargs):
"""
Create a w.Point2D object.
"""
val = _core_.new_Point2DCopy(*args, **kwargs)
- val.thisown = 1
return val
def Point2DFromPoint(*args, **kwargs):
Create a w.Point2D object.
"""
val = _core_.new_Point2DFromPoint(*args, **kwargs)
- val.thisown = 1
return val
#---------------------------------------------------------------------------
FromCurrent = _core_.FromCurrent
FromEnd = _core_.FromEnd
class InputStream(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPyInputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ InputStream class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self, PyObject p) -> InputStream"""
- newobj = _core_.new_InputStream(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.InputStream_swiginit(self,_core_.new_InputStream(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_InputStream
+ __del__ = lambda self : None;
def close(*args, **kwargs):
"""close(self)"""
return _core_.InputStream_close(*args, **kwargs)
"""TellI(self) -> long"""
return _core_.InputStream_TellI(*args, **kwargs)
-
-class InputStreamPtr(InputStream):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = InputStream
-_core_.InputStream_swigregister(InputStreamPtr)
+InputStream_swigregister = _core_.InputStream_swigregister
+InputStream_swigregister(InputStream)
DefaultPosition = cvar.DefaultPosition
DefaultSize = cvar.DefaultSize
class OutputStream(object):
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxOutputStream instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ """Proxy of C++ OutputStream class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
def write(*args, **kwargs):
"""write(self, PyObject obj)"""
return _core_.OutputStream_write(*args, **kwargs)
+ def LastWrite(*args, **kwargs):
+ """LastWrite(self) -> size_t"""
+ return _core_.OutputStream_LastWrite(*args, **kwargs)
-class OutputStreamPtr(OutputStream):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = OutputStream
-_core_.OutputStream_swigregister(OutputStreamPtr)
+OutputStream_swigregister = _core_.OutputStream_swigregister
+OutputStream_swigregister(OutputStream)
#---------------------------------------------------------------------------
class FSFile(Object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxFSFile instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ FSFile class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, InputStream stream, String loc, String mimetype, String anchor,
DateTime modif) -> FSFile
"""
- newobj = _core_.new_FSFile(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_FSFile):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
+ _core_.FSFile_swiginit(self,_core_.new_FSFile(*args, **kwargs))
+ self.thisown = 0 # It will normally be deleted by the user of the wx.FileSystem
+ __swig_destroy__ = _core_.delete_FSFile
+ __del__ = lambda self : None;
def GetStream(*args, **kwargs):
"""GetStream(self) -> InputStream"""
return _core_.FSFile_GetStream(*args, **kwargs)
"""GetModificationTime(self) -> DateTime"""
return _core_.FSFile_GetModificationTime(*args, **kwargs)
-
-class FSFilePtr(FSFile):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = FSFile
-_core_.FSFile_swigregister(FSFilePtr)
+FSFile_swigregister = _core_.FSFile_swigregister
+FSFile_swigregister(FSFile)
class CPPFileSystemHandler(object):
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
-
-class CPPFileSystemHandlerPtr(CPPFileSystemHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = CPPFileSystemHandler
-_core_.CPPFileSystemHandler_swigregister(CPPFileSystemHandlerPtr)
+ """Proxy of C++ CPPFileSystemHandler class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
+ __swig_destroy__ = _core_.delete_CPPFileSystemHandler
+ __del__ = lambda self : None;
+CPPFileSystemHandler_swigregister = _core_.CPPFileSystemHandler_swigregister
+CPPFileSystemHandler_swigregister(CPPFileSystemHandler)
class FileSystemHandler(CPPFileSystemHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPyFileSystemHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ FileSystemHandler class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> FileSystemHandler"""
- newobj = _core_.new_FileSystemHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.FileSystemHandler_swiginit(self,_core_.new_FileSystemHandler(*args, **kwargs))
self._setCallbackInfo(self, FileSystemHandler)
def _setCallbackInfo(*args, **kwargs):
"""GetMimeTypeFromExt(self, String location) -> String"""
return _core_.FileSystemHandler_GetMimeTypeFromExt(*args, **kwargs)
-
-class FileSystemHandlerPtr(FileSystemHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = FileSystemHandler
-_core_.FileSystemHandler_swigregister(FileSystemHandlerPtr)
+FileSystemHandler_swigregister = _core_.FileSystemHandler_swigregister
+FileSystemHandler_swigregister(FileSystemHandler)
class FileSystem(Object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxFileSystem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ FileSystem class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> FileSystem"""
- newobj = _core_.new_FileSystem(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_FileSystem):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.FileSystem_swiginit(self,_core_.new_FileSystem(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_FileSystem
+ __del__ = lambda self : None;
def ChangePathTo(*args, **kwargs):
"""ChangePathTo(self, String location, bool is_dir=False)"""
return _core_.FileSystem_ChangePathTo(*args, **kwargs)
return _core_.FileSystem_FileNameToURL(*args, **kwargs)
FileNameToURL = staticmethod(FileNameToURL)
+ def URLToFileName(*args, **kwargs):
+ """URLToFileName(String url) -> String"""
+ return _core_.FileSystem_URLToFileName(*args, **kwargs)
-class FileSystemPtr(FileSystem):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = FileSystem
-_core_.FileSystem_swigregister(FileSystemPtr)
+ URLToFileName = staticmethod(URLToFileName)
+FileSystem_swigregister = _core_.FileSystem_swigregister
+FileSystem_swigregister(FileSystem)
def FileSystem_AddHandler(*args, **kwargs):
- """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
- return _core_.FileSystem_AddHandler(*args, **kwargs)
+ """FileSystem_AddHandler(CPPFileSystemHandler handler)"""
+ return _core_.FileSystem_AddHandler(*args, **kwargs)
-def FileSystem_CleanUpHandlers(*args, **kwargs):
- """FileSystem_CleanUpHandlers()"""
- return _core_.FileSystem_CleanUpHandlers(*args, **kwargs)
+def FileSystem_CleanUpHandlers(*args):
+ """FileSystem_CleanUpHandlers()"""
+ return _core_.FileSystem_CleanUpHandlers(*args)
def FileSystem_FileNameToURL(*args, **kwargs):
- """FileSystem_FileNameToURL(String filename) -> String"""
- return _core_.FileSystem_FileNameToURL(*args, **kwargs)
-
+ """FileSystem_FileNameToURL(String filename) -> String"""
+ return _core_.FileSystem_FileNameToURL(*args, **kwargs)
def FileSystem_URLToFileName(*args, **kwargs):
- """FileSystem_URLToFileName(String url) -> String"""
- return _core_.FileSystem_URLToFileName(*args, **kwargs)
+ """FileSystem_URLToFileName(String url) -> String"""
+ return _core_.FileSystem_URLToFileName(*args, **kwargs)
+
class InternetFSHandler(CPPFileSystemHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxInternetFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ InternetFSHandler class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> InternetFSHandler"""
- newobj = _core_.new_InternetFSHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.InternetFSHandler_swiginit(self,_core_.new_InternetFSHandler(*args, **kwargs))
def CanOpen(*args, **kwargs):
"""CanOpen(self, String location) -> bool"""
return _core_.InternetFSHandler_CanOpen(*args, **kwargs)
"""OpenFile(self, FileSystem fs, String location) -> FSFile"""
return _core_.InternetFSHandler_OpenFile(*args, **kwargs)
-
-class InternetFSHandlerPtr(InternetFSHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = InternetFSHandler
-_core_.InternetFSHandler_swigregister(InternetFSHandlerPtr)
+InternetFSHandler_swigregister = _core_.InternetFSHandler_swigregister
+InternetFSHandler_swigregister(InternetFSHandler)
class ZipFSHandler(CPPFileSystemHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxZipFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ ZipFSHandler class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> ZipFSHandler"""
- newobj = _core_.new_ZipFSHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.ZipFSHandler_swiginit(self,_core_.new_ZipFSHandler(*args, **kwargs))
def CanOpen(*args, **kwargs):
"""CanOpen(self, String location) -> bool"""
return _core_.ZipFSHandler_CanOpen(*args, **kwargs)
"""FindNext(self) -> String"""
return _core_.ZipFSHandler_FindNext(*args, **kwargs)
-
-class ZipFSHandlerPtr(ZipFSHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ZipFSHandler
-_core_.ZipFSHandler_swigregister(ZipFSHandlerPtr)
+ZipFSHandler_swigregister = _core_.ZipFSHandler_swigregister
+ZipFSHandler_swigregister(ZipFSHandler)
def __wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs):
- """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
- return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
+ """__wxMemoryFSHandler_AddFile_wxImage(String filename, Image image, long type)"""
+ return _core_.__wxMemoryFSHandler_AddFile_wxImage(*args, **kwargs)
def __wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs):
- """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
- return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
+ """__wxMemoryFSHandler_AddFile_wxBitmap(String filename, Bitmap bitmap, long type)"""
+ return _core_.__wxMemoryFSHandler_AddFile_wxBitmap(*args, **kwargs)
def __wxMemoryFSHandler_AddFile_Data(*args, **kwargs):
- """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
- return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
-def MemoryFSHandler_AddFile(filename, a, b=''):
- if isinstance(a, wx.Image):
- __wxMemoryFSHandler_AddFile_wxImage(filename, a, b)
- elif isinstance(a, wx.Bitmap):
- __wxMemoryFSHandler_AddFile_wxBitmap(filename, a, b)
- elif type(a) == str:
- __wxMemoryFSHandler_AddFile_Data(filename, a)
- else: raise TypeError, 'wx.Image, wx.Bitmap or string expected'
+ """__wxMemoryFSHandler_AddFile_Data(String filename, PyObject data)"""
+ return _core_.__wxMemoryFSHandler_AddFile_Data(*args, **kwargs)
+def MemoryFSHandler_AddFile(filename, dataItem, imgType=-1):
+ """
+ Add 'file' to the memory filesystem. The dataItem parameter can
+ either be a `wx.Bitmap`, `wx.Image` or a string that can contain
+ arbitrary data. If a bitmap or image is used then the imgType
+ parameter should specify what kind of image file it should be
+ written as, wx.BITMAP_TYPE_PNG, etc.
+ """
+ if isinstance(dataItem, wx.Image):
+ __wxMemoryFSHandler_AddFile_wxImage(filename, dataItem, imgType)
+ elif isinstance(dataItem, wx.Bitmap):
+ __wxMemoryFSHandler_AddFile_wxBitmap(filename, dataItem, imgType)
+ elif type(dataItem) == str:
+ __wxMemoryFSHandler_AddFile_Data(filename, dataItem)
+ else:
+ raise TypeError, 'wx.Image, wx.Bitmap or string expected'
class MemoryFSHandler(CPPFileSystemHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMemoryFSHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ MemoryFSHandler class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> MemoryFSHandler"""
- newobj = _core_.new_MemoryFSHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.MemoryFSHandler_swiginit(self,_core_.new_MemoryFSHandler(*args, **kwargs))
def RemoveFile(*args, **kwargs):
"""RemoveFile(String filename)"""
return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
"""FindNext(self) -> String"""
return _core_.MemoryFSHandler_FindNext(*args, **kwargs)
-
-class MemoryFSHandlerPtr(MemoryFSHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MemoryFSHandler
-_core_.MemoryFSHandler_swigregister(MemoryFSHandlerPtr)
+MemoryFSHandler_swigregister = _core_.MemoryFSHandler_swigregister
+MemoryFSHandler_swigregister(MemoryFSHandler)
def MemoryFSHandler_RemoveFile(*args, **kwargs):
- """MemoryFSHandler_RemoveFile(String filename)"""
- return _core_.MemoryFSHandler_RemoveFile(*args, **kwargs)
+ """MemoryFSHandler_RemoveFile(String filename)"""
+ return _core_.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
#---------------------------------------------------------------------------
class ImageHandler(Object):
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxImageHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ """
+ This is the base class for implementing image file loading/saving, and
+ image creation from data. It is used within `wx.Image` and is not
+ normally seen by the application.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
def GetName(*args, **kwargs):
"""GetName(self) -> String"""
return _core_.ImageHandler_GetName(*args, **kwargs)
"""SetMimeType(self, String mimetype)"""
return _core_.ImageHandler_SetMimeType(*args, **kwargs)
+ImageHandler_swigregister = _core_.ImageHandler_swigregister
+ImageHandler_swigregister(ImageHandler)
+
+class PyImageHandler(ImageHandler):
+ """
+ This is the base class for implementing image file loading/saving, and
+ image creation from data, all written in Python. To create a custom
+ image handler derive a new class from wx.PyImageHandler and provide
+ the following methods::
+
+ def DoCanRead(self, stream) --> bool
+ '''Check if this handler can read the image on the stream'''
+
+ def LoadFile(self, image, stream, verbose, index) --> bool
+ '''Load image data from the stream and load it into image.'''
+
+ def SaveFile(self, image, stream, verbose) --> bool
+ '''Save the iamge data in image to the stream using
+ this handler's image file format.'''
+
+ def GetImageCount(self, stream) --> int
+ '''If this image format can hold more than one image,
+ how many does the image on the stream have?'''
+
+ To activate your handler create an instance of it and pass it to
+ `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
+ `SetExtension` from your constructor.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> PyImageHandler
+
+ This is the base class for implementing image file loading/saving, and
+ image creation from data, all written in Python. To create a custom
+ image handler derive a new class from wx.PyImageHandler and provide
+ the following methods::
+
+ def DoCanRead(self, stream) --> bool
+ '''Check if this handler can read the image on the stream'''
-class ImageHandlerPtr(ImageHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ImageHandler
-_core_.ImageHandler_swigregister(ImageHandlerPtr)
+ def LoadFile(self, image, stream, verbose, index) --> bool
+ '''Load image data from the stream and load it into image.'''
+
+ def SaveFile(self, image, stream, verbose) --> bool
+ '''Save the iamge data in image to the stream using
+ this handler's image file format.'''
+
+ def GetImageCount(self, stream) --> int
+ '''If this image format can hold more than one image,
+ how many does the image on the stream have?'''
+
+ To activate your handler create an instance of it and pass it to
+ `wx.Image_AddHandler`. Be sure to call `SetName`, `SetType`, and
+ `SetExtension` from your constructor.
+
+ """
+ _core_.PyImageHandler_swiginit(self,_core_.new_PyImageHandler(*args, **kwargs))
+ self._SetSelf(self)
+
+ def _SetSelf(*args, **kwargs):
+ """_SetSelf(self, PyObject self)"""
+ return _core_.PyImageHandler__SetSelf(*args, **kwargs)
+
+PyImageHandler_swigregister = _core_.PyImageHandler_swigregister
+PyImageHandler_swigregister(PyImageHandler)
class ImageHistogram(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxImageHistogram instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ ImageHistogram class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> ImageHistogram"""
- newobj = _core_.new_ImageHistogram(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.ImageHistogram_swiginit(self,_core_.new_ImageHistogram(*args, **kwargs))
def MakeKey(*args, **kwargs):
"""
- MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
+ MakeKey(byte r, byte g, byte b) -> unsigned long
Get the key in the histogram for the given RGB values
"""
MakeKey = staticmethod(MakeKey)
def FindFirstUnusedColour(*args, **kwargs):
- """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
+ """
+ FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
+
+ Find first colour that is not used in the image and has higher RGB
+ values than startR, startG, startB. Returns a tuple consisting of a
+ success flag and rgb values.
+ """
return _core_.ImageHistogram_FindFirstUnusedColour(*args, **kwargs)
+ def GetCount(*args, **kwargs):
+ """
+ GetCount(self, unsigned long key) -> unsigned long
+
+ Returns the pixel count for the given key. Use `MakeKey` to create a
+ key value from a RGB tripple.
+ """
+ return _core_.ImageHistogram_GetCount(*args, **kwargs)
+
+ def GetCountRGB(*args, **kwargs):
+ """
+ GetCountRGB(self, byte r, byte g, byte b) -> unsigned long
+
+ Returns the pixel count for the given RGB values.
+ """
+ return _core_.ImageHistogram_GetCountRGB(*args, **kwargs)
+
+ def GetCountColour(*args, **kwargs):
+ """
+ GetCountColour(self, Colour colour) -> unsigned long
+
+ Returns the pixel count for the given `wx.Colour` value.
+ """
+ return _core_.ImageHistogram_GetCountColour(*args, **kwargs)
-class ImageHistogramPtr(ImageHistogram):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ImageHistogram
-_core_.ImageHistogram_swigregister(ImageHistogramPtr)
+ImageHistogram_swigregister = _core_.ImageHistogram_swigregister
+ImageHistogram_swigregister(ImageHistogram)
def ImageHistogram_MakeKey(*args, **kwargs):
- """
- ImageHistogram_MakeKey(unsigned char r, unsigned char g, unsigned char b) -> unsigned long
+ """
+ ImageHistogram_MakeKey(byte r, byte g, byte b) -> unsigned long
Get the key in the histogram for the given RGB values
"""
- return _core_.ImageHistogram_MakeKey(*args, **kwargs)
+ return _core_.ImageHistogram_MakeKey(*args, **kwargs)
+
+class Image_RGBValue(object):
+ """
+ An object that contains values for red, green and blue which represent
+ the value of a color. It is used by `wx.Image.HSVtoRGB` and
+ `wx.Image.RGBtoHSV`, which converts between HSV color space and RGB
+ color space.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, byte r=0, byte g=0, byte b=0) -> Image_RGBValue
+
+ Constructor.
+ """
+ _core_.Image_RGBValue_swiginit(self,_core_.new_Image_RGBValue(*args, **kwargs))
+ red = property(_core_.Image_RGBValue_red_get, _core_.Image_RGBValue_red_set)
+ green = property(_core_.Image_RGBValue_green_get, _core_.Image_RGBValue_green_set)
+ blue = property(_core_.Image_RGBValue_blue_get, _core_.Image_RGBValue_blue_set)
+Image_RGBValue_swigregister = _core_.Image_RGBValue_swigregister
+Image_RGBValue_swigregister(Image_RGBValue)
+
+class Image_HSVValue(object):
+ """
+ An object that contains values for hue, saturation and value which
+ represent the value of a color. It is used by `wx.Image.HSVtoRGB` and
+ `wx.Image.RGBtoHSV`, which +converts between HSV color space and RGB
+ color space.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, double h=0.0, double s=0.0, double v=0.0) -> Image_HSVValue
+
+ Constructor.
+ """
+ _core_.Image_HSVValue_swiginit(self,_core_.new_Image_HSVValue(*args, **kwargs))
+ hue = property(_core_.Image_HSVValue_hue_get, _core_.Image_HSVValue_hue_set)
+ saturation = property(_core_.Image_HSVValue_saturation_get, _core_.Image_HSVValue_saturation_set)
+ value = property(_core_.Image_HSVValue_value_get, _core_.Image_HSVValue_value_set)
+Image_HSVValue_swigregister = _core_.Image_HSVValue_swigregister
+Image_HSVValue_swigregister(Image_HSVValue)
class Image(Object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxImage instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
- newobj = _core_.new_Image(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_Image):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
+ """
+ A platform-independent image class. An image can be created from
+ data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a
+ variety of formats. Functions are available to set and get image
+ bits, so it can be used for basic image manipulation.
+
+ A wx.Image cannot be drawn directly to a `wx.DC`. Instead, a
+ platform-specific `wx.Bitmap` object must be created from it using the
+ `wx.BitmapFromImage` constructor. This bitmap can then be drawn in a
+ device context, using `wx.DC.DrawBitmap`.
+
+ One colour value of the image may be used as a mask colour which will
+ lead to the automatic creation of a `wx.Mask` object associated to the
+ bitmap object.
+
+ wx.Image supports alpha channel data, that is in addition to a byte
+ for the red, green and blue colour components for each pixel it also
+ stores a byte representing the pixel opacity. An alpha value of 0
+ corresponds to a transparent pixel (null opacity) while a value of 255
+ means that the pixel is 100% opaque.
+
+ Unlike RGB data, not all images have an alpha channel and before using
+ `GetAlpha` you should check if this image contains an alpha channel
+ with `HasAlpha`. Note that currently only images loaded from PNG files
+ with transparency information will have an alpha channel.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
+ Loads an image from a file.
+ """
+ _core_.Image_swiginit(self,_core_.new_Image(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_Image
+ __del__ = lambda self : None;
def Create(*args, **kwargs):
- """Create(self, int width, int height)"""
+ """
+ Create(self, int width, int height, bool clear=True)
+
+ Creates a fresh image. If clear is ``True``, the new image will be
+ initialized to black. Otherwise, the image data will be uninitialized.
+ """
return _core_.Image_Create(*args, **kwargs)
def Destroy(*args, **kwargs):
"""
Destroy(self)
- Deletes the C++ object this Python object is a proxy for.
+ Destroys the image data.
"""
- return _core_.Image_Destroy(*args, **kwargs)
+ val = _core_.Image_Destroy(*args, **kwargs)
+ args[0].thisown = 0
+ return val
def Scale(*args, **kwargs):
- """Scale(self, int width, int height) -> Image"""
+ """
+ Scale(self, int width, int height) -> 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`.
+ """
return _core_.Image_Scale(*args, **kwargs)
def ShrinkBy(*args, **kwargs):
- """ShrinkBy(self, int xFactor, int yFactor) -> Image"""
+ """
+ ShrinkBy(self, int xFactor, int yFactor) -> Image
+
+ Return a version of the image scaled smaller by the given factors.
+ """
return _core_.Image_ShrinkBy(*args, **kwargs)
def Rescale(*args, **kwargs):
- """Rescale(self, int width, int height) -> Image"""
+ """
+ Rescale(self, int width, int height) -> 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.
+
+ Returns the (modified) image itself.
+ """
return _core_.Image_Rescale(*args, **kwargs)
+ def Resize(*args, **kwargs):
+ """
+ Resize(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
+
+ Changes the size of the image in-place without scaling it, by adding
+ either a border with the given colour or cropping as necessary. The
+ image is pasted into a new image with the given size and background
+ colour at the position pos relative to the upper left of the new
+ image. If red = green = blue = -1 then use either the current mask
+ colour if set or find, use, and set a suitable mask colour for any
+ newly exposed areas.
+
+ Returns the (modified) image itself.
+ """
+ return _core_.Image_Resize(*args, **kwargs)
+
def SetRGB(*args, **kwargs):
- """SetRGB(self, int x, int y, unsigned char r, unsigned char g, unsigned char b)"""
+ """
+ SetRGB(self, int x, int y, byte r, byte g, byte b)
+
+ Sets the pixel at the given coordinate. This routine performs
+ bounds-checks for the coordinate so it can be considered a safe way to
+ manipulate the data, but in some cases this might be too slow so that
+ the data will have to be set directly. In that case you will have to
+ get access to the image data using the `GetData` method.
+ """
return _core_.Image_SetRGB(*args, **kwargs)
+ def SetRGBRect(*args, **kwargs):
+ """
+ SetRGBRect(self, Rect rect, byte r, byte g, byte b)
+
+ Sets the colour of the pixels within the given rectangle. This routine
+ performs bounds-checks for the rectangle so it can be considered a
+ safe way to manipulate the data.
+ """
+ return _core_.Image_SetRGBRect(*args, **kwargs)
+
def GetRed(*args, **kwargs):
- """GetRed(self, int x, int y) -> unsigned char"""
+ """
+ GetRed(self, int x, int y) -> byte
+
+ Returns the red intensity at the given coordinate.
+ """
return _core_.Image_GetRed(*args, **kwargs)
def GetGreen(*args, **kwargs):
- """GetGreen(self, int x, int y) -> unsigned char"""
+ """
+ GetGreen(self, int x, int y) -> byte
+
+ Returns the green intensity at the given coordinate.
+ """
return _core_.Image_GetGreen(*args, **kwargs)
def GetBlue(*args, **kwargs):
- """GetBlue(self, int x, int y) -> unsigned char"""
+ """
+ GetBlue(self, int x, int y) -> byte
+
+ Returns the blue intensity at the given coordinate.
+ """
return _core_.Image_GetBlue(*args, **kwargs)
def SetAlpha(*args, **kwargs):
- """SetAlpha(self, int x, int y, unsigned char alpha)"""
+ """
+ SetAlpha(self, int x, int y, byte alpha)
+
+ Sets the alpha value for the given pixel. This function should only be
+ called if the image has alpha channel data, use `HasAlpha` to check
+ for this.
+ """
return _core_.Image_SetAlpha(*args, **kwargs)
def GetAlpha(*args, **kwargs):
- """GetAlpha(self, int x, int y) -> unsigned char"""
+ """
+ GetAlpha(self, int x, int y) -> byte
+
+ Returns the alpha value for the given pixel. This function may only be
+ called for the images with alpha channel, use `HasAlpha` to check for
+ this.
+
+ The returned value is the *opacity* of the image, i.e. the value of 0
+ corresponds to the fully transparent pixels while the value of 255 to
+ the fully opaque pixels.
+ """
return _core_.Image_GetAlpha(*args, **kwargs)
def HasAlpha(*args, **kwargs):
- """HasAlpha(self) -> bool"""
+ """
+ HasAlpha(self) -> bool
+
+ Returns true if this image has alpha channel, false otherwise.
+ """
return _core_.Image_HasAlpha(*args, **kwargs)
+ def InitAlpha(*args, **kwargs):
+ """
+ InitAlpha(self)
+
+ Initializes the image alpha channel data. It is an error to call it if
+ the image already has alpha data. If it doesn't, alpha data will be by
+ default initialized to all pixels being fully opaque. But if the image
+ has a a mask colour, all mask pixels will be completely transparent.
+ """
+ return _core_.Image_InitAlpha(*args, **kwargs)
+
+ def IsTransparent(*args, **kwargs):
+ """
+ IsTransparent(self, int x, int y, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
+
+ Returns ``True`` if this pixel is masked or has an alpha value less
+ than the spcified threshold.
+ """
+ return _core_.Image_IsTransparent(*args, **kwargs)
+
def FindFirstUnusedColour(*args, **kwargs):
- """FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)"""
+ """
+ FindFirstUnusedColour(int startR=1, int startG=0, int startB=0) -> (success, r, g, b)
+
+ Find first colour that is not used in the image and has higher RGB
+ values than startR, startG, startB. Returns a tuple consisting of a
+ success flag and rgb values.
+ """
return _core_.Image_FindFirstUnusedColour(*args, **kwargs)
+ def ConvertAlphaToMask(*args, **kwargs):
+ """
+ ConvertAlphaToMask(self, byte threshold=IMAGE_ALPHA_THRESHOLD) -> bool
+
+ If the image has alpha channel, this method converts it to mask. All
+ pixels with alpha value less than ``threshold`` are replaced with the
+ mask colour and the alpha channel is removed. The mask colour is
+ chosen automatically using `FindFirstUnusedColour`.
+
+ If the image image doesn't have alpha channel, ConvertAlphaToMask does
+ nothing.
+ """
+ return _core_.Image_ConvertAlphaToMask(*args, **kwargs)
+
+ def ConvertColourToAlpha(*args, **kwargs):
+ """
+ ConvertColourToAlpha(self, byte r, byte g, byte b) -> bool
+
+ This method converts an image where the original alpha information is
+ only available as a shades of a colour (actually shades of grey)
+ typically when you draw anti-aliased text into a bitmap. The DC
+ drawing routines draw grey values on the black background although
+ they actually mean to draw white with differnt alpha values. This
+ method reverses it, assuming a black (!) background and white text.
+ The method will then fill up the whole image with the colour given.
+ """
+ return _core_.Image_ConvertColourToAlpha(*args, **kwargs)
+
def SetMaskFromImage(*args, **kwargs):
- """SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool"""
+ """
+ SetMaskFromImage(self, Image mask, byte mr, byte mg, byte mb) -> bool
+
+ Sets the image's mask so that the pixels that have RGB value of
+ ``(mr,mg,mb)`` in ``mask`` will be masked in this image. This is done
+ by first finding an unused colour in the image, setting this colour as
+ the mask colour and then using this colour to draw all pixels in the
+ image who corresponding pixel in mask has given RGB value.
+
+ Returns ``False`` if ``mask`` does not have same dimensions as the
+ image or if there is no unused colour left. Returns ``True`` if the
+ mask was successfully applied.
+
+ Note that this method involves computing the histogram, which is
+ computationally intensive operation.
+ """
return _core_.Image_SetMaskFromImage(*args, **kwargs)
def CanRead(*args, **kwargs):
- """CanRead(String name) -> bool"""
+ """
+ CanRead(String filename) -> bool
+
+ Returns True if the image handlers can read this file.
+ """
return _core_.Image_CanRead(*args, **kwargs)
CanRead = staticmethod(CanRead)
def GetImageCount(*args, **kwargs):
- """GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
+ """
+ GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
+
+ If the image file contains more than one image and the image handler
+ is capable of retrieving these individually, this function will return
+ the number of available images.
+ """
return _core_.Image_GetImageCount(*args, **kwargs)
GetImageCount = staticmethod(GetImageCount)
def LoadFile(*args, **kwargs):
- """LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
+ """
+ LoadFile(self, String name, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
+
+ Loads an image from a file. If no handler type is provided, the
+ library will try to autodetect the format.
+ """
return _core_.Image_LoadFile(*args, **kwargs)
def LoadMimeFile(*args, **kwargs):
- """LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool"""
+ """
+ LoadMimeFile(self, String name, String mimetype, int index=-1) -> bool
+
+ Loads an image from a file, specifying the image type with a MIME type
+ string.
+ """
return _core_.Image_LoadMimeFile(*args, **kwargs)
def SaveFile(*args, **kwargs):
- """SaveFile(self, String name, int type) -> bool"""
+ """
+ SaveFile(self, String name, int type) -> bool
+
+ Saves an image in the named file.
+ """
return _core_.Image_SaveFile(*args, **kwargs)
def SaveMimeFile(*args, **kwargs):
- """SaveMimeFile(self, String name, String mimetype) -> bool"""
+ """
+ SaveMimeFile(self, String name, String mimetype) -> bool
+
+ Saves an image in the named file.
+ """
return _core_.Image_SaveMimeFile(*args, **kwargs)
def CanReadStream(*args, **kwargs):
- """CanReadStream(InputStream stream) -> bool"""
+ """
+ CanReadStream(InputStream stream) -> bool
+
+ Returns True if the image handlers can read an image file from the
+ data currently on the input stream, or a readable Python file-like
+ object.
+ """
return _core_.Image_CanReadStream(*args, **kwargs)
CanReadStream = staticmethod(CanReadStream)
def LoadStream(*args, **kwargs):
- """LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool"""
+ """
+ LoadStream(self, InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> bool
+
+ Loads an image from an input stream or a readable Python file-like
+ object. If no handler type is provided, the library will try to
+ autodetect the format.
+ """
return _core_.Image_LoadStream(*args, **kwargs)
def LoadMimeStream(*args, **kwargs):
- """LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool"""
+ """
+ LoadMimeStream(self, InputStream stream, String mimetype, int index=-1) -> bool
+
+ Loads an image from an input stream or a readable Python file-like
+ object, using a MIME type string to specify the image file format.
+ """
return _core_.Image_LoadMimeStream(*args, **kwargs)
def Ok(*args, **kwargs):
- """Ok(self) -> bool"""
+ """
+ Ok(self) -> bool
+
+ Returns true if image data is present.
+ """
return _core_.Image_Ok(*args, **kwargs)
def GetWidth(*args, **kwargs):
- """GetWidth(self) -> int"""
+ """
+ GetWidth(self) -> int
+
+ Gets the width of the image in pixels.
+ """
return _core_.Image_GetWidth(*args, **kwargs)
def GetHeight(*args, **kwargs):
- """GetHeight(self) -> int"""
+ """
+ GetHeight(self) -> int
+
+ Gets the height of the image in pixels.
+ """
return _core_.Image_GetHeight(*args, **kwargs)
def GetSize(*args, **kwargs):
- """GetSize(self) -> Size"""
+ """
+ GetSize(self) -> Size
+
+ Returns the size of the image in pixels.
+ """
return _core_.Image_GetSize(*args, **kwargs)
def GetSubImage(*args, **kwargs):
- """GetSubImage(self, Rect rect) -> Image"""
+ """
+ GetSubImage(self, Rect rect) -> Image
+
+ Returns a sub image of the current one as long as the rect belongs
+ entirely to the image.
+ """
return _core_.Image_GetSubImage(*args, **kwargs)
+ def Size(*args, **kwargs):
+ """
+ Size(self, Size size, Point pos, int r=-1, int g=-1, int b=-1) -> Image
+
+ Returns a resized version of this image without scaling it by adding
+ either a border with the given colour or cropping as necessary. The
+ image is pasted into a new image with the given size and background
+ colour at the position ``pos`` relative to the upper left of the new
+ image. If red = green = blue = -1 then use either the current mask
+ colour if set or find, use, and set a suitable mask colour for any
+ newly exposed areas.
+ """
+ return _core_.Image_Size(*args, **kwargs)
+
def Copy(*args, **kwargs):
- """Copy(self) -> Image"""
+ """
+ Copy(self) -> Image
+
+ Returns an identical copy of the image.
+ """
return _core_.Image_Copy(*args, **kwargs)
def Paste(*args, **kwargs):
- """Paste(self, Image image, int x, int y)"""
+ """
+ Paste(self, Image image, int x, int y)
+
+ Pastes ``image`` into this instance and takes care of the mask colour
+ and any out of bounds problems.
+ """
return _core_.Image_Paste(*args, **kwargs)
def GetData(*args, **kwargs):
- """GetData(self) -> PyObject"""
+ """
+ GetData(self) -> PyObject
+
+ Returns a string containing a copy of the RGB bytes of the image.
+ """
return _core_.Image_GetData(*args, **kwargs)
def SetData(*args, **kwargs):
- """SetData(self, PyObject data)"""
+ """
+ SetData(self, buffer data)
+
+ Resets the Image's RGB data from a buffer of RGB bytes. Accepts
+ either a string or a buffer object holding the data and the length of
+ the data must be width*height*3.
+ """
return _core_.Image_SetData(*args, **kwargs)
def GetDataBuffer(*args, **kwargs):
- """GetDataBuffer(self) -> PyObject"""
+ """
+ GetDataBuffer(self) -> PyObject
+
+ Returns a writable Python buffer object that is pointing at the RGB
+ image data buffer inside the wx.Image. You need to ensure that you do
+ not use this buffer object after the image has been destroyed.
+ """
return _core_.Image_GetDataBuffer(*args, **kwargs)
def SetDataBuffer(*args, **kwargs):
- """SetDataBuffer(self, PyObject data)"""
+ """
+ SetDataBuffer(self, buffer data)
+
+ Sets the internal image data pointer to point at a Python buffer
+ object. This can save making an extra copy of the data but you must
+ ensure that the buffer object lives longer than the wx.Image does.
+ """
return _core_.Image_SetDataBuffer(*args, **kwargs)
def GetAlphaData(*args, **kwargs):
- """GetAlphaData(self) -> PyObject"""
+ """
+ GetAlphaData(self) -> PyObject
+
+ Returns a string containing a copy of the alpha bytes of the image.
+ """
return _core_.Image_GetAlphaData(*args, **kwargs)
def SetAlphaData(*args, **kwargs):
- """SetAlphaData(self, PyObject data)"""
+ """
+ SetAlphaData(self, buffer alpha)
+
+ Resets the Image's alpha data from a buffer of bytes. Accepts either
+ a string or a buffer object holding the data and the length of the
+ data must be width*height.
+ """
return _core_.Image_SetAlphaData(*args, **kwargs)
def GetAlphaBuffer(*args, **kwargs):
return _core_.Image_GetAlphaBuffer(*args, **kwargs)
def SetAlphaBuffer(*args, **kwargs):
- """SetAlphaBuffer(self, PyObject data)"""
+ """SetAlphaBuffer(self, buffer alpha)"""
return _core_.Image_SetAlphaBuffer(*args, **kwargs)
def SetMaskColour(*args, **kwargs):
- """SetMaskColour(self, unsigned char r, unsigned char g, unsigned char b)"""
+ """
+ SetMaskColour(self, byte r, byte g, byte b)
+
+ Sets the mask colour for this image (and tells the image to use the
+ mask).
+ """
return _core_.Image_SetMaskColour(*args, **kwargs)
+ def GetOrFindMaskColour(*args, **kwargs):
+ """
+ GetOrFindMaskColour() -> (r,g,b)
+
+ Get the current mask colour or find a suitable colour.
+ """
+ return _core_.Image_GetOrFindMaskColour(*args, **kwargs)
+
def GetMaskRed(*args, **kwargs):
- """GetMaskRed(self) -> unsigned char"""
+ """
+ GetMaskRed(self) -> byte
+
+ Gets the red component of the mask colour.
+ """
return _core_.Image_GetMaskRed(*args, **kwargs)
def GetMaskGreen(*args, **kwargs):
- """GetMaskGreen(self) -> unsigned char"""
+ """
+ GetMaskGreen(self) -> byte
+
+ Gets the green component of the mask colour.
+ """
return _core_.Image_GetMaskGreen(*args, **kwargs)
def GetMaskBlue(*args, **kwargs):
- """GetMaskBlue(self) -> unsigned char"""
+ """
+ GetMaskBlue(self) -> byte
+
+ Gets the blue component of the mask colour.
+ """
return _core_.Image_GetMaskBlue(*args, **kwargs)
def SetMask(*args, **kwargs):
- """SetMask(self, bool mask=True)"""
+ """
+ SetMask(self, bool mask=True)
+
+ Specifies whether there is a mask or not. The area of the mask is
+ determined by the current mask colour.
+ """
return _core_.Image_SetMask(*args, **kwargs)
def HasMask(*args, **kwargs):
- """HasMask(self) -> bool"""
+ """
+ HasMask(self) -> bool
+
+ Returns ``True`` if there is a mask active, ``False`` otherwise.
+ """
return _core_.Image_HasMask(*args, **kwargs)
def Rotate(*args, **kwargs):
"""
Rotate(self, double angle, Point centre_of_rotation, bool interpolating=True,
Point offset_after_rotation=None) -> Image
+
+ Rotates the image about the given point, by ``angle`` radians. Passing
+ ``True`` to ``interpolating`` results in better image quality, but is
+ slower. If the image has a mask, then the mask colour is used for the
+ uncovered pixels in the rotated image background. Otherwise, black
+ will be used as the fill colour.
+
+ Returns the rotated image, leaving this image intact.
"""
return _core_.Image_Rotate(*args, **kwargs)
def Rotate90(*args, **kwargs):
- """Rotate90(self, bool clockwise=True) -> Image"""
+ """
+ Rotate90(self, bool clockwise=True) -> Image
+
+ Returns a copy of the image rotated 90 degrees in the direction
+ indicated by ``clockwise``.
+ """
return _core_.Image_Rotate90(*args, **kwargs)
def Mirror(*args, **kwargs):
- """Mirror(self, bool horizontally=True) -> Image"""
+ """
+ Mirror(self, bool horizontally=True) -> Image
+
+ Returns a mirrored copy of the image. The parameter ``horizontally``
+ indicates the orientation.
+ """
return _core_.Image_Mirror(*args, **kwargs)
def Replace(*args, **kwargs):
"""
- Replace(self, unsigned char r1, unsigned char g1, unsigned char b1,
- unsigned char r2, unsigned char g2, unsigned char b2)
+ Replace(self, byte r1, byte g1, byte b1, byte r2, byte g2, byte b2)
+
+ Replaces the colour specified by ``(r1,g1,b1)`` by the colour
+ ``(r2,g2,b2)``.
"""
return _core_.Image_Replace(*args, **kwargs)
+ def ConvertToGreyscale(*args, **kwargs):
+ """
+ ConvertToGreyscale(self, double lr=0.299, double lg=0.587, double lb=0.114) -> Image
+
+ Convert to greyscale image. Uses the luminance component (Y) of the
+ image. The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb),
+ defaults to ITU-T BT.601
+ """
+ return _core_.Image_ConvertToGreyscale(*args, **kwargs)
+
def ConvertToMono(*args, **kwargs):
- """ConvertToMono(self, unsigned char r, unsigned char g, unsigned char b) -> Image"""
+ """
+ ConvertToMono(self, byte r, byte g, byte b) -> Image
+
+ Returns monochromatic version of the image. The returned image has
+ white colour where the original has ``(r,g,b)`` colour and black
+ colour everywhere else.
+ """
return _core_.Image_ConvertToMono(*args, **kwargs)
def SetOption(*args, **kwargs):
- """SetOption(self, String name, String value)"""
+ """
+ SetOption(self, String name, String value)
+
+ Sets an image handler defined option. For example, when saving as a
+ JPEG file, the option ``wx.IMAGE_OPTION_QUALITY`` is used, which is a
+ number between 0 and 100 (0 is terrible, 100 is very good).
+ """
return _core_.Image_SetOption(*args, **kwargs)
def SetOptionInt(*args, **kwargs):
- """SetOptionInt(self, String name, int value)"""
+ """
+ SetOptionInt(self, String name, int value)
+
+ Sets an image option as an integer.
+ """
return _core_.Image_SetOptionInt(*args, **kwargs)
def GetOption(*args, **kwargs):
- """GetOption(self, String name) -> String"""
+ """
+ GetOption(self, String name) -> String
+
+ Gets the value of an image handler option.
+ """
return _core_.Image_GetOption(*args, **kwargs)
def GetOptionInt(*args, **kwargs):
- """GetOptionInt(self, String name) -> int"""
+ """
+ GetOptionInt(self, String name) -> int
+
+ Gets the value of an image handler option as an integer. If the given
+ option is not present, the function returns 0.
+ """
return _core_.Image_GetOptionInt(*args, **kwargs)
def HasOption(*args, **kwargs):
- """HasOption(self, String name) -> bool"""
+ """
+ HasOption(self, String name) -> bool
+
+ Returns true if the given option is present.
+ """
return _core_.Image_HasOption(*args, **kwargs)
def CountColours(*args, **kwargs):
return _core_.Image_RemoveHandler(*args, **kwargs)
RemoveHandler = staticmethod(RemoveHandler)
+ def GetHandlers(*args, **kwargs):
+ """GetHandlers() -> PyObject"""
+ return _core_.Image_GetHandlers(*args, **kwargs)
+
+ GetHandlers = staticmethod(GetHandlers)
def GetImageExtWildcard(*args, **kwargs):
- """GetImageExtWildcard() -> String"""
+ """
+ GetImageExtWildcard() -> String
+
+ Iterates all registered wxImageHandler objects, and returns a string
+ containing file extension masks suitable for passing to file open/save
+ dialog boxes.
+ """
return _core_.Image_GetImageExtWildcard(*args, **kwargs)
GetImageExtWildcard = staticmethod(GetImageExtWildcard)
def ConvertToBitmap(*args, **kwargs):
- """ConvertToBitmap(self) -> Bitmap"""
+ """ConvertToBitmap(self, int depth=-1) -> Bitmap"""
return _core_.Image_ConvertToBitmap(*args, **kwargs)
def ConvertToMonoBitmap(*args, **kwargs):
- """ConvertToMonoBitmap(self, unsigned char red, unsigned char green, unsigned char blue) -> Bitmap"""
+ """ConvertToMonoBitmap(self, byte red, byte green, byte blue) -> Bitmap"""
return _core_.Image_ConvertToMonoBitmap(*args, **kwargs)
- def __nonzero__(self): return self.Ok()
+ def RotateHue(*args, **kwargs):
+ """
+ RotateHue(self, double angle)
+
+ Rotates the hue of each pixel of the image. Hue is a double in the
+ range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
+ """
+ return _core_.Image_RotateHue(*args, **kwargs)
+
+ def RGBtoHSV(*args, **kwargs):
+ """
+ RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
+
+ Converts a color in RGB color space to HSV color space.
+ """
+ return _core_.Image_RGBtoHSV(*args, **kwargs)
+
+ RGBtoHSV = staticmethod(RGBtoHSV)
+ def HSVtoRGB(*args, **kwargs):
+ """
+ HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
+
+ Converts a color in HSV color space to RGB color space.
+ """
+ return _core_.Image_HSVtoRGB(*args, **kwargs)
-class ImagePtr(Image):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Image
-_core_.Image_swigregister(ImagePtr)
+ HSVtoRGB = staticmethod(HSVtoRGB)
+ def __nonzero__(self): return self.Ok()
+Image_swigregister = _core_.Image_swigregister
+Image_swigregister(Image)
def ImageFromMime(*args, **kwargs):
- """ImageFromMime(String name, String mimetype, int index=-1) -> Image"""
+ """
+ ImageFromMime(String name, String mimetype, int index=-1) -> Image
+
+ Loads an image from a file, using a MIME type string (such as
+ 'image/jpeg') to specify image type.
+ """
val = _core_.new_ImageFromMime(*args, **kwargs)
- val.thisown = 1
return val
def ImageFromStream(*args, **kwargs):
- """ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image"""
+ """
+ ImageFromStream(InputStream stream, long type=BITMAP_TYPE_ANY, int index=-1) -> Image
+
+ Loads an image from an input stream, or any readable Python file-like
+ object.
+ """
val = _core_.new_ImageFromStream(*args, **kwargs)
- val.thisown = 1
return val
def ImageFromStreamMime(*args, **kwargs):
- """ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image"""
+ """
+ ImageFromStreamMime(InputStream stream, String mimetype, int index=-1) -> Image
+
+ Loads an image from an input stream, or any readable Python file-like
+ object, specifying the image format with a MIME type string.
+ """
val = _core_.new_ImageFromStreamMime(*args, **kwargs)
- val.thisown = 1
return val
def EmptyImage(*args, **kwargs):
- """EmptyImage(int width=0, int height=0, bool clear=True) -> Image"""
+ """
+ EmptyImage(int width=0, int height=0, bool clear=True) -> Image
+
+ Construct an empty image of a given size, optionally setting all
+ pixels to black.
+ """
val = _core_.new_EmptyImage(*args, **kwargs)
- val.thisown = 1
return val
def ImageFromBitmap(*args, **kwargs):
- """ImageFromBitmap(Bitmap bitmap) -> Image"""
+ """
+ ImageFromBitmap(Bitmap bitmap) -> Image
+
+ Construct an Image from a `wx.Bitmap`.
+ """
val = _core_.new_ImageFromBitmap(*args, **kwargs)
- val.thisown = 1
return val
def ImageFromData(*args, **kwargs):
- """ImageFromData(int width, int height, unsigned char data) -> Image"""
+ """
+ ImageFromData(int width, int height, buffer data) -> Image
+
+ Construct an Image from a buffer of RGB bytes. Accepts either a
+ string or a buffer object holding the data and the length of the data
+ must be width*height*3.
+ """
val = _core_.new_ImageFromData(*args, **kwargs)
- val.thisown = 1
+ return val
+
+def ImageFromDataWithAlpha(*args, **kwargs):
+ """
+ ImageFromDataWithAlpha(int width, int height, buffer data, buffer alpha) -> Image
+
+ Construct an Image from a buffer of RGB bytes with an Alpha channel.
+ Accepts either a string or a buffer object holding the data and the
+ length of the data must be width*height*3 bytes, and the length of the
+ alpha data must be width*height bytes.
+ """
+ val = _core_.new_ImageFromDataWithAlpha(*args, **kwargs)
return val
def Image_CanRead(*args, **kwargs):
- """Image_CanRead(String name) -> bool"""
- return _core_.Image_CanRead(*args, **kwargs)
+ """
+ Image_CanRead(String filename) -> bool
+
+ Returns True if the image handlers can read this file.
+ """
+ return _core_.Image_CanRead(*args, **kwargs)
def Image_GetImageCount(*args, **kwargs):
- """Image_GetImageCount(String name, long type=BITMAP_TYPE_ANY) -> int"""
- return _core_.Image_GetImageCount(*args, **kwargs)
+ """
+ Image_GetImageCount(String filename, long type=BITMAP_TYPE_ANY) -> int
+
+ If the image file contains more than one image and the image handler
+ is capable of retrieving these individually, this function will return
+ the number of available images.
+ """
+ return _core_.Image_GetImageCount(*args, **kwargs)
def Image_CanReadStream(*args, **kwargs):
- """Image_CanReadStream(InputStream stream) -> bool"""
- return _core_.Image_CanReadStream(*args, **kwargs)
+ """
+ Image_CanReadStream(InputStream stream) -> bool
+
+ Returns True if the image handlers can read an image file from the
+ data currently on the input stream, or a readable Python file-like
+ object.
+ """
+ return _core_.Image_CanReadStream(*args, **kwargs)
def Image_AddHandler(*args, **kwargs):
- """Image_AddHandler(ImageHandler handler)"""
- return _core_.Image_AddHandler(*args, **kwargs)
+ """Image_AddHandler(ImageHandler handler)"""
+ return _core_.Image_AddHandler(*args, **kwargs)
def Image_InsertHandler(*args, **kwargs):
- """Image_InsertHandler(ImageHandler handler)"""
- return _core_.Image_InsertHandler(*args, **kwargs)
+ """Image_InsertHandler(ImageHandler handler)"""
+ return _core_.Image_InsertHandler(*args, **kwargs)
def Image_RemoveHandler(*args, **kwargs):
- """Image_RemoveHandler(String name) -> bool"""
- return _core_.Image_RemoveHandler(*args, **kwargs)
+ """Image_RemoveHandler(String name) -> bool"""
+ return _core_.Image_RemoveHandler(*args, **kwargs)
+
+def Image_GetHandlers(*args):
+ """Image_GetHandlers() -> PyObject"""
+ return _core_.Image_GetHandlers(*args)
+
+def Image_GetImageExtWildcard(*args):
+ """
+ Image_GetImageExtWildcard() -> String
+
+ Iterates all registered wxImageHandler objects, and returns a string
+ containing file extension masks suitable for passing to file open/save
+ dialog boxes.
+ """
+ return _core_.Image_GetImageExtWildcard(*args)
+
+def Image_RGBtoHSV(*args, **kwargs):
+ """
+ Image_RGBtoHSV(Image_RGBValue rgb) -> Image_HSVValue
+
+ Converts a color in RGB color space to HSV color space.
+ """
+ return _core_.Image_RGBtoHSV(*args, **kwargs)
-def Image_GetImageExtWildcard(*args, **kwargs):
- """Image_GetImageExtWildcard() -> String"""
- return _core_.Image_GetImageExtWildcard(*args, **kwargs)
+def Image_HSVtoRGB(*args, **kwargs):
+ """
+ Image_HSVtoRGB(Image_HSVValue hsv) -> Image_RGBValue
+
+ Converts a color in HSV color space to RGB color space.
+ """
+ return _core_.Image_HSVtoRGB(*args, **kwargs)
def InitAllImageHandlers():
"""
IMAGE_RESOLUTION_INCHES = _core_.IMAGE_RESOLUTION_INCHES
IMAGE_RESOLUTION_CM = _core_.IMAGE_RESOLUTION_CM
+PNG_TYPE_COLOUR = _core_.PNG_TYPE_COLOUR
+PNG_TYPE_GREY = _core_.PNG_TYPE_GREY
+PNG_TYPE_GREY_RED = _core_.PNG_TYPE_GREY_RED
BMP_24BPP = _core_.BMP_24BPP
BMP_8BPP = _core_.BMP_8BPP
BMP_8BPP_GREY = _core_.BMP_8BPP_GREY
BMP_1BPP = _core_.BMP_1BPP
BMP_1BPP_BW = _core_.BMP_1BPP_BW
class BMPHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxBMPHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> BMPHandler"""
- newobj = _core_.new_BMPHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class BMPHandlerPtr(BMPHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = BMPHandler
-_core_.BMPHandler_swigregister(BMPHandlerPtr)
+ """A `wx.ImageHandler` for \*.bmp bitmap files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> BMPHandler
+
+ A `wx.ImageHandler` for \*.bmp bitmap files.
+ """
+ _core_.BMPHandler_swiginit(self,_core_.new_BMPHandler(*args, **kwargs))
+BMPHandler_swigregister = _core_.BMPHandler_swigregister
+BMPHandler_swigregister(BMPHandler)
NullImage = cvar.NullImage
+IMAGE_OPTION_FILENAME = cvar.IMAGE_OPTION_FILENAME
IMAGE_OPTION_BMP_FORMAT = cvar.IMAGE_OPTION_BMP_FORMAT
IMAGE_OPTION_CUR_HOTSPOT_X = cvar.IMAGE_OPTION_CUR_HOTSPOT_X
IMAGE_OPTION_CUR_HOTSPOT_Y = cvar.IMAGE_OPTION_CUR_HOTSPOT_Y
IMAGE_OPTION_RESOLUTION = cvar.IMAGE_OPTION_RESOLUTION
+IMAGE_OPTION_RESOLUTIONX = cvar.IMAGE_OPTION_RESOLUTIONX
+IMAGE_OPTION_RESOLUTIONY = cvar.IMAGE_OPTION_RESOLUTIONY
IMAGE_OPTION_RESOLUTIONUNIT = cvar.IMAGE_OPTION_RESOLUTIONUNIT
+IMAGE_OPTION_QUALITY = cvar.IMAGE_OPTION_QUALITY
+IMAGE_OPTION_BITSPERSAMPLE = cvar.IMAGE_OPTION_BITSPERSAMPLE
+IMAGE_OPTION_SAMPLESPERPIXEL = cvar.IMAGE_OPTION_SAMPLESPERPIXEL
+IMAGE_OPTION_COMPRESSION = cvar.IMAGE_OPTION_COMPRESSION
+IMAGE_OPTION_IMAGEDESCRIPTOR = cvar.IMAGE_OPTION_IMAGEDESCRIPTOR
+IMAGE_OPTION_PNG_FORMAT = cvar.IMAGE_OPTION_PNG_FORMAT
+IMAGE_OPTION_PNG_BITDEPTH = cvar.IMAGE_OPTION_PNG_BITDEPTH
class ICOHandler(BMPHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxICOHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> ICOHandler"""
- newobj = _core_.new_ICOHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class ICOHandlerPtr(ICOHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ICOHandler
-_core_.ICOHandler_swigregister(ICOHandlerPtr)
+ """A `wx.ImageHandler` for \*.ico icon files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> ICOHandler
+
+ A `wx.ImageHandler` for \*.ico icon files.
+ """
+ _core_.ICOHandler_swiginit(self,_core_.new_ICOHandler(*args, **kwargs))
+ICOHandler_swigregister = _core_.ICOHandler_swigregister
+ICOHandler_swigregister(ICOHandler)
class CURHandler(ICOHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxCURHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> CURHandler"""
- newobj = _core_.new_CURHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class CURHandlerPtr(CURHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = CURHandler
-_core_.CURHandler_swigregister(CURHandlerPtr)
+ """A `wx.ImageHandler` for \*.cur cursor files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> CURHandler
+
+ A `wx.ImageHandler` for \*.cur cursor files.
+ """
+ _core_.CURHandler_swiginit(self,_core_.new_CURHandler(*args, **kwargs))
+CURHandler_swigregister = _core_.CURHandler_swigregister
+CURHandler_swigregister(CURHandler)
class ANIHandler(CURHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxANIHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> ANIHandler"""
- newobj = _core_.new_ANIHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class ANIHandlerPtr(ANIHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ANIHandler
-_core_.ANIHandler_swigregister(ANIHandlerPtr)
+ """A `wx.ImageHandler` for \*.ani animated cursor files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> ANIHandler
+
+ A `wx.ImageHandler` for \*.ani animated cursor files.
+ """
+ _core_.ANIHandler_swiginit(self,_core_.new_ANIHandler(*args, **kwargs))
+ANIHandler_swigregister = _core_.ANIHandler_swigregister
+ANIHandler_swigregister(ANIHandler)
class PNGHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPNGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> PNGHandler"""
- newobj = _core_.new_PNGHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class PNGHandlerPtr(PNGHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PNGHandler
-_core_.PNGHandler_swigregister(PNGHandlerPtr)
+ """A `wx.ImageHandler` for PNG image files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> PNGHandler
+
+ A `wx.ImageHandler` for PNG image files.
+ """
+ _core_.PNGHandler_swiginit(self,_core_.new_PNGHandler(*args, **kwargs))
+PNGHandler_swigregister = _core_.PNGHandler_swigregister
+PNGHandler_swigregister(PNGHandler)
class GIFHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxGIFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> GIFHandler"""
- newobj = _core_.new_GIFHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class GIFHandlerPtr(GIFHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = GIFHandler
-_core_.GIFHandler_swigregister(GIFHandlerPtr)
+ """A `wx.ImageHandler` for GIF image files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> GIFHandler
+
+ A `wx.ImageHandler` for GIF image files.
+ """
+ _core_.GIFHandler_swiginit(self,_core_.new_GIFHandler(*args, **kwargs))
+GIFHandler_swigregister = _core_.GIFHandler_swigregister
+GIFHandler_swigregister(GIFHandler)
class PCXHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPCXHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> PCXHandler"""
- newobj = _core_.new_PCXHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class PCXHandlerPtr(PCXHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PCXHandler
-_core_.PCXHandler_swigregister(PCXHandlerPtr)
+ """A `wx.ImageHandler` for PCX imager files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> PCXHandler
+
+ A `wx.ImageHandler` for PCX imager files.
+ """
+ _core_.PCXHandler_swiginit(self,_core_.new_PCXHandler(*args, **kwargs))
+PCXHandler_swigregister = _core_.PCXHandler_swigregister
+PCXHandler_swigregister(PCXHandler)
class JPEGHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxJPEGHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> JPEGHandler"""
- newobj = _core_.new_JPEGHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class JPEGHandlerPtr(JPEGHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = JPEGHandler
-_core_.JPEGHandler_swigregister(JPEGHandlerPtr)
+ """A `wx.ImageHandler` for JPEG/JPG image files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> JPEGHandler
+
+ A `wx.ImageHandler` for JPEG/JPG image files.
+ """
+ _core_.JPEGHandler_swiginit(self,_core_.new_JPEGHandler(*args, **kwargs))
+JPEGHandler_swigregister = _core_.JPEGHandler_swigregister
+JPEGHandler_swigregister(JPEGHandler)
class PNMHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPNMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> PNMHandler"""
- newobj = _core_.new_PNMHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class PNMHandlerPtr(PNMHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PNMHandler
-_core_.PNMHandler_swigregister(PNMHandlerPtr)
+ """A `wx.ImageHandler` for PNM image files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> PNMHandler
+
+ A `wx.ImageHandler` for PNM image files.
+ """
+ _core_.PNMHandler_swiginit(self,_core_.new_PNMHandler(*args, **kwargs))
+PNMHandler_swigregister = _core_.PNMHandler_swigregister
+PNMHandler_swigregister(PNMHandler)
class XPMHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxXPMHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> XPMHandler"""
- newobj = _core_.new_XPMHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class XPMHandlerPtr(XPMHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = XPMHandler
-_core_.XPMHandler_swigregister(XPMHandlerPtr)
+ """A `wx.ImageHandler` for XPM image."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> XPMHandler
+
+ A `wx.ImageHandler` for XPM image.
+ """
+ _core_.XPMHandler_swiginit(self,_core_.new_XPMHandler(*args, **kwargs))
+XPMHandler_swigregister = _core_.XPMHandler_swigregister
+XPMHandler_swigregister(XPMHandler)
class TIFFHandler(ImageHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxTIFFHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> TIFFHandler"""
- newobj = _core_.new_TIFFHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class TIFFHandlerPtr(TIFFHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = TIFFHandler
-_core_.TIFFHandler_swigregister(TIFFHandlerPtr)
+ """A `wx.ImageHandler` for TIFF image files."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> TIFFHandler
+
+ A `wx.ImageHandler` for TIFF image files.
+ """
+ _core_.TIFFHandler_swiginit(self,_core_.new_TIFFHandler(*args, **kwargs))
+TIFFHandler_swigregister = _core_.TIFFHandler_swigregister
+TIFFHandler_swigregister(TIFFHandler)
+
+QUANTIZE_INCLUDE_WINDOWS_COLOURS = _core_.QUANTIZE_INCLUDE_WINDOWS_COLOURS
+QUANTIZE_FILL_DESTINATION_IMAGE = _core_.QUANTIZE_FILL_DESTINATION_IMAGE
+class Quantize(object):
+ """Performs quantization, or colour reduction, on a wxImage."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
+ def Quantize(*args, **kwargs):
+ """
+ Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
+
+ Reduce the colours in the source image and put the result into the
+ destination image, setting the palette in the destination if
+ needed. Both images may be the same, to overwrite the source image.
+ """
+ return _core_.Quantize_Quantize(*args, **kwargs)
+
+ Quantize = staticmethod(Quantize)
+Quantize_swigregister = _core_.Quantize_swigregister
+Quantize_swigregister(Quantize)
+
+def Quantize_Quantize(*args, **kwargs):
+ """
+ Quantize_Quantize(Image src, Image dest, int desiredNoColours=236, int flags=wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE) -> bool
+
+ Reduce the colours in the source image and put the result into the
+ destination image, setting the palette in the destination if
+ needed. Both images may be the same, to overwrite the source image.
+ """
+ return _core_.Quantize_Quantize(*args, **kwargs)
#---------------------------------------------------------------------------
class EvtHandler(Object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxEvtHandler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ EvtHandler class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> EvtHandler"""
- newobj = _core_.new_EvtHandler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.EvtHandler_swiginit(self,_core_.new_EvtHandler(*args, **kwargs))
def GetNextHandler(*args, **kwargs):
"""GetNextHandler(self) -> EvtHandler"""
return _core_.EvtHandler_GetNextHandler(*args, **kwargs)
return _core_.EvtHandler_Disconnect(*args, **kwargs)
def _setOORInfo(*args, **kwargs):
- """_setOORInfo(self, PyObject _self)"""
- return _core_.EvtHandler__setOORInfo(*args, **kwargs)
+ """_setOORInfo(self, PyObject _self, bool incref=True)"""
+ val = _core_.EvtHandler__setOORInfo(*args, **kwargs)
+ args[0].thisown = 0
+ return val
def Bind(self, event, handler, source=None, id=wx.ID_ANY, id2=wx.ID_ANY):
"""
id = source.GetId()
return event.Unbind(self, id, id2)
-
-class EvtHandlerPtr(EvtHandler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = EvtHandler
-_core_.EvtHandler_swigregister(EvtHandlerPtr)
+EvtHandler_swigregister = _core_.EvtHandler_swigregister
+EvtHandler_swigregister(EvtHandler)
#---------------------------------------------------------------------------
EVENT_PROPAGATE_NONE = _core_.EVENT_PROPAGATE_NONE
EVENT_PROPAGATE_MAX = _core_.EVENT_PROPAGATE_MAX
-def NewEventType(*args, **kwargs):
- """NewEventType() -> wxEventType"""
- return _core_.NewEventType(*args, **kwargs)
+def NewEventType(*args):
+ """NewEventType() -> wxEventType"""
+ return _core_.NewEventType(*args)
wxEVT_NULL = _core_.wxEVT_NULL
wxEVT_FIRST = _core_.wxEVT_FIRST
wxEVT_USER_FIRST = _core_.wxEVT_USER_FIRST
wxEVT_SCROLL_PAGEDOWN = _core_.wxEVT_SCROLL_PAGEDOWN
wxEVT_SCROLL_THUMBTRACK = _core_.wxEVT_SCROLL_THUMBTRACK
wxEVT_SCROLL_THUMBRELEASE = _core_.wxEVT_SCROLL_THUMBRELEASE
-wxEVT_SCROLL_ENDSCROLL = _core_.wxEVT_SCROLL_ENDSCROLL
+wxEVT_SCROLL_CHANGED = _core_.wxEVT_SCROLL_CHANGED
+wxEVT_SCROLL_ENDSCROLL = wxEVT_SCROLL_CHANGED
wxEVT_SCROLLWIN_TOP = _core_.wxEVT_SCROLLWIN_TOP
wxEVT_SCROLLWIN_BOTTOM = _core_.wxEVT_SCROLLWIN_BOTTOM
wxEVT_SCROLLWIN_LINEUP = _core_.wxEVT_SCROLLWIN_LINEUP
wxEVT_UPDATE_UI = _core_.wxEVT_UPDATE_UI
wxEVT_SIZING = _core_.wxEVT_SIZING
wxEVT_MOVING = _core_.wxEVT_MOVING
+wxEVT_HIBERNATE = _core_.wxEVT_HIBERNATE
wxEVT_COMMAND_LEFT_CLICK = _core_.wxEVT_COMMAND_LEFT_CLICK
wxEVT_COMMAND_LEFT_DCLICK = _core_.wxEVT_COMMAND_LEFT_DCLICK
wxEVT_COMMAND_RIGHT_CLICK = _core_.wxEVT_COMMAND_RIGHT_CLICK
EVT_CHILD_FOCUS = wx.PyEventBinder( wxEVT_CHILD_FOCUS )
EVT_ACTIVATE = wx.PyEventBinder( wxEVT_ACTIVATE )
EVT_ACTIVATE_APP = wx.PyEventBinder( wxEVT_ACTIVATE_APP )
+EVT_HIBERNATE = wx.PyEventBinder( wxEVT_HIBERNATE )
EVT_END_SESSION = wx.PyEventBinder( wxEVT_END_SESSION )
EVT_QUERY_END_SESSION = wx.PyEventBinder( wxEVT_QUERY_END_SESSION )
EVT_DROP_FILES = wx.PyEventBinder( wxEVT_DROP_FILES )
EVT_SCROLLWIN_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBTRACK )
EVT_SCROLLWIN_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLLWIN_THUMBRELEASE )
-# Scrolling from wxSlider and wxScrollBar
+# Scrolling from wx.Slider and wx.ScrollBar
EVT_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
wxEVT_SCROLL_BOTTOM,
wxEVT_SCROLL_LINEUP,
wxEVT_SCROLL_PAGEDOWN,
wxEVT_SCROLL_THUMBTRACK,
wxEVT_SCROLL_THUMBRELEASE,
- wxEVT_SCROLL_ENDSCROLL,
+ wxEVT_SCROLL_CHANGED,
])
EVT_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP )
EVT_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN )
EVT_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK )
EVT_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE )
-EVT_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL )
-
-# Scrolling from wxSlider and wxScrollBar, with an id
+EVT_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED )
+EVT_SCROLL_ENDSCROLL = EVT_SCROLL_CHANGED
+
+# Scrolling from wx.Slider and wx.ScrollBar, with an id
EVT_COMMAND_SCROLL = wx.PyEventBinder([ wxEVT_SCROLL_TOP,
wxEVT_SCROLL_BOTTOM,
wxEVT_SCROLL_LINEUP,
wxEVT_SCROLL_PAGEDOWN,
wxEVT_SCROLL_THUMBTRACK,
wxEVT_SCROLL_THUMBRELEASE,
- wxEVT_SCROLL_ENDSCROLL,
+ wxEVT_SCROLL_CHANGED,
], 1)
EVT_COMMAND_SCROLL_TOP = wx.PyEventBinder( wxEVT_SCROLL_TOP, 1)
EVT_COMMAND_SCROLL_PAGEDOWN = wx.PyEventBinder( wxEVT_SCROLL_PAGEDOWN, 1)
EVT_COMMAND_SCROLL_THUMBTRACK = wx.PyEventBinder( wxEVT_SCROLL_THUMBTRACK, 1)
EVT_COMMAND_SCROLL_THUMBRELEASE = wx.PyEventBinder( wxEVT_SCROLL_THUMBRELEASE, 1)
-EVT_COMMAND_SCROLL_ENDSCROLL = wx.PyEventBinder( wxEVT_SCROLL_ENDSCROLL, 1)
+EVT_COMMAND_SCROLL_CHANGED = wx.PyEventBinder( wxEVT_SCROLL_CHANGED, 1)
+EVT_COMMAND_SCROLL_ENDSCROLL = EVT_COMMAND_SCROLL_CHANGED
EVT_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_BUTTON_CLICKED, 1)
EVT_CHECKBOX = wx.PyEventBinder( wxEVT_COMMAND_CHECKBOX_CLICKED, 1)
#---------------------------------------------------------------------------
class Event(Object):
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __del__(self, destroy=_core_.delete_Event):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ """
+ An event is a structure holding information about an event passed to a
+ callback or member function. wx.Event is an abstract base class for
+ other event classes
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
+ __swig_destroy__ = _core_.delete_Event
+ __del__ = lambda self : None;
def SetEventType(*args, **kwargs):
- """SetEventType(self, wxEventType typ)"""
+ """
+ SetEventType(self, wxEventType typ)
+
+ Sets the specific type of the event.
+ """
return _core_.Event_SetEventType(*args, **kwargs)
def GetEventType(*args, **kwargs):
- """GetEventType(self) -> wxEventType"""
+ """
+ GetEventType(self) -> wxEventType
+
+ Returns the identifier of the given event type, such as
+ ``wxEVT_COMMAND_BUTTON_CLICKED``.
+ """
return _core_.Event_GetEventType(*args, **kwargs)
def GetEventObject(*args, **kwargs):
- """GetEventObject(self) -> Object"""
+ """
+ GetEventObject(self) -> Object
+
+ Returns the object (usually a window) associated with the event, if
+ any.
+ """
return _core_.Event_GetEventObject(*args, **kwargs)
def SetEventObject(*args, **kwargs):
- """SetEventObject(self, Object obj)"""
+ """
+ SetEventObject(self, Object obj)
+
+ Sets the originating object, or in other words, obj is normally the
+ object that is sending the event.
+ """
return _core_.Event_SetEventObject(*args, **kwargs)
def GetTimestamp(*args, **kwargs):
return _core_.Event_SetTimestamp(*args, **kwargs)
def GetId(*args, **kwargs):
- """GetId(self) -> int"""
+ """
+ GetId(self) -> int
+
+ Returns the identifier associated with this event, such as a button
+ command id.
+ """
return _core_.Event_GetId(*args, **kwargs)
def SetId(*args, **kwargs):
- """SetId(self, int Id)"""
+ """
+ SetId(self, int Id)
+
+ Set's the ID for the event. This is usually the ID of the window that
+ is sending the event, but it can also be a command id from a menu
+ item, etc.
+ """
return _core_.Event_SetId(*args, **kwargs)
def IsCommandEvent(*args, **kwargs):
- """IsCommandEvent(self) -> bool"""
+ """
+ IsCommandEvent(self) -> bool
+
+ Returns true if the event is or is derived from `wx.CommandEvent` else
+ it returns false. Note: Exists only for optimization purposes.
+ """
return _core_.Event_IsCommandEvent(*args, **kwargs)
def Skip(*args, **kwargs):
- """Skip(self, bool skip=True)"""
+ """
+ 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.
+
+ """
return _core_.Event_Skip(*args, **kwargs)
def GetSkipped(*args, **kwargs):
- """GetSkipped(self) -> bool"""
+ """
+ GetSkipped(self) -> bool
+
+ Returns true if the event handler should be skipped, false otherwise.
+ :see: `Skip`
+ """
return _core_.Event_GetSkipped(*args, **kwargs)
def ShouldPropagate(*args, **kwargs):
- """ShouldPropagate(self) -> bool"""
+ """
+ ShouldPropagate(self) -> bool
+
+ Test if this event should be propagated to the parent window or not,
+ i.e. if the propagation level is currently greater than 0.
+ """
return _core_.Event_ShouldPropagate(*args, **kwargs)
def StopPropagation(*args, **kwargs):
- """StopPropagation(self) -> int"""
+ """
+ StopPropagation(self) -> int
+
+ Stop the event from propagating to its parent window. Returns the old
+ propagation level value which may be later passed to
+ `ResumePropagation` to allow propagating the event again.
+ """
return _core_.Event_StopPropagation(*args, **kwargs)
def ResumePropagation(*args, **kwargs):
- """ResumePropagation(self, int propagationLevel)"""
+ """
+ ResumePropagation(self, int propagationLevel)
+
+ Resume the event propagation by restoring the propagation level. (For
+ example, you can use the value returned by an earlier call to
+ `StopPropagation`.)
+
+ """
return _core_.Event_ResumePropagation(*args, **kwargs)
def Clone(*args, **kwargs):
"""Clone(self) -> Event"""
return _core_.Event_Clone(*args, **kwargs)
-
-class EventPtr(Event):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Event
-_core_.Event_swigregister(EventPtr)
+Event_swigregister = _core_.Event_swigregister
+Event_swigregister(Event)
#---------------------------------------------------------------------------
class PropagationDisabler(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPropagationDisabler instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Event event) -> PropagationDisabler"""
- newobj = _core_.new_PropagationDisabler(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_PropagationDisabler):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ """
+ Helper class to temporarily change an event not to propagate. Simply
+ create an instance of this class and then whe it is destroyed the
+ propogation of the event will be restored.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Event event) -> PropagationDisabler
-class PropagationDisablerPtr(PropagationDisabler):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PropagationDisabler
-_core_.PropagationDisabler_swigregister(PropagationDisablerPtr)
+ Helper class to temporarily change an event not to propagate. Simply
+ create an instance of this class and then whe it is destroyed the
+ propogation of the event will be restored.
+ """
+ _core_.PropagationDisabler_swiginit(self,_core_.new_PropagationDisabler(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_PropagationDisabler
+ __del__ = lambda self : None;
+PropagationDisabler_swigregister = _core_.PropagationDisabler_swigregister
+PropagationDisabler_swigregister(PropagationDisabler)
class PropagateOnce(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPropagateOnce instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Event event) -> PropagateOnce"""
- newobj = _core_.new_PropagateOnce(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_PropagateOnce):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ """
+ A helper class that will temporarily lower propagation level of an
+ event. Simply create an instance of this class and then whe it is
+ destroyed the propogation of the event will be restored.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Event event) -> PropagateOnce
-class PropagateOncePtr(PropagateOnce):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PropagateOnce
-_core_.PropagateOnce_swigregister(PropagateOncePtr)
+ A helper class that will temporarily lower propagation level of an
+ event. Simply create an instance of this class and then whe it is
+ destroyed the propogation of the event will be restored.
+ """
+ _core_.PropagateOnce_swiginit(self,_core_.new_PropagateOnce(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_PropagateOnce
+ __del__ = lambda self : None;
+PropagateOnce_swigregister = _core_.PropagateOnce_swigregister
+PropagateOnce_swigregister(PropagateOnce)
#---------------------------------------------------------------------------
class CommandEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent"""
- newobj = _core_.new_CommandEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def GetSelection(*args, **kwargs):
- """GetSelection(self) -> int"""
+ """
+ This event class contains information about command events, which
+ originate from a variety of simple controls, as well as menus and
+ toolbars.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> CommandEvent
+
+ This event class contains information about command events, which
+ originate from a variety of simple controls, as well as menus and
+ toolbars.
+ """
+ _core_.CommandEvent_swiginit(self,_core_.new_CommandEvent(*args, **kwargs))
+ def GetSelection(*args, **kwargs):
+ """
+ GetSelection(self) -> int
+
+ Returns item index for a listbox or choice selection event (not valid
+ for a deselection).
+ """
return _core_.CommandEvent_GetSelection(*args, **kwargs)
def SetString(*args, **kwargs):
return _core_.CommandEvent_SetString(*args, **kwargs)
def GetString(*args, **kwargs):
- """GetString(self) -> String"""
+ """
+ GetString(self) -> String
+
+ Returns item string for a listbox or choice selection event (not valid
+ for a deselection).
+ """
return _core_.CommandEvent_GetString(*args, **kwargs)
def IsChecked(*args, **kwargs):
- """IsChecked(self) -> bool"""
+ """
+ IsChecked(self) -> bool
+
+ This method can be used with checkbox and menu events: for the
+ checkboxes, the method returns true for a selection event and false
+ for a deselection one. For the menu events, this method indicates if
+ the menu item just has become checked or unchecked (and thus only
+ makes sense for checkable menu items).
+ """
return _core_.CommandEvent_IsChecked(*args, **kwargs)
Checked = IsChecked
def IsSelection(*args, **kwargs):
- """IsSelection(self) -> bool"""
+ """
+ IsSelection(self) -> bool
+
+ For a listbox or similar event, returns true if it is a selection,
+ false if it is a deselection.
+ """
return _core_.CommandEvent_IsSelection(*args, **kwargs)
def SetExtraLong(*args, **kwargs):
return _core_.CommandEvent_SetExtraLong(*args, **kwargs)
def GetExtraLong(*args, **kwargs):
- """GetExtraLong(self) -> long"""
+ """
+ GetExtraLong(self) -> long
+
+ Returns extra information dependant on the event objects type. If the
+ event comes from a listbox selection, it is a boolean determining
+ whether the event was a selection (true) or a deselection (false). A
+ listbox deselection only occurs for multiple-selection boxes, and in
+ this case the index and string values are indeterminate and the
+ listbox must be examined by the application.
+ """
return _core_.CommandEvent_GetExtraLong(*args, **kwargs)
def SetInt(*args, **kwargs):
return _core_.CommandEvent_SetInt(*args, **kwargs)
def GetInt(*args, **kwargs):
- """GetInt(self) -> long"""
+ """
+ GetInt(self) -> long
+
+ Returns the integer identifier corresponding to a listbox, choice or
+ radiobox selection (only if the event was a selection, not a
+ deselection), or a boolean value representing the value of a checkbox.
+ """
return _core_.CommandEvent_GetInt(*args, **kwargs)
+ def GetClientData(*args, **kwargs):
+ """
+ GetClientData(self) -> PyObject
+
+ Returns the client data object for a listbox or choice selection event, (if any.)
+ """
+ return _core_.CommandEvent_GetClientData(*args, **kwargs)
+
+ def SetClientData(*args, **kwargs):
+ """
+ SetClientData(self, PyObject clientData)
+
+ Associate the given client data with the item at position n.
+ """
+ return _core_.CommandEvent_SetClientData(*args, **kwargs)
+
+ GetClientObject = GetClientData
+ SetClientObject = SetClientData
+
def Clone(*args, **kwargs):
"""Clone(self) -> Event"""
return _core_.CommandEvent_Clone(*args, **kwargs)
-
-class CommandEventPtr(CommandEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = CommandEvent
-_core_.CommandEvent_swigregister(CommandEventPtr)
+CommandEvent_swigregister = _core_.CommandEvent_swigregister
+CommandEvent_swigregister(CommandEvent)
#---------------------------------------------------------------------------
class NotifyEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxNotifyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent"""
- newobj = _core_.new_NotifyEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An instance of this class (or one of its derived classes) is sent from
+ a control when the control's state is being changed and the control
+ allows that change to be prevented from happening. The event handler
+ can call `Veto` or `Allow` to tell the control what to do.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType commandType=wxEVT_NULL, int winid=0) -> NotifyEvent
+
+ An instance of this class (or one of its derived classes) is sent from
+ a control when the control's state is being changed and the control
+ allows that change to be prevented from happening. The event handler
+ can call `Veto` or `Allow` to tell the control what to do.
+ """
+ _core_.NotifyEvent_swiginit(self,_core_.new_NotifyEvent(*args, **kwargs))
def Veto(*args, **kwargs):
- """Veto(self)"""
+ """
+ Veto(self)
+
+ Prevents the change announced by this event from happening.
+
+ It is in general a good idea to notify the user about the reasons for
+ vetoing the change because otherwise the applications behaviour (which
+ just refuses to do what the user wants) might be quite surprising.
+ """
return _core_.NotifyEvent_Veto(*args, **kwargs)
def Allow(*args, **kwargs):
- """Allow(self)"""
+ """
+ Allow(self)
+
+ This is the opposite of `Veto`: it explicitly allows the event to be
+ processed. For most events it is not necessary to call this method as
+ the events are allowed anyhow but some are forbidden by default (this
+ will be mentioned in the corresponding event description).
+ """
return _core_.NotifyEvent_Allow(*args, **kwargs)
def IsAllowed(*args, **kwargs):
- """IsAllowed(self) -> bool"""
- return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
+ """
+ IsAllowed(self) -> bool
+ Returns true if the change is allowed (`Veto` hasn't been called) or
+ false otherwise (if it was).
+ """
+ return _core_.NotifyEvent_IsAllowed(*args, **kwargs)
-class NotifyEventPtr(NotifyEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = NotifyEvent
-_core_.NotifyEvent_swigregister(NotifyEventPtr)
+NotifyEvent_swigregister = _core_.NotifyEvent_swigregister
+NotifyEvent_swigregister(NotifyEvent)
#---------------------------------------------------------------------------
class ScrollEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxScrollEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """
+ A scroll event holds information about events sent from stand-alone
+ scrollbars and sliders. Note that scrolled windows do not send
+ instnaces of this event class, but send the `wx.ScrollWinEvent`
+ instead.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, wxEventType commandType=wxEVT_NULL, int winid=0, int pos=0,
int orient=0) -> ScrollEvent
"""
- newobj = _core_.new_ScrollEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.ScrollEvent_swiginit(self,_core_.new_ScrollEvent(*args, **kwargs))
def GetOrientation(*args, **kwargs):
- """GetOrientation(self) -> int"""
+ """
+ GetOrientation(self) -> int
+
+ Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
+ the scrollbar.
+ """
return _core_.ScrollEvent_GetOrientation(*args, **kwargs)
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> int"""
+ """
+ GetPosition(self) -> int
+
+ Returns the position of the scrollbar.
+ """
return _core_.ScrollEvent_GetPosition(*args, **kwargs)
def SetOrientation(*args, **kwargs):
"""SetPosition(self, int pos)"""
return _core_.ScrollEvent_SetPosition(*args, **kwargs)
-
-class ScrollEventPtr(ScrollEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ScrollEvent
-_core_.ScrollEvent_swigregister(ScrollEventPtr)
+ScrollEvent_swigregister = _core_.ScrollEvent_swigregister
+ScrollEvent_swigregister(ScrollEvent)
#---------------------------------------------------------------------------
class ScrollWinEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxScrollWinEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent"""
- newobj = _core_.new_ScrollWinEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ A wx.ScrollWinEvent holds information about scrolling and is sent from
+ scrolling windows.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType commandType=wxEVT_NULL, int pos=0, int orient=0) -> ScrollWinEvent
+
+ A wx.ScrollWinEvent holds information about scrolling and is sent from
+ scrolling windows.
+ """
+ _core_.ScrollWinEvent_swiginit(self,_core_.new_ScrollWinEvent(*args, **kwargs))
def GetOrientation(*args, **kwargs):
- """GetOrientation(self) -> int"""
+ """
+ GetOrientation(self) -> int
+
+ Returns wx.HORIZONTAL or wx.VERTICAL, depending on the orientation of
+ the scrollbar.
+ """
return _core_.ScrollWinEvent_GetOrientation(*args, **kwargs)
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> int"""
+ """
+ GetPosition(self) -> int
+
+ Returns the position of the scrollbar for the thumb track and release
+ events. Note that this field can't be used for the other events, you
+ need to query the window itself for the current position in that case.
+ """
return _core_.ScrollWinEvent_GetPosition(*args, **kwargs)
def SetOrientation(*args, **kwargs):
"""SetPosition(self, int pos)"""
return _core_.ScrollWinEvent_SetPosition(*args, **kwargs)
-
-class ScrollWinEventPtr(ScrollWinEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ScrollWinEvent
-_core_.ScrollWinEvent_swigregister(ScrollWinEventPtr)
+ScrollWinEvent_swigregister = _core_.ScrollWinEvent_swigregister
+ScrollWinEvent_swigregister(ScrollWinEvent)
#---------------------------------------------------------------------------
MOUSE_BTN_MIDDLE = _core_.MOUSE_BTN_MIDDLE
MOUSE_BTN_RIGHT = _core_.MOUSE_BTN_RIGHT
class MouseEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMouseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent"""
- newobj = _core_.new_MouseEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This event class contains information about the events generated by
+ the mouse: they include mouse buttons press and release events and
+ mouse move events.
+
+ All mouse events involving the buttons use ``wx.MOUSE_BTN_LEFT`` for
+ the left mouse button, ``wx.MOUSE_BTN_MIDDLE`` for the middle one and
+ ``wx.MOUSE_BTN_RIGHT`` for the right one. Note that not all mice have
+ a middle button so a portable application should avoid relying on the
+ events from it.
+
+ Note the difference between methods like `LeftDown` and `LeftIsDown`:
+ the former returns true when the event corresponds to the left mouse
+ button click while the latter returns true if the left mouse button is
+ currently being pressed. For example, when the user is dragging the
+ mouse you can use `LeftIsDown` to test whether the left mouse button
+ is (still) depressed. Also, by convention, if `LeftDown` returns true,
+ `LeftIsDown` will also return true in wxWidgets whatever the
+ underlying GUI behaviour is (which is platform-dependent). The same
+ applies, of course, to other mouse buttons as well.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType mouseType=wxEVT_NULL) -> MouseEvent
+
+ Constructs a wx.MouseEvent. Valid event types are:
+
+ * wxEVT_ENTER_WINDOW
+ * wxEVT_LEAVE_WINDOW
+ * wxEVT_LEFT_DOWN
+ * wxEVT_LEFT_UP
+ * wxEVT_LEFT_DCLICK
+ * wxEVT_MIDDLE_DOWN
+ * wxEVT_MIDDLE_UP
+ * wxEVT_MIDDLE_DCLICK
+ * wxEVT_RIGHT_DOWN
+ * wxEVT_RIGHT_UP
+ * wxEVT_RIGHT_DCLICK
+ * wxEVT_MOTION
+ * wxEVT_MOUSEWHEEL
+ """
+ _core_.MouseEvent_swiginit(self,_core_.new_MouseEvent(*args, **kwargs))
def IsButton(*args, **kwargs):
- """IsButton(self) -> bool"""
+ """
+ IsButton(self) -> bool
+
+ Returns true if the event was a mouse button event (not necessarily a
+ button down event - that may be tested using `ButtonDown`).
+ """
return _core_.MouseEvent_IsButton(*args, **kwargs)
def ButtonDown(*args, **kwargs):
- """ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool"""
+ """
+ ButtonDown(self, int but=MOUSE_BTN_ANY) -> bool
+
+ If the argument is omitted, this returns true if the event was any
+ mouse button down event. Otherwise the argument specifies which
+ button-down event shold be checked for (see `Button` for the possible
+ values).
+ """
return _core_.MouseEvent_ButtonDown(*args, **kwargs)
def ButtonDClick(*args, **kwargs):
- """ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool"""
+ """
+ ButtonDClick(self, int but=MOUSE_BTN_ANY) -> bool
+
+ If the argument is omitted, this returns true if the event was any
+ mouse double click event. Otherwise the argument specifies which
+ double click event to check for (see `Button` for the possible
+ values).
+ """
return _core_.MouseEvent_ButtonDClick(*args, **kwargs)
def ButtonUp(*args, **kwargs):
- """ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool"""
+ """
+ ButtonUp(self, int but=MOUSE_BTN_ANY) -> bool
+
+ If the argument is omitted, this returns true if the event was any
+ mouse button up event. Otherwise the argument specifies which button
+ up event to check for (see `Button` for the possible values).
+ """
return _core_.MouseEvent_ButtonUp(*args, **kwargs)
def Button(*args, **kwargs):
- """Button(self, int but) -> bool"""
+ """
+ Button(self, int button) -> bool
+
+ Returns true if the identified mouse button is changing state. Valid
+ values of button are:
+
+ ==================== =====================================
+ wx.MOUSE_BTN_LEFT check if left button was pressed
+ wx.MOUSE_BTN_MIDDLE check if middle button was pressed
+ wx.MOUSE_BTN_RIGHT check if right button was pressed
+ wx.MOUSE_BTN_ANY check if any button was pressed
+ ==================== =====================================
+
+ """
return _core_.MouseEvent_Button(*args, **kwargs)
def ButtonIsDown(*args, **kwargs):
return _core_.MouseEvent_ButtonIsDown(*args, **kwargs)
def GetButton(*args, **kwargs):
- """GetButton(self) -> int"""
+ """
+ GetButton(self) -> int
+
+ Returns the mouse button which generated this event or
+ wx.MOUSE_BTN_NONE if no button is involved (for mouse move, enter or
+ leave event, for example). Otherwise wx.MOUSE_BTN_LEFT is returned for
+ the left button down, up and double click events, wx.MOUSE_BTN_MIDDLE
+ and wx.MOUSE_BTN_RIGHT for the same events for the middle and the
+ right buttons respectively.
+ """
return _core_.MouseEvent_GetButton(*args, **kwargs)
def ControlDown(*args, **kwargs):
- """ControlDown(self) -> bool"""
+ """
+ ControlDown(self) -> bool
+
+ Returns true if the control key was down at the time of the event.
+ """
return _core_.MouseEvent_ControlDown(*args, **kwargs)
def MetaDown(*args, **kwargs):
- """MetaDown(self) -> bool"""
+ """
+ MetaDown(self) -> bool
+
+ Returns true if the Meta key was down at the time of the event.
+ """
return _core_.MouseEvent_MetaDown(*args, **kwargs)
def AltDown(*args, **kwargs):
- """AltDown(self) -> bool"""
+ """
+ AltDown(self) -> bool
+
+ Returns true if the Alt key was down at the time of the event.
+ """
return _core_.MouseEvent_AltDown(*args, **kwargs)
def ShiftDown(*args, **kwargs):
- """ShiftDown(self) -> bool"""
+ """
+ ShiftDown(self) -> bool
+
+ Returns true if the Shift key was down at the time of the event.
+ """
return _core_.MouseEvent_ShiftDown(*args, **kwargs)
+ def CmdDown(*args, **kwargs):
+ """
+ CmdDown(self) -> bool
+
+ "Cmd" is a pseudo key which is the same as Control for PC and Unix
+ platforms but the special "Apple" (a.k.a as "Command") key on
+ Macs. It often makes sense to use it instead of, say, `ControlDown`
+ because Cmd key is used for the same thing under Mac as Ctrl
+ elsewhere. The Ctrl key still exists, it's just not used for this
+ purpose. So for non-Mac platforms this is the same as `ControlDown`
+ and Macs this is the same as `MetaDown`.
+ """
+ return _core_.MouseEvent_CmdDown(*args, **kwargs)
+
def LeftDown(*args, **kwargs):
- """LeftDown(self) -> bool"""
+ """
+ LeftDown(self) -> bool
+
+ Returns true if the left mouse button state changed to down.
+ """
return _core_.MouseEvent_LeftDown(*args, **kwargs)
def MiddleDown(*args, **kwargs):
- """MiddleDown(self) -> bool"""
+ """
+ MiddleDown(self) -> bool
+
+ Returns true if the middle mouse button state changed to down.
+ """
return _core_.MouseEvent_MiddleDown(*args, **kwargs)
def RightDown(*args, **kwargs):
- """RightDown(self) -> bool"""
+ """
+ RightDown(self) -> bool
+
+ Returns true if the right mouse button state changed to down.
+ """
return _core_.MouseEvent_RightDown(*args, **kwargs)
def LeftUp(*args, **kwargs):
- """LeftUp(self) -> bool"""
+ """
+ LeftUp(self) -> bool
+
+ Returns true if the left mouse button state changed to up.
+ """
return _core_.MouseEvent_LeftUp(*args, **kwargs)
def MiddleUp(*args, **kwargs):
- """MiddleUp(self) -> bool"""
+ """
+ MiddleUp(self) -> bool
+
+ Returns true if the middle mouse button state changed to up.
+ """
return _core_.MouseEvent_MiddleUp(*args, **kwargs)
def RightUp(*args, **kwargs):
- """RightUp(self) -> bool"""
+ """
+ RightUp(self) -> bool
+
+ Returns true if the right mouse button state changed to up.
+ """
return _core_.MouseEvent_RightUp(*args, **kwargs)
def LeftDClick(*args, **kwargs):
- """LeftDClick(self) -> bool"""
+ """
+ LeftDClick(self) -> bool
+
+ Returns true if the event was a left button double click.
+ """
return _core_.MouseEvent_LeftDClick(*args, **kwargs)
def MiddleDClick(*args, **kwargs):
- """MiddleDClick(self) -> bool"""
+ """
+ MiddleDClick(self) -> bool
+
+ Returns true if the event was a middle button double click.
+ """
return _core_.MouseEvent_MiddleDClick(*args, **kwargs)
def RightDClick(*args, **kwargs):
- """RightDClick(self) -> bool"""
+ """
+ RightDClick(self) -> bool
+
+ Returns true if the event was a right button double click.
+ """
return _core_.MouseEvent_RightDClick(*args, **kwargs)
def LeftIsDown(*args, **kwargs):
- """LeftIsDown(self) -> bool"""
+ """
+ LeftIsDown(self) -> bool
+
+ Returns true if the left mouse button is currently down, independent
+ of the current event type.
+
+ Please notice that it is not the same as LeftDown which returns true
+ if the left mouse button was just pressed. Rather, it describes the
+ state of the mouse button before the event happened.
+
+ This event is usually used in the mouse event handlers which process
+ "move mouse" messages to determine whether the user is (still)
+ dragging the mouse.
+ """
return _core_.MouseEvent_LeftIsDown(*args, **kwargs)
def MiddleIsDown(*args, **kwargs):
- """MiddleIsDown(self) -> bool"""
+ """
+ MiddleIsDown(self) -> bool
+
+ Returns true if the middle mouse button is currently down, independent
+ of the current event type.
+ """
return _core_.MouseEvent_MiddleIsDown(*args, **kwargs)
def RightIsDown(*args, **kwargs):
- """RightIsDown(self) -> bool"""
+ """
+ RightIsDown(self) -> bool
+
+ Returns true if the right mouse button is currently down, independent
+ of the current event type.
+ """
return _core_.MouseEvent_RightIsDown(*args, **kwargs)
def Dragging(*args, **kwargs):
- """Dragging(self) -> bool"""
+ """
+ Dragging(self) -> bool
+
+ Returns true if this was a dragging event (motion while a button is
+ depressed).
+ """
return _core_.MouseEvent_Dragging(*args, **kwargs)
def Moving(*args, **kwargs):
- """Moving(self) -> bool"""
+ """
+ Moving(self) -> bool
+
+ Returns true if this was a motion event and no mouse buttons were
+ pressed. If any mouse button is held pressed, then this method returns
+ false and Dragging returns true.
+ """
return _core_.MouseEvent_Moving(*args, **kwargs)
def Entering(*args, **kwargs):
- """Entering(self) -> bool"""
+ """
+ Entering(self) -> bool
+
+ Returns true if the mouse was entering the window.
+ """
return _core_.MouseEvent_Entering(*args, **kwargs)
def Leaving(*args, **kwargs):
- """Leaving(self) -> bool"""
+ """
+ Leaving(self) -> bool
+
+ Returns true if the mouse was leaving the window.
+ """
return _core_.MouseEvent_Leaving(*args, **kwargs)
def GetPosition(*args, **kwargs):
"""
GetPosition(self) -> Point
- Returns the position of the mouse in window coordinates when the event
- happened.
+ Returns the pixel position of the mouse in window coordinates when the
+ event happened.
"""
return _core_.MouseEvent_GetPosition(*args, **kwargs)
"""
GetPositionTuple() -> (x,y)
- Returns the position of the mouse in window coordinates when the event
- happened.
+ Returns the pixel position of the mouse in window coordinates when the
+ event happened.
"""
return _core_.MouseEvent_GetPositionTuple(*args, **kwargs)
def GetLogicalPosition(*args, **kwargs):
- """GetLogicalPosition(self, DC dc) -> Point"""
+ """
+ GetLogicalPosition(self, DC dc) -> Point
+
+ Returns the logical mouse position in pixels (i.e. translated
+ according to the translation set for the DC, which usually indicates
+ that the window has been scrolled).
+ """
return _core_.MouseEvent_GetLogicalPosition(*args, **kwargs)
def GetX(*args, **kwargs):
- """GetX(self) -> int"""
+ """
+ GetX(self) -> int
+
+ Returns X coordinate of the physical mouse event position.
+ """
return _core_.MouseEvent_GetX(*args, **kwargs)
def GetY(*args, **kwargs):
- """GetY(self) -> int"""
+ """
+ GetY(self) -> int
+
+ Returns Y coordinate of the physical mouse event position.
+ """
return _core_.MouseEvent_GetY(*args, **kwargs)
def GetWheelRotation(*args, **kwargs):
- """GetWheelRotation(self) -> int"""
+ """
+ GetWheelRotation(self) -> int
+
+ Get wheel rotation, positive or negative indicates direction of
+ rotation. Current devices all send an event when rotation is equal to
+ +/-WheelDelta, but this allows for finer resolution devices to be
+ created in the future. Because of this you shouldn't assume that one
+ event is equal to 1 line or whatever, but you should be able to either
+ do partial line scrolling or wait until +/-WheelDelta rotation values
+ have been accumulated before scrolling.
+ """
return _core_.MouseEvent_GetWheelRotation(*args, **kwargs)
def GetWheelDelta(*args, **kwargs):
- """GetWheelDelta(self) -> int"""
+ """
+ GetWheelDelta(self) -> int
+
+ Get wheel delta, normally 120. This is the threshold for action to be
+ taken, and one such action (for example, scrolling one increment)
+ should occur for each delta.
+ """
return _core_.MouseEvent_GetWheelDelta(*args, **kwargs)
def GetLinesPerAction(*args, **kwargs):
- """GetLinesPerAction(self) -> int"""
+ """
+ GetLinesPerAction(self) -> int
+
+ Returns the configured number of lines (or whatever) to be scrolled
+ per wheel action. Defaults to three.
+ """
return _core_.MouseEvent_GetLinesPerAction(*args, **kwargs)
def IsPageScroll(*args, **kwargs):
- """IsPageScroll(self) -> bool"""
+ """
+ IsPageScroll(self) -> bool
+
+ Returns true if the system has been setup to do page scrolling with
+ the mouse wheel instead of line scrolling.
+ """
return _core_.MouseEvent_IsPageScroll(*args, **kwargs)
m_x = property(_core_.MouseEvent_m_x_get, _core_.MouseEvent_m_x_set)
m_wheelRotation = property(_core_.MouseEvent_m_wheelRotation_get, _core_.MouseEvent_m_wheelRotation_set)
m_wheelDelta = property(_core_.MouseEvent_m_wheelDelta_get, _core_.MouseEvent_m_wheelDelta_set)
m_linesPerAction = property(_core_.MouseEvent_m_linesPerAction_get, _core_.MouseEvent_m_linesPerAction_set)
-
-class MouseEventPtr(MouseEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MouseEvent
-_core_.MouseEvent_swigregister(MouseEventPtr)
+MouseEvent_swigregister = _core_.MouseEvent_swigregister
+MouseEvent_swigregister(MouseEvent)
#---------------------------------------------------------------------------
class SetCursorEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxSetCursorEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int x=0, int y=0) -> SetCursorEvent"""
- newobj = _core_.new_SetCursorEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ A SetCursorEvent is generated when the mouse cursor is about to be set
+ as a result of mouse motion. This event gives the application the
+ chance to perform specific mouse cursor processing based on the
+ current position of the mouse within the window. Use the `SetCursor`
+ method to specify the cursor you want to be displayed.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int x=0, int y=0) -> SetCursorEvent
+
+ Construct a new `wx.SetCursorEvent`.
+ """
+ _core_.SetCursorEvent_swiginit(self,_core_.new_SetCursorEvent(*args, **kwargs))
def GetX(*args, **kwargs):
- """GetX(self) -> int"""
+ """
+ GetX(self) -> int
+
+ Returns the X coordinate of the mouse in client coordinates.
+ """
return _core_.SetCursorEvent_GetX(*args, **kwargs)
def GetY(*args, **kwargs):
- """GetY(self) -> int"""
+ """
+ GetY(self) -> int
+
+ Returns the Y coordinate of the mouse in client coordinates.
+ """
return _core_.SetCursorEvent_GetY(*args, **kwargs)
def SetCursor(*args, **kwargs):
- """SetCursor(self, Cursor cursor)"""
+ """
+ SetCursor(self, Cursor cursor)
+
+ Sets the cursor associated with this event.
+ """
return _core_.SetCursorEvent_SetCursor(*args, **kwargs)
def GetCursor(*args, **kwargs):
- """GetCursor(self) -> Cursor"""
+ """
+ GetCursor(self) -> Cursor
+
+ Returns a reference to the cursor specified by this event.
+ """
return _core_.SetCursorEvent_GetCursor(*args, **kwargs)
def HasCursor(*args, **kwargs):
- """HasCursor(self) -> bool"""
- return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
+ """
+ HasCursor(self) -> bool
+ Returns true if the cursor specified by this event is a valid cursor.
+ """
+ return _core_.SetCursorEvent_HasCursor(*args, **kwargs)
-class SetCursorEventPtr(SetCursorEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = SetCursorEvent
-_core_.SetCursorEvent_swigregister(SetCursorEventPtr)
+SetCursorEvent_swigregister = _core_.SetCursorEvent_swigregister
+SetCursorEvent_swigregister(SetCursorEvent)
#---------------------------------------------------------------------------
class KeyEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType keyType=wxEVT_NULL) -> KeyEvent"""
- newobj = _core_.new_KeyEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This event class contains information about keypress and character
+ events. These events are only sent to the widget that currently has
+ the keyboard focus.
+
+ Notice that there are three different kinds of keyboard events in
+ wxWidgets: key down and up events and char events. The difference
+ between the first two is clear - the first corresponds to a key press
+ and the second to a key release - otherwise they are identical. Just
+ note that if the key is maintained in a pressed state you will
+ typically get a lot of (automatically generated) down events but only
+ one up so it is wrong to assume that there is one up event
+ corresponding to each down one.
+
+ Both key events provide untranslated key codes while the char event
+ carries the translated one. The untranslated code for alphanumeric
+ keys is always an upper case value. For the other keys it is one of
+ WXK_XXX values from the keycodes table. The translated key is, in
+ general, the character the user expects to appear as the result of the
+ key combination when typing the text into a text entry zone, for
+ example.
+
+ A few examples to clarify this (all assume that CAPS LOCK is unpressed
+ and the standard US keyboard): when the 'A' key is pressed, the key
+ down event key code is equal to ASCII A == 65. But the char event key
+ code is ASCII a == 97. On the other hand, if you press both SHIFT and
+ 'A' keys simultaneously , the key code in key down event will still be
+ just 'A' while the char event key code parameter will now be 'A' as
+ well.
+
+ Although in this simple case it is clear that the correct key code
+ could be found in the key down event handler by checking the value
+ returned by `ShiftDown`, in general you should use EVT_CHAR for this
+ as for non alphanumeric keys or non-US keyboard layouts the
+ translation is keyboard-layout dependent and can only be done properly
+ by the system itself.
+
+ Another kind of translation is done when the control key is pressed:
+ for example, for CTRL-A key press the key down event still carries the
+ same key code 'A' as usual but the char event will have key code of 1,
+ the ASCII value of this key combination.
+
+ You may discover how the other keys on your system behave
+ interactively by running the KeyEvents sample in the wxPython demo and
+ pressing some keys while the blue box at the top has the keyboard
+ focus.
+
+ **Note**: If a key down event is caught and the event handler does not
+ call event.Skip() then the coresponding char event will not
+ happen. This is by design and enables the programs that handle both
+ types of events to be a bit simpler.
+
+ **Note for Windows programmers**: The key and char events in wxWidgets
+ are similar to but slightly different from Windows WM_KEYDOWN and
+ WM_CHAR events. In particular, Alt-x combination will generate a char
+ event in wxWidgets (unless it is used as an accelerator).
+
+ **Tip**: be sure to call event.Skip() for events that you don't
+ process in key event function, otherwise menu shortcuts may cease to
+ work under Windows.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType eventType=wxEVT_NULL) -> KeyEvent
+
+ Construct a new `wx.KeyEvent`. Valid event types are:
+ *
+ """
+ _core_.KeyEvent_swiginit(self,_core_.new_KeyEvent(*args, **kwargs))
+ def GetModifiers(*args, **kwargs):
+ """
+ GetModifiers(self) -> int
+
+ Returns a bitmask of the current modifier settings. Can be used to
+ check if the key event has exactly the given modifiers without having
+ to explicitly check that the other modifiers are not down. For
+ example::
+
+ if event.GetModifers() == wx.MOD_CONTROL:
+ DoSomething()
+
+ """
+ return _core_.KeyEvent_GetModifiers(*args, **kwargs)
+
def ControlDown(*args, **kwargs):
- """ControlDown(self) -> bool"""
+ """
+ ControlDown(self) -> bool
+
+ Returns ``True`` if the Control key was down at the time of the event.
+ """
return _core_.KeyEvent_ControlDown(*args, **kwargs)
def MetaDown(*args, **kwargs):
- """MetaDown(self) -> bool"""
+ """
+ MetaDown(self) -> bool
+
+ Returns ``True`` if the Meta key was down at the time of the event.
+ """
return _core_.KeyEvent_MetaDown(*args, **kwargs)
def AltDown(*args, **kwargs):
- """AltDown(self) -> bool"""
+ """
+ AltDown(self) -> bool
+
+ Returns ``True`` if the Alt key was down at the time of the event.
+ """
return _core_.KeyEvent_AltDown(*args, **kwargs)
def ShiftDown(*args, **kwargs):
- """ShiftDown(self) -> bool"""
+ """
+ ShiftDown(self) -> bool
+
+ Returns ``True`` if the Shift key was down at the time of the event.
+ """
return _core_.KeyEvent_ShiftDown(*args, **kwargs)
+ def CmdDown(*args, **kwargs):
+ """
+ CmdDown(self) -> bool
+
+ "Cmd" is a pseudo key which is the same as Control for PC and Unix
+ platforms but the special "Apple" (a.k.a as "Command") key on
+ Macs. It makes often sense to use it instead of, say, `ControlDown`
+ because Cmd key is used for the same thing under Mac as Ctrl
+ elsewhere. The Ctrl still exists, it's just not used for this
+ purpose. So for non-Mac platforms this is the same as `ControlDown`
+ and Macs this is the same as `MetaDown`.
+ """
+ return _core_.KeyEvent_CmdDown(*args, **kwargs)
+
def HasModifiers(*args, **kwargs):
- """HasModifiers(self) -> bool"""
+ """
+ HasModifiers(self) -> bool
+
+ Returns true if either CTRL or ALT keys was down at the time of the
+ key event. Note that this function does not take into account neither
+ SHIFT nor META key states (the reason for ignoring the latter is that
+ it is common for NUMLOCK key to be configured as META under X but the
+ key presses even while NUMLOCK is on should be still processed
+ normally).
+ """
return _core_.KeyEvent_HasModifiers(*args, **kwargs)
def GetKeyCode(*args, **kwargs):
- """GetKeyCode(self) -> int"""
+ """
+ GetKeyCode(self) -> int
+
+ Returns the virtual key code. ASCII events return normal ASCII values,
+ while non-ASCII events return values such as WXK_LEFT for the left
+ cursor key. See `wx.KeyEvent` for a full list of the virtual key
+ codes.
+
+ Note that in Unicode build, the returned value is meaningful only if
+ the user entered a character that can be represented in current
+ locale's default charset. You can obtain the corresponding Unicode
+ character using `GetUnicodeKey`.
+ """
return _core_.KeyEvent_GetKeyCode(*args, **kwargs)
KeyCode = GetKeyCode
- def GetUniChar(*args, **kwargs):
- """GetUniChar(self) -> int"""
- return _core_.KeyEvent_GetUniChar(*args, **kwargs)
+ def GetUnicodeKey(*args, **kwargs):
+ """
+ GetUnicodeKey(self) -> int
+ Returns the Unicode character corresponding to this key event. This
+ function is only meaningfule in a Unicode build of wxPython.
+ """
+ return _core_.KeyEvent_GetUnicodeKey(*args, **kwargs)
+
+ GetUniChar = GetUnicodeKey
def GetRawKeyCode(*args, **kwargs):
- """GetRawKeyCode(self) -> unsigned int"""
+ """
+ GetRawKeyCode(self) -> unsigned int
+
+ Returns the raw key code for this event. This is a platform-dependent
+ scan code which should only be used in advanced
+ applications. Currently the raw key codes are not supported by all
+ ports.
+ """
return _core_.KeyEvent_GetRawKeyCode(*args, **kwargs)
def GetRawKeyFlags(*args, **kwargs):
- """GetRawKeyFlags(self) -> unsigned int"""
+ """
+ GetRawKeyFlags(self) -> unsigned int
+
+ Returns the low level key flags for this event. The flags are
+ platform-dependent and should only be used in advanced applications.
+ Currently the raw key flags are not supported by all ports.
+ """
return _core_.KeyEvent_GetRawKeyFlags(*args, **kwargs)
def GetPosition(*args, **kwargs):
"""
GetPosition(self) -> Point
- Find the position of the event.
+ Find the position of the event, if applicable.
"""
return _core_.KeyEvent_GetPosition(*args, **kwargs)
"""
GetPositionTuple() -> (x,y)
- Find the position of the event.
+ Find the position of the event, if applicable.
"""
return _core_.KeyEvent_GetPositionTuple(*args, **kwargs)
def GetX(*args, **kwargs):
- """GetX(self) -> int"""
+ """
+ GetX(self) -> int
+
+ Returns the X position (in client coordinates) of the event, if
+ applicable.
+ """
return _core_.KeyEvent_GetX(*args, **kwargs)
def GetY(*args, **kwargs):
- """GetY(self) -> int"""
+ """
+ GetY(self) -> int
+
+ Returns the Y position (in client coordinates) of the event, if
+ applicable.
+ """
return _core_.KeyEvent_GetY(*args, **kwargs)
m_x = property(_core_.KeyEvent_m_x_get, _core_.KeyEvent_m_x_set)
m_scanCode = property(_core_.KeyEvent_m_scanCode_get, _core_.KeyEvent_m_scanCode_set)
m_rawCode = property(_core_.KeyEvent_m_rawCode_get, _core_.KeyEvent_m_rawCode_set)
m_rawFlags = property(_core_.KeyEvent_m_rawFlags_get, _core_.KeyEvent_m_rawFlags_set)
-
-class KeyEventPtr(KeyEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = KeyEvent
-_core_.KeyEvent_swigregister(KeyEventPtr)
+KeyEvent_swigregister = _core_.KeyEvent_swigregister
+KeyEvent_swigregister(KeyEvent)
#---------------------------------------------------------------------------
class SizeEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxSizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent"""
- newobj = _core_.new_SizeEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ A size event holds information about size change events. The EVT_SIZE
+ handler function will be called when the window it is bound to has
+ been resized.
+
+ Note that the size passed is of the whole window: call
+ `wx.Window.GetClientSize` for the area which may be used by the
+ application.
+
+ When a window is resized, usually only a small part of the window is
+ damaged and and that area is all that is in the update region for the
+ next paint event. However, if your drawing depends on the size of the
+ window, you may need to clear the DC explicitly and repaint the whole
+ window. In which case, you may need to call `wx.Window.Refresh` to
+ invalidate the entire window.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Size sz=DefaultSize, int winid=0) -> SizeEvent
+
+ Construct a new ``wx.SizeEvent``.
+ """
+ _core_.SizeEvent_swiginit(self,_core_.new_SizeEvent(*args, **kwargs))
def GetSize(*args, **kwargs):
- """GetSize(self) -> Size"""
+ """
+ GetSize(self) -> Size
+
+ Returns the entire size of the window generating the size change
+ event.
+ """
return _core_.SizeEvent_GetSize(*args, **kwargs)
def GetRect(*args, **kwargs):
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)
-
-class SizeEventPtr(SizeEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = SizeEvent
-_core_.SizeEvent_swigregister(SizeEventPtr)
+SizeEvent_swigregister = _core_.SizeEvent_swigregister
+SizeEvent_swigregister(SizeEvent)
#---------------------------------------------------------------------------
class MoveEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMoveEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent"""
- newobj = _core_.new_MoveEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This event object is sent for EVT_MOVE event bindings when a window is
+ moved to a new position.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Point pos=DefaultPosition, int winid=0) -> MoveEvent
+
+ Constructor.
+ """
+ _core_.MoveEvent_swiginit(self,_core_.new_MoveEvent(*args, **kwargs))
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the position of the window generating the move change event.
+ """
return _core_.MoveEvent_GetPosition(*args, **kwargs)
def GetRect(*args, **kwargs):
"""SetPosition(self, Point pos)"""
return _core_.MoveEvent_SetPosition(*args, **kwargs)
- m_pos = property(_core_.MoveEvent_m_pos_get, _core_.MoveEvent_m_pos_set)
- m_rect = property(_core_.MoveEvent_m_rect_get, _core_.MoveEvent_m_rect_set)
+ m_pos = property(GetPosition, SetPosition)
+ m_rect = property(GetRect, SetRect)
-class MoveEventPtr(MoveEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MoveEvent
-_core_.MoveEvent_swigregister(MoveEventPtr)
+MoveEvent_swigregister = _core_.MoveEvent_swigregister
+MoveEvent_swigregister(MoveEvent)
#---------------------------------------------------------------------------
class PaintEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """
+ A paint event is sent when a window's contents needs to be repainted.
+ Note that in an EVT_PAINT handler the application must *always* create
+ a `wx.PaintDC` object, even if you do not use it. Otherwise MS
+ Windows assumes that the window has not been painted yet and will send
+ the event again, causing endless refreshes.
+
+ You can optimize painting by retrieving the rectangles that have been
+ damaged using `wx.Window.GetUpdateRegion` and/or `wx.RegionIterator`,
+ and only repainting these rectangles. The rectangles are in terms of
+ the client area, and are unscrolled, so you will need to do some
+ calculations using the current view position to obtain logical,
+ scrolled units.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self, int Id=0) -> PaintEvent"""
- newobj = _core_.new_PaintEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class PaintEventPtr(PaintEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PaintEvent
-_core_.PaintEvent_swigregister(PaintEventPtr)
+ _core_.PaintEvent_swiginit(self,_core_.new_PaintEvent(*args, **kwargs))
+PaintEvent_swigregister = _core_.PaintEvent_swigregister
+PaintEvent_swigregister(PaintEvent)
class NcPaintEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxNcPaintEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ NcPaintEvent class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self, int winid=0) -> NcPaintEvent"""
- newobj = _core_.new_NcPaintEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class NcPaintEventPtr(NcPaintEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = NcPaintEvent
-_core_.NcPaintEvent_swigregister(NcPaintEventPtr)
+ _core_.NcPaintEvent_swiginit(self,_core_.new_NcPaintEvent(*args, **kwargs))
+NcPaintEvent_swigregister = _core_.NcPaintEvent_swigregister
+NcPaintEvent_swigregister(NcPaintEvent)
#---------------------------------------------------------------------------
class EraseEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxEraseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int Id=0, DC dc=(wxDC *) NULL) -> EraseEvent"""
- newobj = _core_.new_EraseEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An erase event is sent whenever the background of a window needs to be
+ repainted. To intercept this event use the EVT_ERASE_BACKGROUND event
+ binder. On some platforms, such as GTK+, this event is simulated
+ (simply generated just before the paint event) and may cause flicker.
+
+ To paint a custom background use the `GetDC` method and use the returned
+ device context if it is not ``None``, otherwise create a temporary
+ `wx.ClientDC` and draw on that.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int Id=0, DC dc=None) -> EraseEvent
+
+ Constructor
+ """
+ _core_.EraseEvent_swiginit(self,_core_.new_EraseEvent(*args, **kwargs))
def GetDC(*args, **kwargs):
- """GetDC(self) -> DC"""
- return _core_.EraseEvent_GetDC(*args, **kwargs)
+ """
+ GetDC(self) -> DC
+ Returns the device context the event handler should draw upon. If
+ ``None`` is returned then create a temporary `wx.ClientDC` and use
+ that instead.
+ """
+ return _core_.EraseEvent_GetDC(*args, **kwargs)
-class EraseEventPtr(EraseEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = EraseEvent
-_core_.EraseEvent_swigregister(EraseEventPtr)
+EraseEvent_swigregister = _core_.EraseEvent_swigregister
+EraseEvent_swigregister(EraseEvent)
#---------------------------------------------------------------------------
class FocusEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent"""
- newobj = _core_.new_FocusEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ A focus event is sent when a window's focus changes. The window losing
+ focus receives an EVT_KILL_FOCUS event while the window gaining it
+ gets an EVT_SET_FOCUS event.
+
+ Notice that the set focus event happens both when the user gives focus
+ to the window (whether using the mouse or keyboard) and when it is
+ done from the program itself using `wx.Window.SetFocus`.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> FocusEvent
+
+ Constructor
+ """
+ _core_.FocusEvent_swiginit(self,_core_.new_FocusEvent(*args, **kwargs))
def GetWindow(*args, **kwargs):
- """GetWindow(self) -> Window"""
+ """
+ GetWindow(self) -> Window
+
+ Returns the other window associated with this event, that is the
+ window which had the focus before for the EVT_SET_FOCUS event and the
+ window which is going to receive focus for the wxEVT_KILL_FOCUS event.
+
+ Warning: the window returned may be None!
+ """
return _core_.FocusEvent_GetWindow(*args, **kwargs)
def SetWindow(*args, **kwargs):
"""SetWindow(self, Window win)"""
return _core_.FocusEvent_SetWindow(*args, **kwargs)
-
-class FocusEventPtr(FocusEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = FocusEvent
-_core_.FocusEvent_swigregister(FocusEventPtr)
+FocusEvent_swigregister = _core_.FocusEvent_swigregister
+FocusEvent_swigregister(FocusEvent)
#---------------------------------------------------------------------------
class ChildFocusEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxChildFocusEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Window win=None) -> ChildFocusEvent"""
- newobj = _core_.new_ChildFocusEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ wx.ChildFocusEvent notifies the parent that a child has received the
+ focus. Unlike `wx.FocusEvent` it is propagated up the window
+ heirarchy.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Window win=None) -> ChildFocusEvent
+
+ Constructor
+ """
+ _core_.ChildFocusEvent_swiginit(self,_core_.new_ChildFocusEvent(*args, **kwargs))
def GetWindow(*args, **kwargs):
- """GetWindow(self) -> Window"""
- return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
+ """
+ GetWindow(self) -> Window
+ The window which has just received the focus.
+ """
+ return _core_.ChildFocusEvent_GetWindow(*args, **kwargs)
-class ChildFocusEventPtr(ChildFocusEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ChildFocusEvent
-_core_.ChildFocusEvent_swigregister(ChildFocusEventPtr)
+ChildFocusEvent_swigregister = _core_.ChildFocusEvent_swigregister
+ChildFocusEvent_swigregister(ChildFocusEvent)
#---------------------------------------------------------------------------
class ActivateEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxActivateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent"""
- newobj = _core_.new_ActivateEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An activate event is sent when a top-level window or the entire
+ application is being activated or deactivated.
+
+ A top-level window (a dialog or frame) receives an activate event when
+ is being activated or deactivated. This is indicated visually by the
+ title bar changing colour, and a subwindow gaining the keyboard focus.
+ An application is activated or deactivated when one of its frames
+ becomes activated, or a frame becomes inactivate resulting in all
+ application frames being inactive.
+
+ Please note that usually you should call event.Skip() in your handlers
+ for these events so the default handlers will still be called, as not
+ doing so can result in strange effects.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType type=wxEVT_NULL, bool active=True, int Id=0) -> ActivateEvent
+
+ Constructor
+ """
+ _core_.ActivateEvent_swiginit(self,_core_.new_ActivateEvent(*args, **kwargs))
def GetActive(*args, **kwargs):
- """GetActive(self) -> bool"""
- return _core_.ActivateEvent_GetActive(*args, **kwargs)
+ """
+ GetActive(self) -> bool
+ Returns true if the application or window is being activated, false
+ otherwise.
+ """
+ return _core_.ActivateEvent_GetActive(*args, **kwargs)
-class ActivateEventPtr(ActivateEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ActivateEvent
-_core_.ActivateEvent_swigregister(ActivateEventPtr)
+ActivateEvent_swigregister = _core_.ActivateEvent_swigregister
+ActivateEvent_swigregister(ActivateEvent)
#---------------------------------------------------------------------------
class InitDialogEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxInitDialogEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int Id=0) -> InitDialogEvent"""
- newobj = _core_.new_InitDialogEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class InitDialogEventPtr(InitDialogEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = InitDialogEvent
-_core_.InitDialogEvent_swigregister(InitDialogEventPtr)
+ """
+ A wx.InitDialogEvent is sent as a dialog is being initialised, or for
+ any window when `wx.Window.InitDialog` is called. Handlers for this
+ event can transfer data to the window, or anything else that should be
+ done before the user begins editing the form. The default handler
+ calls `wx.Window.TransferDataToWindow`.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int Id=0) -> InitDialogEvent
+
+ Constructor
+ """
+ _core_.InitDialogEvent_swiginit(self,_core_.new_InitDialogEvent(*args, **kwargs))
+InitDialogEvent_swigregister = _core_.InitDialogEvent_swigregister
+InitDialogEvent_swigregister(InitDialogEvent)
#---------------------------------------------------------------------------
class MenuEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent"""
- newobj = _core_.new_MenuEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This class is used for a variety of menu-related events. Note that
+ these do not include menu command events, which are handled by sending
+ `wx.CommandEvent` objects.
+
+ The default handler for wx.EVT_MENU_HIGHLIGHT displays menu item help
+ text in the first field of the status bar.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Menu menu=None) -> MenuEvent
+
+ Constructor
+ """
+ _core_.MenuEvent_swiginit(self,_core_.new_MenuEvent(*args, **kwargs))
def GetMenuId(*args, **kwargs):
- """GetMenuId(self) -> int"""
+ """
+ GetMenuId(self) -> int
+
+ Returns the menu identifier associated with the event. This method
+ should be only used with the HIGHLIGHT events.
+ """
return _core_.MenuEvent_GetMenuId(*args, **kwargs)
def IsPopup(*args, **kwargs):
- """IsPopup(self) -> bool"""
+ """
+ IsPopup(self) -> bool
+
+ Returns ``True`` if the menu which is being opened or closed is a
+ popup menu, ``False`` if it is a normal one. This method should only
+ be used with the OPEN and CLOSE events.
+ """
return _core_.MenuEvent_IsPopup(*args, **kwargs)
def GetMenu(*args, **kwargs):
- """GetMenu(self) -> Menu"""
- return _core_.MenuEvent_GetMenu(*args, **kwargs)
+ """
+ GetMenu(self) -> Menu
+ Returns the menu which is being opened or closed. This method should
+ only be used with the OPEN and CLOSE events.
+ """
+ return _core_.MenuEvent_GetMenu(*args, **kwargs)
-class MenuEventPtr(MenuEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MenuEvent
-_core_.MenuEvent_swigregister(MenuEventPtr)
+MenuEvent_swigregister = _core_.MenuEvent_swigregister
+MenuEvent_swigregister(MenuEvent)
#---------------------------------------------------------------------------
class CloseEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxCloseEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent"""
- newobj = _core_.new_CloseEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This event class contains information about window and session close
+ events.
+
+ The handler function for EVT_CLOSE is called when the user has tried
+ to close a a frame or dialog box using the window manager controls or
+ the system menu. It can also be invoked by the application itself
+ programmatically, for example by calling the `wx.Window.Close`
+ function.
+
+ You should check whether the application is forcing the deletion of
+ the window using `CanVeto`. If it returns ``False``, you must destroy
+ the window using `wx.Window.Destroy`. If the return value is ``True``,
+ it is up to you whether you respond by destroying the window or not.
+ For example you may wish to display a message dialog prompting to save
+ files or to cancel the close.
+
+ If you don't destroy the window, you should call `Veto` to let the
+ calling code know that you did not destroy the window. This allows the
+ `wx.Window.Close` function to return ``True`` or ``False`` depending
+ on whether the close instruction was honored or not.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType type=wxEVT_NULL, int winid=0) -> CloseEvent
+
+ Constructor.
+ """
+ _core_.CloseEvent_swiginit(self,_core_.new_CloseEvent(*args, **kwargs))
def SetLoggingOff(*args, **kwargs):
- """SetLoggingOff(self, bool logOff)"""
+ """
+ SetLoggingOff(self, bool logOff)
+
+ Sets the 'logging off' flag.
+ """
return _core_.CloseEvent_SetLoggingOff(*args, **kwargs)
def GetLoggingOff(*args, **kwargs):
- """GetLoggingOff(self) -> bool"""
+ """
+ GetLoggingOff(self) -> bool
+
+ Returns ``True`` if the user is logging off or ``False`` if the
+ system is shutting down. This method can only be called for end
+ session and query end session events, it doesn't make sense for close
+ window event.
+ """
return _core_.CloseEvent_GetLoggingOff(*args, **kwargs)
def Veto(*args, **kwargs):
- """Veto(self, bool veto=True)"""
- return _core_.CloseEvent_Veto(*args, **kwargs)
+ """
+ Veto(self, bool veto=True)
- def SetCanVeto(*args, **kwargs):
- """SetCanVeto(self, bool canVeto)"""
- return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
+ Call this from your event handler to veto a system shutdown or to
+ signal to the calling application that a window close did not happen.
- def CanVeto(*args, **kwargs):
- """CanVeto(self) -> bool"""
- return _core_.CloseEvent_CanVeto(*args, **kwargs)
+ You can only veto a shutdown or close if `CanVeto` returns true.
+ """
+ return _core_.CloseEvent_Veto(*args, **kwargs)
def GetVeto(*args, **kwargs):
"""GetVeto(self) -> bool"""
return _core_.CloseEvent_GetVeto(*args, **kwargs)
+ def SetCanVeto(*args, **kwargs):
+ """
+ SetCanVeto(self, bool canVeto)
+
+ Sets the 'can veto' flag.
+ """
+ return _core_.CloseEvent_SetCanVeto(*args, **kwargs)
+
+ def CanVeto(*args, **kwargs):
+ """
+ CanVeto(self) -> bool
+
+ Returns true if you can veto a system shutdown or a window close
+ event. Vetoing a window close event is not possible if the calling
+ code wishes to force the application to exit, and so this function
+ must be called to check this.
+ """
+ return _core_.CloseEvent_CanVeto(*args, **kwargs)
-class CloseEventPtr(CloseEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = CloseEvent
-_core_.CloseEvent_swigregister(CloseEventPtr)
+CloseEvent_swigregister = _core_.CloseEvent_swigregister
+CloseEvent_swigregister(CloseEvent)
#---------------------------------------------------------------------------
class ShowEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxShowEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int winid=0, bool show=False) -> ShowEvent"""
- newobj = _core_.new_ShowEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """An EVT_SHOW event is sent when a window is shown or hidden."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int winid=0, bool show=False) -> ShowEvent
+
+ An EVT_SHOW event is sent when a window is shown or hidden.
+ """
+ _core_.ShowEvent_swiginit(self,_core_.new_ShowEvent(*args, **kwargs))
def SetShow(*args, **kwargs):
"""SetShow(self, bool show)"""
return _core_.ShowEvent_SetShow(*args, **kwargs)
"""GetShow(self) -> bool"""
return _core_.ShowEvent_GetShow(*args, **kwargs)
-
-class ShowEventPtr(ShowEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ShowEvent
-_core_.ShowEvent_swigregister(ShowEventPtr)
+ShowEvent_swigregister = _core_.ShowEvent_swigregister
+ShowEvent_swigregister(ShowEvent)
#---------------------------------------------------------------------------
class IconizeEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxIconizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int id=0, bool iconized=True) -> IconizeEvent"""
- newobj = _core_.new_IconizeEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
+ restored.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int id=0, bool iconized=True) -> IconizeEvent
+
+ An EVT_ICONIZE event is sent when a frame is iconized (minimized) or
+ restored.
+ """
+ _core_.IconizeEvent_swiginit(self,_core_.new_IconizeEvent(*args, **kwargs))
def Iconized(*args, **kwargs):
- """Iconized(self) -> bool"""
- return _core_.IconizeEvent_Iconized(*args, **kwargs)
+ """
+ Iconized(self) -> bool
+ Returns ``True`` if the frame has been iconized, ``False`` if it has
+ been restored.
+ """
+ return _core_.IconizeEvent_Iconized(*args, **kwargs)
-class IconizeEventPtr(IconizeEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = IconizeEvent
-_core_.IconizeEvent_swigregister(IconizeEventPtr)
+IconizeEvent_swigregister = _core_.IconizeEvent_swigregister
+IconizeEvent_swigregister(IconizeEvent)
#---------------------------------------------------------------------------
class MaximizeEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMaximizeEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int id=0) -> MaximizeEvent"""
- newobj = _core_.new_MaximizeEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class MaximizeEventPtr(MaximizeEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MaximizeEvent
-_core_.MaximizeEvent_swigregister(MaximizeEventPtr)
+ """An EVT_MAXIMIZE event is sent when a frame is maximized or restored."""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int id=0) -> MaximizeEvent
+
+ An EVT_MAXIMIZE event is sent when a frame is maximized or restored.
+ """
+ _core_.MaximizeEvent_swiginit(self,_core_.new_MaximizeEvent(*args, **kwargs))
+MaximizeEvent_swigregister = _core_.MaximizeEvent_swigregister
+MaximizeEvent_swigregister(MaximizeEvent)
#---------------------------------------------------------------------------
class DropFilesEvent(Event):
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxDropFilesEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ """
+ This class is used for drop files events, that is, when files have
+ been dropped onto the window. This functionality is only available
+ under Windows. The window must have previously been enabled for
+ dropping by calling `wx.Window.DragAcceptFiles`.
+
+ Important note: this is a separate implementation to the more general
+ drag and drop implementation using `wx.FileDropTarget`, and etc. This
+ implementation uses the older, Windows message-based approach of
+ dropping files.
+
+ Use wx.EVT_DROP_FILES to bind an event handler to receive file drop
+ events.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the position at which the files were dropped.
+ """
return _core_.DropFilesEvent_GetPosition(*args, **kwargs)
def GetNumberOfFiles(*args, **kwargs):
- """GetNumberOfFiles(self) -> int"""
+ """
+ GetNumberOfFiles(self) -> int
+
+ Returns the number of files dropped.
+ """
return _core_.DropFilesEvent_GetNumberOfFiles(*args, **kwargs)
def GetFiles(*args, **kwargs):
- """GetFiles(self) -> PyObject"""
- return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
+ """
+ GetFiles(self) -> PyObject
+ Returns a list of the filenames that were dropped.
+ """
+ return _core_.DropFilesEvent_GetFiles(*args, **kwargs)
-class DropFilesEventPtr(DropFilesEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = DropFilesEvent
-_core_.DropFilesEvent_swigregister(DropFilesEventPtr)
+DropFilesEvent_swigregister = _core_.DropFilesEvent_swigregister
+DropFilesEvent_swigregister(DropFilesEvent)
#---------------------------------------------------------------------------
UPDATE_UI_PROCESS_ALL = _core_.UPDATE_UI_PROCESS_ALL
UPDATE_UI_PROCESS_SPECIFIED = _core_.UPDATE_UI_PROCESS_SPECIFIED
class UpdateUIEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxUpdateUIEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int commandId=0) -> UpdateUIEvent"""
- newobj = _core_.new_UpdateUIEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This class is used for EVT_UPDATE_UI pseudo-events which are sent by
+ wxWidgets to give an application the chance to update various user
+ interface elements.
+
+ Without update UI events, an application has to work hard to
+ check/uncheck, enable/disable, and set the text for elements such as
+ menu items and toolbar buttons. The code for doing this has to be
+ mixed up with the code that is invoked when an action is invoked for a
+ menu item or button.
+
+ With update UI events, you define an event handler to look at the
+ state of the application and change UI elements accordingly. wxWidgets
+ will call your handler functions in idle time, so you don't have to
+ worry where to call this code. In addition to being a clearer and more
+ declarative method, it also means you don't have to worry whether
+ you're updating a toolbar or menubar identifier. The same handler can
+ update a menu item and toolbar button, if the ID values are the same.
+
+ Instead of directly manipulating the menu or button, you call
+ functions in the event object, such as `Check`. wxWidgets will
+ determine whether such a call has been made, and which UI element to
+ update.
+
+ These events will work for popup menus as well as menubars. Just
+ before a menu is popped up, `wx.Menu.UpdateUI` is called to process
+ any UI events for the window that owns the menu.
+
+ If you find that the overhead of UI update processing is affecting
+ your application, you can do one or both of the following:
+
+ 1. Call `wx.UpdateUIEvent.SetMode` with a value of
+ wx.UPDATE_UI_PROCESS_SPECIFIED, and set the extra style
+ wx.WS_EX_PROCESS_UPDATE_EVENTS for every window that should
+ receive update events. No other windows will receive update
+ events.
+
+ 2. Call `wx.UpdateUIEvent.SetUpdateInterval` with a millisecond
+ value to set the delay between updates. You may need to call
+ `wx.Window.UpdateWindowUI` at critical points, for example when
+ a dialog is about to be shown, in case the user sees a slight
+ delay before windows are updated.
+
+ Note that although events are sent in idle time, defining a EVT_IDLE
+ handler for a window does not affect this because the events are sent
+ from an internal idle handler.
+
+ wxWidgets tries to optimize update events on some platforms. On
+ Windows and GTK+, events for menubar items are only sent when the menu
+ is about to be shown, and not in idle time.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int commandId=0) -> UpdateUIEvent
+
+ Constructor
+ """
+ _core_.UpdateUIEvent_swiginit(self,_core_.new_UpdateUIEvent(*args, **kwargs))
def GetChecked(*args, **kwargs):
- """GetChecked(self) -> bool"""
+ """
+ GetChecked(self) -> bool
+
+ Returns ``True`` if the UI element should be checked.
+ """
return _core_.UpdateUIEvent_GetChecked(*args, **kwargs)
def GetEnabled(*args, **kwargs):
- """GetEnabled(self) -> bool"""
+ """
+ GetEnabled(self) -> bool
+
+ Returns ``True`` if the UI element should be enabled.
+ """
return _core_.UpdateUIEvent_GetEnabled(*args, **kwargs)
+ def GetShown(*args, **kwargs):
+ """
+ GetShown(self) -> bool
+
+ Returns ``True`` if the UI element should be shown.
+ """
+ return _core_.UpdateUIEvent_GetShown(*args, **kwargs)
+
def GetText(*args, **kwargs):
- """GetText(self) -> String"""
+ """
+ GetText(self) -> String
+
+ Returns the text that should be set for the UI element.
+ """
return _core_.UpdateUIEvent_GetText(*args, **kwargs)
def GetSetText(*args, **kwargs):
- """GetSetText(self) -> bool"""
+ """
+ GetSetText(self) -> bool
+
+ Returns ``True`` if the application has called `SetText`. For
+ wxWidgets internal use only.
+ """
return _core_.UpdateUIEvent_GetSetText(*args, **kwargs)
def GetSetChecked(*args, **kwargs):
- """GetSetChecked(self) -> bool"""
+ """
+ GetSetChecked(self) -> bool
+
+ Returns ``True`` if the application has called `Check`. For wxWidgets
+ internal use only.
+ """
return _core_.UpdateUIEvent_GetSetChecked(*args, **kwargs)
def GetSetEnabled(*args, **kwargs):
- """GetSetEnabled(self) -> bool"""
+ """
+ GetSetEnabled(self) -> bool
+
+ Returns ``True`` if the application has called `Enable`. For wxWidgets
+ internal use only.
+ """
return _core_.UpdateUIEvent_GetSetEnabled(*args, **kwargs)
+ def GetSetShown(*args, **kwargs):
+ """
+ GetSetShown(self) -> bool
+
+ Returns ``True`` if the application has called `Show`. For wxWidgets
+ internal use only.
+ """
+ return _core_.UpdateUIEvent_GetSetShown(*args, **kwargs)
+
def Check(*args, **kwargs):
- """Check(self, bool check)"""
+ """
+ Check(self, bool check)
+
+ Check or uncheck the UI element.
+ """
return _core_.UpdateUIEvent_Check(*args, **kwargs)
def Enable(*args, **kwargs):
- """Enable(self, bool enable)"""
+ """
+ Enable(self, bool enable)
+
+ Enable or disable the UI element.
+ """
return _core_.UpdateUIEvent_Enable(*args, **kwargs)
+ def Show(*args, **kwargs):
+ """
+ Show(self, bool show)
+
+ Show or hide the UI element.
+ """
+ return _core_.UpdateUIEvent_Show(*args, **kwargs)
+
def SetText(*args, **kwargs):
- """SetText(self, String text)"""
+ """
+ SetText(self, String text)
+
+ Sets the text for this UI element.
+ """
return _core_.UpdateUIEvent_SetText(*args, **kwargs)
def SetUpdateInterval(*args, **kwargs):
- """SetUpdateInterval(long updateInterval)"""
+ """
+ SetUpdateInterval(long updateInterval)
+
+ Sets the interval between updates in milliseconds. Set to -1 to
+ disable updates, or to 0 to update as frequently as possible. The
+ default is 0.
+
+ Use this to reduce the overhead of UI update events if your
+ application has a lot of windows. If you set the value to -1 or
+ greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
+ at appropriate points in your application, such as when a dialog is
+ about to be shown.
+ """
return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
SetUpdateInterval = staticmethod(SetUpdateInterval)
def GetUpdateInterval(*args, **kwargs):
- """GetUpdateInterval() -> long"""
+ """
+ GetUpdateInterval() -> long
+
+ Returns the current interval between updates in milliseconds. -1
+ disables updates, 0 updates as frequently as possible.
+ """
return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
GetUpdateInterval = staticmethod(GetUpdateInterval)
def CanUpdate(*args, **kwargs):
- """CanUpdate(Window win) -> bool"""
+ """
+ CanUpdate(Window win) -> bool
+
+ Returns ``True`` if it is appropriate to update (send UI update events
+ to) this window.
+
+ This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
+ the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
+ events were last sent in idle time, and the update interval, to
+ determine whether events should be sent to this window now. By default
+ this will always return true because the update mode is initially
+ wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
+ events will be sent as often as possible. You can reduce the frequency
+ that events are sent by changing the mode and/or setting an update
+ interval.
+
+ """
return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
CanUpdate = staticmethod(CanUpdate)
def ResetUpdateTime(*args, **kwargs):
- """ResetUpdateTime()"""
+ """
+ ResetUpdateTime()
+
+ Used internally to reset the last-updated time to the current time. It
+ is assumed that update events are normally sent in idle time, so this
+ is called at the end of idle processing.
+ """
return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
ResetUpdateTime = staticmethod(ResetUpdateTime)
def SetMode(*args, **kwargs):
- """SetMode(int mode)"""
- return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
+ """
+ SetMode(int mode)
- SetMode = staticmethod(SetMode)
+ Specify how wxWidgets will send update events: to all windows, or only
+ to those which specify that they will process the events.
+
+ The mode may be one of the following values:
+
+ ============================= ==========================================
+ wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
+ is the default setting.
+ wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
+ have the wx.WS_EX_PROCESS_UI_UPDATES extra
+ style set.
+ ============================= ==========================================
+
+ """
+ return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
+
+ SetMode = staticmethod(SetMode)
def GetMode(*args, **kwargs):
- """GetMode() -> int"""
+ """
+ GetMode() -> int
+
+ Returns a value specifying how wxWidgets will send update events: to
+ all windows, or only to those which specify that they will process the
+ events.
+ """
return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
GetMode = staticmethod(GetMode)
-
-class UpdateUIEventPtr(UpdateUIEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = UpdateUIEvent
-_core_.UpdateUIEvent_swigregister(UpdateUIEventPtr)
+UpdateUIEvent_swigregister = _core_.UpdateUIEvent_swigregister
+UpdateUIEvent_swigregister(UpdateUIEvent)
def UpdateUIEvent_SetUpdateInterval(*args, **kwargs):
- """UpdateUIEvent_SetUpdateInterval(long updateInterval)"""
- return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
+ """
+ UpdateUIEvent_SetUpdateInterval(long updateInterval)
+
+ Sets the interval between updates in milliseconds. Set to -1 to
+ disable updates, or to 0 to update as frequently as possible. The
+ default is 0.
+
+ Use this to reduce the overhead of UI update events if your
+ application has a lot of windows. If you set the value to -1 or
+ greater than 0, you may also need to call `wx.Window.UpdateWindowUI`
+ at appropriate points in your application, such as when a dialog is
+ about to be shown.
+ """
+ return _core_.UpdateUIEvent_SetUpdateInterval(*args, **kwargs)
-def UpdateUIEvent_GetUpdateInterval(*args, **kwargs):
- """UpdateUIEvent_GetUpdateInterval() -> long"""
- return _core_.UpdateUIEvent_GetUpdateInterval(*args, **kwargs)
+def UpdateUIEvent_GetUpdateInterval(*args):
+ """
+ UpdateUIEvent_GetUpdateInterval() -> long
+
+ Returns the current interval between updates in milliseconds. -1
+ disables updates, 0 updates as frequently as possible.
+ """
+ return _core_.UpdateUIEvent_GetUpdateInterval(*args)
def UpdateUIEvent_CanUpdate(*args, **kwargs):
- """UpdateUIEvent_CanUpdate(Window win) -> bool"""
- return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
+ """
+ UpdateUIEvent_CanUpdate(Window win) -> bool
+
+ Returns ``True`` if it is appropriate to update (send UI update events
+ to) this window.
+
+ This function looks at the mode used (see `wx.UpdateUIEvent.SetMode`),
+ the wx.WS_EX_PROCESS_UPDATE_EVENTS flag in window, the time update
+ events were last sent in idle time, and the update interval, to
+ determine whether events should be sent to this window now. By default
+ this will always return true because the update mode is initially
+ wx.UPDATE_UI_PROCESS_ALL and the interval is set to 0; so update
+ events will be sent as often as possible. You can reduce the frequency
+ that events are sent by changing the mode and/or setting an update
+ interval.
+
+ """
+ return _core_.UpdateUIEvent_CanUpdate(*args, **kwargs)
-def UpdateUIEvent_ResetUpdateTime(*args, **kwargs):
- """UpdateUIEvent_ResetUpdateTime()"""
- return _core_.UpdateUIEvent_ResetUpdateTime(*args, **kwargs)
+def UpdateUIEvent_ResetUpdateTime(*args):
+ """
+ UpdateUIEvent_ResetUpdateTime()
+
+ Used internally to reset the last-updated time to the current time. It
+ is assumed that update events are normally sent in idle time, so this
+ is called at the end of idle processing.
+ """
+ return _core_.UpdateUIEvent_ResetUpdateTime(*args)
def UpdateUIEvent_SetMode(*args, **kwargs):
- """UpdateUIEvent_SetMode(int mode)"""
- return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
+ """
+ UpdateUIEvent_SetMode(int mode)
+
+ Specify how wxWidgets will send update events: to all windows, or only
+ to those which specify that they will process the events.
+
+ The mode may be one of the following values:
+
+ ============================= ==========================================
+ wxUPDATE_UI_PROCESS_ALL Send UI update events to all windows. This
+ is the default setting.
+ wxUPDATE_UI_PROCESS_SPECIFIED Send UI update events only to windows that
+ have the wx.WS_EX_PROCESS_UI_UPDATES extra
+ style set.
+ ============================= ==========================================
+
+ """
+ return _core_.UpdateUIEvent_SetMode(*args, **kwargs)
+
+def UpdateUIEvent_GetMode(*args):
+ """
+ UpdateUIEvent_GetMode() -> int
-def UpdateUIEvent_GetMode(*args, **kwargs):
- """UpdateUIEvent_GetMode() -> int"""
- return _core_.UpdateUIEvent_GetMode(*args, **kwargs)
+ Returns a value specifying how wxWidgets will send update events: to
+ all windows, or only to those which specify that they will process the
+ events.
+ """
+ return _core_.UpdateUIEvent_GetMode(*args)
#---------------------------------------------------------------------------
class SysColourChangedEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxSysColourChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> SysColourChangedEvent"""
- newobj = _core_.new_SysColourChangedEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class SysColourChangedEventPtr(SysColourChangedEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = SysColourChangedEvent
-_core_.SysColourChangedEvent_swigregister(SysColourChangedEventPtr)
+ """
+ This class is used for EVT_SYS_COLOUR_CHANGED, which are generated
+ when the user changes the colour settings using the control
+ panel. This is only applicable under Windows.
+
+ The default event handler for this event propagates the event to child
+ windows, since Windows only sends the events to top-level windows. If
+ intercepting this event for a top-level window, remember to call
+ `Skip` so the the base class handler will still be executed, or to
+ pass the event on to the window's children explicitly.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> SysColourChangedEvent
+
+ Constructor
+ """
+ _core_.SysColourChangedEvent_swiginit(self,_core_.new_SysColourChangedEvent(*args, **kwargs))
+SysColourChangedEvent_swigregister = _core_.SysColourChangedEvent_swigregister
+SysColourChangedEvent_swigregister(SysColourChangedEvent)
#---------------------------------------------------------------------------
class MouseCaptureChangedEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMouseCaptureChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent"""
- newobj = _core_.new_MouseCaptureChangedEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An mouse capture changed event (EVT_MOUSE_CAPTURE_CHANGED) is sent to
+ a window that loses its mouse capture. This is called even if
+ `wx.Window.ReleaseMouse` was called by the application code. Handling
+ this event allows an application to cater for unexpected capture
+ releases which might otherwise confuse mouse handling code.
+
+ This event is implemented under Windows only.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int winid=0, Window gainedCapture=None) -> MouseCaptureChangedEvent
+
+ Constructor
+ """
+ _core_.MouseCaptureChangedEvent_swiginit(self,_core_.new_MouseCaptureChangedEvent(*args, **kwargs))
def GetCapturedWindow(*args, **kwargs):
- """GetCapturedWindow(self) -> Window"""
- return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
+ """
+ GetCapturedWindow(self) -> Window
+ Returns the window that gained the capture, or ``None`` if it was a
+ non-wxWidgets window.
+ """
+ return _core_.MouseCaptureChangedEvent_GetCapturedWindow(*args, **kwargs)
-class MouseCaptureChangedEventPtr(MouseCaptureChangedEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MouseCaptureChangedEvent
-_core_.MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEventPtr)
+MouseCaptureChangedEvent_swigregister = _core_.MouseCaptureChangedEvent_swigregister
+MouseCaptureChangedEvent_swigregister(MouseCaptureChangedEvent)
#---------------------------------------------------------------------------
class DisplayChangedEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxDisplayChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """
+ An EVT_DISPLAY_CHANGED event is sent to all windows when the display
+ resolution has changed.
+
+ This event is implemented under Windows only.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> DisplayChangedEvent"""
- newobj = _core_.new_DisplayChangedEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
-
-class DisplayChangedEventPtr(DisplayChangedEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = DisplayChangedEvent
-_core_.DisplayChangedEvent_swigregister(DisplayChangedEventPtr)
+ _core_.DisplayChangedEvent_swiginit(self,_core_.new_DisplayChangedEvent(*args, **kwargs))
+DisplayChangedEvent_swigregister = _core_.DisplayChangedEvent_swigregister
+DisplayChangedEvent_swigregister(DisplayChangedEvent)
#---------------------------------------------------------------------------
class PaletteChangedEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPaletteChangedEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int id=0) -> PaletteChangedEvent"""
- newobj = _core_.new_PaletteChangedEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An EVT_PALETTE_CHANGED event is sent when the system palette has
+ changed, thereby giving each window a chance to redo their own to
+ match.
+
+ This event is implemented under Windows only.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int id=0) -> PaletteChangedEvent
+
+ An EVT_PALETTE_CHANGED event is sent when the system palette has
+ changed, thereby giving each window a chance to redo their own to
+ match.
+
+ This event is implemented under Windows only.
+ """
+ _core_.PaletteChangedEvent_swiginit(self,_core_.new_PaletteChangedEvent(*args, **kwargs))
def SetChangedWindow(*args, **kwargs):
"""SetChangedWindow(self, Window win)"""
return _core_.PaletteChangedEvent_SetChangedWindow(*args, **kwargs)
"""GetChangedWindow(self) -> Window"""
return _core_.PaletteChangedEvent_GetChangedWindow(*args, **kwargs)
-
-class PaletteChangedEventPtr(PaletteChangedEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PaletteChangedEvent
-_core_.PaletteChangedEvent_swigregister(PaletteChangedEventPtr)
+PaletteChangedEvent_swigregister = _core_.PaletteChangedEvent_swigregister
+PaletteChangedEvent_swigregister(PaletteChangedEvent)
#---------------------------------------------------------------------------
class QueryNewPaletteEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxQueryNewPaletteEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int winid=0) -> QueryNewPaletteEvent"""
- newobj = _core_.new_QueryNewPaletteEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ An EVT_QUERY_NEW_PALETE event indicates the window is getting keyboard
+ focus and should re-do its palette.
+
+ This event is implemented under Windows only.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int winid=0) -> QueryNewPaletteEvent
+
+ Constructor.
+ """
+ _core_.QueryNewPaletteEvent_swiginit(self,_core_.new_QueryNewPaletteEvent(*args, **kwargs))
def SetPaletteRealized(*args, **kwargs):
- """SetPaletteRealized(self, bool realized)"""
+ """
+ SetPaletteRealized(self, bool realized)
+
+ App should set this if it changes the palette.
+ """
return _core_.QueryNewPaletteEvent_SetPaletteRealized(*args, **kwargs)
def GetPaletteRealized(*args, **kwargs):
"""GetPaletteRealized(self) -> bool"""
return _core_.QueryNewPaletteEvent_GetPaletteRealized(*args, **kwargs)
-
-class QueryNewPaletteEventPtr(QueryNewPaletteEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = QueryNewPaletteEvent
-_core_.QueryNewPaletteEvent_swigregister(QueryNewPaletteEventPtr)
+QueryNewPaletteEvent_swigregister = _core_.QueryNewPaletteEvent_swigregister
+QueryNewPaletteEvent_swigregister(QueryNewPaletteEvent)
#---------------------------------------------------------------------------
class NavigationKeyEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxNavigationKeyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """
+ EVT_NAVIGATION_KEY events are used to control moving the focus between
+ widgets, otherwise known as tab-traversal. You woudl normally not
+ catch navigation events in applications as there are already
+ appropriate handlers in `wx.Dialog` and `wx.Panel`, but you may find
+ it useful to send navigation events in certain situations to change
+ the focus in certain ways, although it's probably easier to just call
+ `wx.Window.Navigate`.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> NavigationKeyEvent"""
- newobj = _core_.new_NavigationKeyEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.NavigationKeyEvent_swiginit(self,_core_.new_NavigationKeyEvent(*args, **kwargs))
def GetDirection(*args, **kwargs):
- """GetDirection(self) -> bool"""
+ """
+ GetDirection(self) -> bool
+
+ Returns ``True`` if the direction is forward, ``False`` otherwise.
+ """
return _core_.NavigationKeyEvent_GetDirection(*args, **kwargs)
def SetDirection(*args, **kwargs):
- """SetDirection(self, bool bForward)"""
+ """
+ SetDirection(self, bool forward)
+
+ Specify the direction that the navigation should take. Usually the
+ difference between using Tab and Shift-Tab.
+ """
return _core_.NavigationKeyEvent_SetDirection(*args, **kwargs)
def IsWindowChange(*args, **kwargs):
- """IsWindowChange(self) -> bool"""
+ """
+ IsWindowChange(self) -> bool
+
+ Returns ``True`` if window change is allowed.
+ """
return _core_.NavigationKeyEvent_IsWindowChange(*args, **kwargs)
def SetWindowChange(*args, **kwargs):
- """SetWindowChange(self, bool bIs)"""
+ """
+ SetWindowChange(self, bool ischange)
+
+ Specify if the navigation should be able to change parent windows.
+ For example, changing notebook pages, etc. This is usually implemented
+ by using Control-Tab.
+ """
return _core_.NavigationKeyEvent_SetWindowChange(*args, **kwargs)
+ def IsFromTab(*args, **kwargs):
+ """
+ IsFromTab(self) -> bool
+
+ Returns ``True`` if the navigation event is originated from the Tab
+ key.
+ """
+ return _core_.NavigationKeyEvent_IsFromTab(*args, **kwargs)
+
+ def SetFromTab(*args, **kwargs):
+ """
+ SetFromTab(self, bool bIs)
+
+ Set to true under MSW if the event was generated using the tab key.
+ This is required for proper navogation over radio buttons.
+ """
+ return _core_.NavigationKeyEvent_SetFromTab(*args, **kwargs)
+
+ def SetFlags(*args, **kwargs):
+ """
+ SetFlags(self, long flags)
+
+ Set the navigation flags to a combination of the following:
+
+ * wx.NavigationKeyEvent.IsBackward
+ * wx.NavigationKeyEvent.IsForward
+ * wx.NavigationKeyEvent.WinChange
+ * wx.NavigationKeyEvent.FromTab
+
+ """
+ return _core_.NavigationKeyEvent_SetFlags(*args, **kwargs)
+
def GetCurrentFocus(*args, **kwargs):
- """GetCurrentFocus(self) -> Window"""
+ """
+ GetCurrentFocus(self) -> Window
+
+ Returns the child window which currenty has the focus. May be
+ ``None``.
+ """
return _core_.NavigationKeyEvent_GetCurrentFocus(*args, **kwargs)
def SetCurrentFocus(*args, **kwargs):
- """SetCurrentFocus(self, Window win)"""
- return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
+ """
+ SetCurrentFocus(self, Window win)
+ Set the window that has the focus.
+ """
+ return _core_.NavigationKeyEvent_SetCurrentFocus(*args, **kwargs)
-class NavigationKeyEventPtr(NavigationKeyEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = NavigationKeyEvent
-_core_.NavigationKeyEvent_swigregister(NavigationKeyEventPtr)
+ IsBackward = _core_.NavigationKeyEvent_IsBackward
+ IsForward = _core_.NavigationKeyEvent_IsForward
+ WinChange = _core_.NavigationKeyEvent_WinChange
+ FromTab = _core_.NavigationKeyEvent_FromTab
+NavigationKeyEvent_swigregister = _core_.NavigationKeyEvent_swigregister
+NavigationKeyEvent_swigregister(NavigationKeyEvent)
#---------------------------------------------------------------------------
class WindowCreateEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxWindowCreateEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Window win=None) -> WindowCreateEvent"""
- newobj = _core_.new_WindowCreateEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ The EVT_WINDOW_CREATE event is sent as soon as the window object (the
+ underlying GUI object) exists.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Window win=None) -> WindowCreateEvent
+
+ The EVT_WINDOW_CREATE event is sent as soon as the window object (the
+ underlying GUI object) exists.
+ """
+ _core_.WindowCreateEvent_swiginit(self,_core_.new_WindowCreateEvent(*args, **kwargs))
def GetWindow(*args, **kwargs):
- """GetWindow(self) -> Window"""
- return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
+ """
+ GetWindow(self) -> Window
+ Returns the window that this event refers to.
+ """
+ return _core_.WindowCreateEvent_GetWindow(*args, **kwargs)
-class WindowCreateEventPtr(WindowCreateEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = WindowCreateEvent
-_core_.WindowCreateEvent_swigregister(WindowCreateEventPtr)
+WindowCreateEvent_swigregister = _core_.WindowCreateEvent_swigregister
+WindowCreateEvent_swigregister(WindowCreateEvent)
class WindowDestroyEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxWindowDestroyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, Window win=None) -> WindowDestroyEvent"""
- newobj = _core_.new_WindowDestroyEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
+ when the GUI window is destroyed.
+
+ When a class derived from `wx.Window` is destroyed its destructor will
+ have already run by the time this event is sent. Therefore this event
+ will not usually be received at all by the window itself. Since it is
+ received after the destructor has run, an object should not try to
+ handle its own wx.WindowDestroyEvent, but it can be used to get
+ notification of the destruction of another window.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, Window win=None) -> WindowDestroyEvent
+
+ The EVT_WINDOW_DESTROY event is sent from the `wx.Window` destructor
+ when the GUI window is destroyed.
+
+ When a class derived from `wx.Window` is destroyed its destructor will
+ have already run by the time this event is sent. Therefore this event
+ will not usually be received at all by the window itself. Since it is
+ received after the destructor has run, an object should not try to
+ handle its own wx.WindowDestroyEvent, but it can be used to get
+ notification of the destruction of another window.
+ """
+ _core_.WindowDestroyEvent_swiginit(self,_core_.new_WindowDestroyEvent(*args, **kwargs))
def GetWindow(*args, **kwargs):
- """GetWindow(self) -> Window"""
- return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
+ """
+ GetWindow(self) -> Window
+ Returns the window that this event refers to.
+ """
+ return _core_.WindowDestroyEvent_GetWindow(*args, **kwargs)
-class WindowDestroyEventPtr(WindowDestroyEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = WindowDestroyEvent
-_core_.WindowDestroyEvent_swigregister(WindowDestroyEventPtr)
+WindowDestroyEvent_swigregister = _core_.WindowDestroyEvent_swigregister
+WindowDestroyEvent_swigregister(WindowDestroyEvent)
#---------------------------------------------------------------------------
class ContextMenuEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxContextMenuEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent"""
- newobj = _core_.new_ContextMenuEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This class is used for context menu events (EVT_CONTECT_MENU,) sent to
+ give the application a chance to show a context (popup) menu.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, wxEventType type=wxEVT_NULL, int winid=0, Point pt=DefaultPosition) -> ContextMenuEvent
+
+ Constructor.
+ """
+ _core_.ContextMenuEvent_swiginit(self,_core_.new_ContextMenuEvent(*args, **kwargs))
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the position (in screen coordinants) at which the menu should
+ be shown.
+ """
return _core_.ContextMenuEvent_GetPosition(*args, **kwargs)
def SetPosition(*args, **kwargs):
- """SetPosition(self, Point pos)"""
- return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
+ """
+ SetPosition(self, Point pos)
+ Sets the position at which the menu should be shown.
+ """
+ return _core_.ContextMenuEvent_SetPosition(*args, **kwargs)
-class ContextMenuEventPtr(ContextMenuEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ContextMenuEvent
-_core_.ContextMenuEvent_swigregister(ContextMenuEventPtr)
+ContextMenuEvent_swigregister = _core_.ContextMenuEvent_swigregister
+ContextMenuEvent_swigregister(ContextMenuEvent)
#---------------------------------------------------------------------------
IDLE_PROCESS_ALL = _core_.IDLE_PROCESS_ALL
IDLE_PROCESS_SPECIFIED = _core_.IDLE_PROCESS_SPECIFIED
class IdleEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxIdleEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> IdleEvent"""
- newobj = _core_.new_IdleEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This class is used for EVT_IDLE events, which are generated and sent
+ when the application *becomes* idle. In other words, the when the
+ event queue becomes empty then idle events are sent to all windows (by
+ default) and as long as none of them call `RequestMore` then there are
+ no more idle events until after the system event queue has some normal
+ events and then becomes empty again.
+
+ By default, idle events are sent to all windows. If this is causing a
+ significant overhead in your application, you can call
+ `wx.IdleEvent.SetMode` with the value wx.IDLE_PROCESS_SPECIFIED, and
+ set the wx.WS_EX_PROCESS_IDLE extra window style for every window
+ which should receive idle events. Then idle events will only be sent
+ to those windows and not to any others.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> IdleEvent
+
+ Constructor
+ """
+ _core_.IdleEvent_swiginit(self,_core_.new_IdleEvent(*args, **kwargs))
def RequestMore(*args, **kwargs):
- """RequestMore(self, bool needMore=True)"""
+ """
+ RequestMore(self, bool needMore=True)
+
+ Tells wxWidgets that more processing is required. This function can be
+ called by an EVT_IDLE handler for a window to indicate that the
+ application should forward the EVT_IDLE event once more to the
+ application windows. If no window calls this function during its
+ EVT_IDLE handler, then the application will remain in a passive event
+ loop until a new event is posted to the application by the windowing
+ system.
+ """
return _core_.IdleEvent_RequestMore(*args, **kwargs)
def MoreRequested(*args, **kwargs):
- """MoreRequested(self) -> bool"""
+ """
+ MoreRequested(self) -> bool
+
+ Returns ``True`` if the OnIdle function processing this event
+ requested more processing time.
+ """
return _core_.IdleEvent_MoreRequested(*args, **kwargs)
def SetMode(*args, **kwargs):
- """SetMode(int mode)"""
+ """
+ SetMode(int mode)
+
+ Static method for specifying how wxWidgets will send idle events: to
+ all windows, or only to those which specify that they will process the
+ events.
+
+ The mode can be one of the following values:
+
+ ========================= ========================================
+ wx.IDLE_PROCESS_ALL Send idle events to all windows
+ wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
+ the wx.WS_EX_PROCESS_IDLE extra style
+ flag set.
+ ========================= ========================================
+
+ """
return _core_.IdleEvent_SetMode(*args, **kwargs)
SetMode = staticmethod(SetMode)
def GetMode(*args, **kwargs):
- """GetMode() -> int"""
+ """
+ GetMode() -> int
+
+ Static method returning a value specifying how wxWidgets will send
+ idle events: to all windows, or only to those which specify that they
+ will process the events.
+ """
return _core_.IdleEvent_GetMode(*args, **kwargs)
GetMode = staticmethod(GetMode)
def CanSend(*args, **kwargs):
- """CanSend(Window win) -> bool"""
+ """
+ CanSend(Window win) -> bool
+
+ Returns ``True`` if it is appropriate to send idle events to this
+ window.
+
+ This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
+ the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
+ events should be sent to this window now. By default this will always
+ return ``True`` because the update mode is initially
+ wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
+ to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
+ """
return _core_.IdleEvent_CanSend(*args, **kwargs)
CanSend = staticmethod(CanSend)
-
-class IdleEventPtr(IdleEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = IdleEvent
-_core_.IdleEvent_swigregister(IdleEventPtr)
+IdleEvent_swigregister = _core_.IdleEvent_swigregister
+IdleEvent_swigregister(IdleEvent)
def IdleEvent_SetMode(*args, **kwargs):
- """IdleEvent_SetMode(int mode)"""
- return _core_.IdleEvent_SetMode(*args, **kwargs)
+ """
+ IdleEvent_SetMode(int mode)
+
+ Static method for specifying how wxWidgets will send idle events: to
+ all windows, or only to those which specify that they will process the
+ events.
+
+ The mode can be one of the following values:
+
+ ========================= ========================================
+ wx.IDLE_PROCESS_ALL Send idle events to all windows
+ wx.IDLE_PROCESS_SPECIFIED Send idle events only to windows that have
+ the wx.WS_EX_PROCESS_IDLE extra style
+ flag set.
+ ========================= ========================================
+
+ """
+ return _core_.IdleEvent_SetMode(*args, **kwargs)
+
+def IdleEvent_GetMode(*args):
+ """
+ IdleEvent_GetMode() -> int
-def IdleEvent_GetMode(*args, **kwargs):
- """IdleEvent_GetMode() -> int"""
- return _core_.IdleEvent_GetMode(*args, **kwargs)
+ Static method returning a value specifying how wxWidgets will send
+ idle events: to all windows, or only to those which specify that they
+ will process the events.
+ """
+ return _core_.IdleEvent_GetMode(*args)
def IdleEvent_CanSend(*args, **kwargs):
- """IdleEvent_CanSend(Window win) -> bool"""
- return _core_.IdleEvent_CanSend(*args, **kwargs)
+ """
+ IdleEvent_CanSend(Window win) -> bool
+
+ Returns ``True`` if it is appropriate to send idle events to this
+ window.
+
+ This function looks at the mode used (see `wx.IdleEvent.SetMode`), and
+ the wx.WS_EX_PROCESS_IDLE style in window to determine whether idle
+ events should be sent to this window now. By default this will always
+ return ``True`` because the update mode is initially
+ wx.IDLE_PROCESS_ALL. You can change the mode to only send idle events
+ to windows with the wx.WS_EX_PROCESS_IDLE extra window style set.
+ """
+ return _core_.IdleEvent_CanSend(*args, **kwargs)
#---------------------------------------------------------------------------
class PyEvent(Event):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPyEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int winid=0, wxEventType commandType=wxEVT_NULL) -> PyEvent"""
- newobj = _core_.new_PyEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- self.SetSelf(self)
-
- def __del__(self, destroy=_core_.delete_PyEvent):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
+ """
+ wx.PyEvent can be used as a base class for implementing custom event
+ types in Python. You should derived from this class instead of
+ `wx.Event` because this class is Python-aware and is able to transport
+ its Python bits safely through the wxWidgets event system and have
+ them still be there when the event handler is invoked.
+
+ :see: `wx.PyCommandEvent`
- def SetSelf(*args, **kwargs):
- """SetSelf(self, PyObject self)"""
- return _core_.PyEvent_SetSelf(*args, **kwargs)
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """__init__(self, int winid=0, wxEventType eventType=wxEVT_NULL) -> PyEvent"""
+ _core_.PyEvent_swiginit(self,_core_.new_PyEvent(*args, **kwargs))
+ self._SetSelf(self)
+
+ __swig_destroy__ = _core_.delete_PyEvent
+ __del__ = lambda self : None;
+ def _SetSelf(*args, **kwargs):
+ """_SetSelf(self, PyObject self)"""
+ return _core_.PyEvent__SetSelf(*args, **kwargs)
+
+ def _GetSelf(*args, **kwargs):
+ """_GetSelf(self) -> PyObject"""
+ return _core_.PyEvent__GetSelf(*args, **kwargs)
+
+PyEvent_swigregister = _core_.PyEvent_swigregister
+PyEvent_swigregister(PyEvent)
- def GetSelf(*args, **kwargs):
- """GetSelf(self) -> PyObject"""
- return _core_.PyEvent_GetSelf(*args, **kwargs)
+class PyCommandEvent(CommandEvent):
+ """
+ wx.PyCommandEvent can be used as a base class for implementing custom
+ event types in Python, where the event shoudl travel up to parent
+ windows looking for a handler. You should derived from this class
+ instead of `wx.CommandEvent` because this class is Python-aware and is
+ able to transport its Python bits safely through the wxWidgets event
+ system and have them still be there when the event handler is invoked.
+ :see: `wx.PyEvent`
-class PyEventPtr(PyEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PyEvent
-_core_.PyEvent_swigregister(PyEventPtr)
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """__init__(self, wxEventType eventType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
+ _core_.PyCommandEvent_swiginit(self,_core_.new_PyCommandEvent(*args, **kwargs))
+ self._SetSelf(self)
+
+ __swig_destroy__ = _core_.delete_PyCommandEvent
+ __del__ = lambda self : None;
+ def _SetSelf(*args, **kwargs):
+ """_SetSelf(self, PyObject self)"""
+ return _core_.PyCommandEvent__SetSelf(*args, **kwargs)
+
+ def _GetSelf(*args, **kwargs):
+ """_GetSelf(self) -> PyObject"""
+ return _core_.PyCommandEvent__GetSelf(*args, **kwargs)
+
+PyCommandEvent_swigregister = _core_.PyCommandEvent_swigregister
+PyCommandEvent_swigregister(PyCommandEvent)
+
+class DateEvent(CommandEvent):
+ """
+ This event class holds information about a date change event and is
+ used together with `wx.DatePickerCtrl`. It also serves as a base class
+ for `wx.calendar.CalendarEvent`. Bind these event types with
+ EVT_DATE_CHANGED.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """__init__(self, Window win, DateTime dt, wxEventType type) -> DateEvent"""
+ _core_.DateEvent_swiginit(self,_core_.new_DateEvent(*args, **kwargs))
+ def GetDate(*args, **kwargs):
+ """
+ GetDate(self) -> DateTime
-class PyCommandEvent(CommandEvent):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPyCommandEvent instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxEventType commandType=wxEVT_NULL, int id=0) -> PyCommandEvent"""
- newobj = _core_.new_PyCommandEvent(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- self.SetSelf(self)
-
- def __del__(self, destroy=_core_.delete_PyCommandEvent):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
+ Returns the date.
+ """
+ return _core_.DateEvent_GetDate(*args, **kwargs)
- def SetSelf(*args, **kwargs):
- """SetSelf(self, PyObject self)"""
- return _core_.PyCommandEvent_SetSelf(*args, **kwargs)
+ def SetDate(*args, **kwargs):
+ """
+ SetDate(self, DateTime date)
- def GetSelf(*args, **kwargs):
- """GetSelf(self) -> PyObject"""
- return _core_.PyCommandEvent_GetSelf(*args, **kwargs)
+ Sets the date carried by the event, normally only used by the library
+ internally.
+ """
+ return _core_.DateEvent_SetDate(*args, **kwargs)
+DateEvent_swigregister = _core_.DateEvent_swigregister
+DateEvent_swigregister(DateEvent)
-class PyCommandEventPtr(PyCommandEvent):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PyCommandEvent
-_core_.PyCommandEvent_swigregister(PyCommandEventPtr)
+wxEVT_DATE_CHANGED = _core_.wxEVT_DATE_CHANGED
+EVT_DATE_CHANGED = wx.PyEventBinder( wxEVT_DATE_CHANGED, 1 )
#---------------------------------------------------------------------------
The ``wx.PyApp`` class is an *implementation detail*, please use the
`wx.App` class (or some other derived class) instead.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPyApp instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self) -> PyApp
Create a new application object, starting the bootstrap process.
"""
- newobj = _core_.new_PyApp(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- self._setCallbackInfo(self, PyApp)
- self._setOORInfo(self)
-
- def __del__(self, destroy=_core_.delete_PyApp):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
+ _core_.PyApp_swiginit(self,_core_.new_PyApp(*args, **kwargs))
+ self._setCallbackInfo(self, PyApp, False)
+ self._setOORInfo(self, False)
+ __swig_destroy__ = _core_.delete_PyApp
+ __del__ = lambda self : None;
def _setCallbackInfo(*args, **kwargs):
- """_setCallbackInfo(self, PyObject self, PyObject _class)"""
+ """_setCallbackInfo(self, PyObject self, PyObject _class, bool incref)"""
return _core_.PyApp__setCallbackInfo(*args, **kwargs)
def GetAppName(*args, **kwargs):
"""
return _core_.PyApp_WakeUpIdle(*args, **kwargs)
+ def IsMainLoopRunning(*args, **kwargs):
+ """
+ IsMainLoopRunning() -> bool
+
+ Returns True if we're running the main loop, i.e. if the events can
+ currently be dispatched.
+ """
+ return _core_.PyApp_IsMainLoopRunning(*args, **kwargs)
+
+ IsMainLoopRunning = staticmethod(IsMainLoopRunning)
def MainLoop(*args, **kwargs):
"""
MainLoop(self) -> int
return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
GetComCtl32Version = staticmethod(GetComCtl32Version)
+PyApp_swigregister = _core_.PyApp_swigregister
+PyApp_swigregister(PyApp)
-class PyAppPtr(PyApp):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PyApp
-_core_.PyApp_swigregister(PyAppPtr)
+def PyApp_IsMainLoopRunning(*args):
+ """
+ PyApp_IsMainLoopRunning() -> bool
-def PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs):
- """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
- return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args, **kwargs)
+ Returns True if we're running the main loop, i.e. if the events can
+ currently be dispatched.
+ """
+ return _core_.PyApp_IsMainLoopRunning(*args)
+
+def PyApp_GetMacSupportPCMenuShortcuts(*args):
+ """PyApp_GetMacSupportPCMenuShortcuts() -> bool"""
+ return _core_.PyApp_GetMacSupportPCMenuShortcuts(*args)
-def PyApp_GetMacAboutMenuItemId(*args, **kwargs):
- """PyApp_GetMacAboutMenuItemId() -> long"""
- return _core_.PyApp_GetMacAboutMenuItemId(*args, **kwargs)
+def PyApp_GetMacAboutMenuItemId(*args):
+ """PyApp_GetMacAboutMenuItemId() -> long"""
+ return _core_.PyApp_GetMacAboutMenuItemId(*args)
-def PyApp_GetMacPreferencesMenuItemId(*args, **kwargs):
- """PyApp_GetMacPreferencesMenuItemId() -> long"""
- return _core_.PyApp_GetMacPreferencesMenuItemId(*args, **kwargs)
+def PyApp_GetMacPreferencesMenuItemId(*args):
+ """PyApp_GetMacPreferencesMenuItemId() -> long"""
+ return _core_.PyApp_GetMacPreferencesMenuItemId(*args)
-def PyApp_GetMacExitMenuItemId(*args, **kwargs):
- """PyApp_GetMacExitMenuItemId() -> long"""
- return _core_.PyApp_GetMacExitMenuItemId(*args, **kwargs)
+def PyApp_GetMacExitMenuItemId(*args):
+ """PyApp_GetMacExitMenuItemId() -> long"""
+ return _core_.PyApp_GetMacExitMenuItemId(*args)
-def PyApp_GetMacHelpMenuTitleName(*args, **kwargs):
- """PyApp_GetMacHelpMenuTitleName() -> String"""
- return _core_.PyApp_GetMacHelpMenuTitleName(*args, **kwargs)
+def PyApp_GetMacHelpMenuTitleName(*args):
+ """PyApp_GetMacHelpMenuTitleName() -> String"""
+ return _core_.PyApp_GetMacHelpMenuTitleName(*args)
def PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs):
- """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
- return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
+ """PyApp_SetMacSupportPCMenuShortcuts(bool val)"""
+ return _core_.PyApp_SetMacSupportPCMenuShortcuts(*args, **kwargs)
def PyApp_SetMacAboutMenuItemId(*args, **kwargs):
- """PyApp_SetMacAboutMenuItemId(long val)"""
- return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
+ """PyApp_SetMacAboutMenuItemId(long val)"""
+ return _core_.PyApp_SetMacAboutMenuItemId(*args, **kwargs)
def PyApp_SetMacPreferencesMenuItemId(*args, **kwargs):
- """PyApp_SetMacPreferencesMenuItemId(long val)"""
- return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
+ """PyApp_SetMacPreferencesMenuItemId(long val)"""
+ return _core_.PyApp_SetMacPreferencesMenuItemId(*args, **kwargs)
def PyApp_SetMacExitMenuItemId(*args, **kwargs):
- """PyApp_SetMacExitMenuItemId(long val)"""
- return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
+ """PyApp_SetMacExitMenuItemId(long val)"""
+ return _core_.PyApp_SetMacExitMenuItemId(*args, **kwargs)
def PyApp_SetMacHelpMenuTitleName(*args, **kwargs):
- """PyApp_SetMacHelpMenuTitleName(String val)"""
- return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
+ """PyApp_SetMacHelpMenuTitleName(String val)"""
+ return _core_.PyApp_SetMacHelpMenuTitleName(*args, **kwargs)
-def PyApp_GetComCtl32Version(*args, **kwargs):
- """
+def PyApp_GetComCtl32Version(*args):
+ """
PyApp_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.
"""
- return _core_.PyApp_GetComCtl32Version(*args, **kwargs)
+ return _core_.PyApp_GetComCtl32Version(*args)
#---------------------------------------------------------------------------
-def Exit(*args, **kwargs):
- """
+def Exit(*args):
+ """
Exit()
Force an exit of the application. Convenience for wx.GetApp().Exit()
"""
- return _core_.Exit(*args, **kwargs)
+ return _core_.Exit(*args)
-def Yield(*args, **kwargs):
- """
+def Yield(*args):
+ """
Yield() -> bool
Yield to other apps/messages. Convenience for wx.GetApp().Yield()
"""
- return _core_.Yield(*args, **kwargs)
+ return _core_.Yield(*args)
-def YieldIfNeeded(*args, **kwargs):
- """
+def YieldIfNeeded(*args):
+ """
YieldIfNeeded() -> bool
Yield to other apps/messages. Convenience for wx.GetApp().Yield(True)
"""
- return _core_.YieldIfNeeded(*args, **kwargs)
+ return _core_.YieldIfNeeded(*args)
def SafeYield(*args, **kwargs):
- """
+ """
SafeYield(Window win=None, bool onlyIfNeeded=False) -> bool
This function is similar to `wx.Yield`, except that it disables the
:Returns: the result of the call to `wx.Yield`.
"""
- return _core_.SafeYield(*args, **kwargs)
+ return _core_.SafeYield(*args, **kwargs)
-def WakeUpIdle(*args, **kwargs):
- """
+def WakeUpIdle(*args):
+ """
WakeUpIdle()
Cause the message queue to become empty again, so idle events will be
sent.
"""
- return _core_.WakeUpIdle(*args, **kwargs)
+ return _core_.WakeUpIdle(*args)
def PostEvent(*args, **kwargs):
- """
+ """
PostEvent(EvtHandler dest, Event event)
Send an event to a window or other wx.EvtHandler to be processed
later.
"""
- return _core_.PostEvent(*args, **kwargs)
+ return _core_.PostEvent(*args, **kwargs)
-def App_CleanUp(*args, **kwargs):
- """
+def App_CleanUp(*args):
+ """
App_CleanUp()
For internal use only, it is used to cleanup after wxWidgets when
Python shuts down.
"""
- return _core_.App_CleanUp(*args, **kwargs)
+ return _core_.App_CleanUp(*args)
-def GetApp(*args, **kwargs):
- """
+def GetApp(*args):
+ """
GetApp() -> PyApp
Return a reference to the current wx.App object.
"""
- return _core_.GetApp(*args, **kwargs)
+ return _core_.GetApp(*args)
+
+def SetDefaultPyEncoding(*args, **kwargs):
+ """
+ SetDefaultPyEncoding(string encoding)
+
+ Sets the encoding that wxPython will use when it needs to convert a
+ Python string or unicode object to or from a wxString.
+
+ The default encoding is the value of ``locale.getdefaultlocale()[1]``
+ but please be aware that the default encoding within the same locale
+ may be slightly different on different platforms. For example, please
+ see http://www.alanwood.net/demos/charsetdiffs.html for differences
+ between the common latin/roman encodings.
+ """
+ return _core_.SetDefaultPyEncoding(*args, **kwargs)
+
+def GetDefaultPyEncoding(*args):
+ """
+ GetDefaultPyEncoding() -> string
+
+ Gets the current encoding that wxPython will use when it needs to
+ convert a Python string or unicode object to or from a wxString.
+ """
+ return _core_.GetDefaultPyEncoding(*args)
#----------------------------------------------------------------------
class PyOnDemandOutputWindow:
def __init__(self, title = "wxPython: stdout/stderr"):
self.frame = None
self.title = title
+ self.pos = wx.DefaultPosition
+ self.size = (450, 300)
self.parent = None
def SetParent(self, parent):
def CreateOutputWindow(self, st):
- self.frame = wx.Frame(self.parent, -1, self.title,
- style=wx.DEFAULT_FRAME_STYLE | wx.NO_FULL_REPAINT_ON_RESIZE)
+ self.frame = wx.Frame(self.parent, -1, self.title, self.pos, self.size,
+ style=wx.DEFAULT_FRAME_STYLE)
self.text = wx.TextCtrl(self.frame, -1, "",
- style = wx.TE_MULTILINE | wx.TE_READONLY)
+ style=wx.TE_MULTILINE|wx.TE_READONLY)
self.text.AppendText(st)
- self.frame.SetSize((450, 300))
self.frame.Show(True)
EVT_CLOSE(self.frame, self.OnCloseWindow)
wx.CallAfter(self.frame.Close)
+ def flush(self):
+ pass
+
+
#----------------------------------------------------------------------
if redirect:
self.RedirectStdio(filename)
+ # Use Python's install prefix as the default
+ wx.StandardPaths.Get().SetInstallPrefix(_sys.prefix)
+
# This finishes the initialization of wxWindows and then calls
# the OnInit that should be present in the derived class
self._BootstrapApp()
- def __del__(self):
- try:
- self.RestoreStdio() # Just in case the MainLoop was overridden
- except:
- pass
+ def __del__(self, destroy=wx.PyApp.__del__):
+ self.RestoreStdio() # Just in case the MainLoop was overridden
+ destroy(self)
+ def Destroy(self):
+ wx.PyApp.Destroy(self)
+ self.thisown = 0
def SetTopWindow(self, frame):
"""Set the \"main\" top level window"""
def RestoreStdio(self):
- _sys.stdout, _sys.stderr = self.saveStdio
+ try:
+ _sys.stdout, _sys.stderr = self.saveStdio
+ except:
+ pass
+
+
+ def SetOutputWindowAttributes(self, title=None, pos=None, size=None):
+ """
+ Set the title, position and/or size of the output window if
+ the stdio has been redirected. This should be called before
+ any output would cause the output window to be created.
+ """
+ if self.stdioWin:
+ if title is not None:
+ self.stdioWin.title = title
+ if pos is not None:
+ self.stdioWin.pos = pos
+ if size is not None:
+ self.stdioWin.size = size
+
#---------------------------------------------------------------------------
+class EventLoop(object):
+ """Proxy of C++ EventLoop class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """__init__(self) -> EventLoop"""
+ _core_.EventLoop_swiginit(self,_core_.new_EventLoop(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_EventLoop
+ __del__ = lambda self : None;
+ def Run(*args, **kwargs):
+ """Run(self) -> int"""
+ return _core_.EventLoop_Run(*args, **kwargs)
+
+ def Exit(*args, **kwargs):
+ """Exit(self, int rc=0)"""
+ return _core_.EventLoop_Exit(*args, **kwargs)
+
+ def Pending(*args, **kwargs):
+ """Pending(self) -> bool"""
+ return _core_.EventLoop_Pending(*args, **kwargs)
+
+ def Dispatch(*args, **kwargs):
+ """Dispatch(self) -> bool"""
+ return _core_.EventLoop_Dispatch(*args, **kwargs)
+
+ def IsRunning(*args, **kwargs):
+ """IsRunning(self) -> bool"""
+ return _core_.EventLoop_IsRunning(*args, **kwargs)
+
+ def GetActive(*args, **kwargs):
+ """GetActive() -> EventLoop"""
+ return _core_.EventLoop_GetActive(*args, **kwargs)
+
+ GetActive = staticmethod(GetActive)
+ def SetActive(*args, **kwargs):
+ """SetActive(EventLoop loop)"""
+ return _core_.EventLoop_SetActive(*args, **kwargs)
+
+ SetActive = staticmethod(SetActive)
+EventLoop_swigregister = _core_.EventLoop_swigregister
+EventLoop_swigregister(EventLoop)
+
+def EventLoop_GetActive(*args):
+ """EventLoop_GetActive() -> EventLoop"""
+ return _core_.EventLoop_GetActive(*args)
+
+def EventLoop_SetActive(*args, **kwargs):
+ """EventLoop_SetActive(EventLoop loop)"""
+ return _core_.EventLoop_SetActive(*args, **kwargs)
+
+class EventLoopActivator(object):
+ """Proxy of C++ EventLoopActivator class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """__init__(self, EventLoop evtLoop) -> EventLoopActivator"""
+ _core_.EventLoopActivator_swiginit(self,_core_.new_EventLoopActivator(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_EventLoopActivator
+ __del__ = lambda self : None;
+EventLoopActivator_swigregister = _core_.EventLoopActivator_swigregister
+EventLoopActivator_swigregister(EventLoopActivator)
+
+#---------------------------------------------------------------------------
+
class AcceleratorEntry(object):
"""
A class used to define items in an `wx.AcceleratorTable`. wxPython
:see: `wx.AcceleratorTable`
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxAcceleratorEntry instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, int flags=0, int keyCode=0, int cmdID=0) -> AcceleratorEntry
Construct a wx.AcceleratorEntry.
"""
- newobj = _core_.new_AcceleratorEntry(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_AcceleratorEntry):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.AcceleratorEntry_swiginit(self,_core_.new_AcceleratorEntry(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_AcceleratorEntry
+ __del__ = lambda self : None;
def Set(*args, **kwargs):
"""
Set(self, int flags, int keyCode, int cmd)
"""
return _core_.AcceleratorEntry_GetCommand(*args, **kwargs)
-
-class AcceleratorEntryPtr(AcceleratorEntry):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = AcceleratorEntry
-_core_.AcceleratorEntry_swigregister(AcceleratorEntryPtr)
+AcceleratorEntry_swigregister = _core_.AcceleratorEntry_swigregister
+AcceleratorEntry_swigregister(AcceleratorEntry)
class AcceleratorTable(Object):
"""
button commands are supported; on GTK, only menu commands are
supported.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxAcceleratorTable instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(entries) -> AcceleratorTable
:see: `wx.AcceleratorEntry`
"""
- newobj = _core_.new_AcceleratorTable(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_AcceleratorTable):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _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)
-
-class AcceleratorTablePtr(AcceleratorTable):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = AcceleratorTable
-_core_.AcceleratorTable_swigregister(AcceleratorTablePtr)
+AcceleratorTable_swigregister = _core_.AcceleratorTable_swigregister
+AcceleratorTable_swigregister(AcceleratorTable)
def GetAccelFromString(*args, **kwargs):
- """GetAccelFromString(String label) -> AcceleratorEntry"""
- return _core_.GetAccelFromString(*args, **kwargs)
+ """GetAccelFromString(String label) -> AcceleratorEntry"""
+ return _core_.GetAccelFromString(*args, **kwargs)
#---------------------------------------------------------------------------
class VisualAttributes(object):
"""struct containing all the visual attributes of a control"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxVisualAttributes instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self) -> VisualAttributes
struct containing all the visual attributes of a control
"""
- newobj = _core_.new_VisualAttributes(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- def __del__(self, destroy=_core_.delete_VisualAttributes):
- """__del__(self)"""
- try:
- if self.thisown: destroy(self)
- except: pass
-
+ _core_.VisualAttributes_swiginit(self,_core_.new_VisualAttributes(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_VisualAttributes
+ __del__ = lambda self : None;
font = property(_core_.VisualAttributes_font_get, _core_.VisualAttributes_font_set)
colFg = property(_core_.VisualAttributes_colFg_get, _core_.VisualAttributes_colFg_set)
colBg = property(_core_.VisualAttributes_colBg_get, _core_.VisualAttributes_colBg_set)
-
-class VisualAttributesPtr(VisualAttributes):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = VisualAttributes
-_core_.VisualAttributes_swigregister(VisualAttributesPtr)
+VisualAttributes_swigregister = _core_.VisualAttributes_swigregister
+VisualAttributes_swigregister(VisualAttributes)
NullAcceleratorTable = cvar.NullAcceleratorTable
PanelNameStr = cvar.PanelNameStr
appear on screen themselves.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxWindow instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
Size size=DefaultSize, long style=0, String name=PanelNameStr) -> Window
Construct and show a generic Window.
"""
- newobj = _core_.new_Window(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.Window_swiginit(self,_core_.new_Window(*args, **kwargs))
self._setOORInfo(self)
def Create(*args, **kwargs):
Returns True if the window has either been successfully deleted, or it
has been added to the list of windows pending real deletion.
"""
- return _core_.Window_Destroy(*args, **kwargs)
+ val = _core_.Window_Destroy(*args, **kwargs)
+ args[0].thisown = 0
+ return val
def DestroyChildren(*args, **kwargs):
"""
"""
return _core_.Window_IsBeingDeleted(*args, **kwargs)
- def SetTitle(*args, **kwargs):
- """
- SetTitle(self, String title)
-
- Sets the window's title. Applicable only to frames and dialogs.
- """
- return _core_.Window_SetTitle(*args, **kwargs)
-
- def GetTitle(*args, **kwargs):
- """
- GetTitle(self) -> String
-
- Gets the window's title. Applicable only to frames and dialogs.
- """
- return _core_.Window_GetTitle(*args, **kwargs)
-
def SetLabel(*args, **kwargs):
"""
SetLabel(self, String label)
Sets the position and size of the window in pixels. The sizeFlags
parameter indicates the interpretation of the other params if they are
- -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
- shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
- used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
- dimensions of -1 and less to be interpreted as real dimensions, not
- default values.
+ equal to -1.
+
+ ======================== ======================================
+ wx.SIZE_AUTO A -1 indicates that a class-specific
+ default should be used.
+ wx.SIZE_USE_EXISTING Axisting dimensions should be used if
+ -1 values are supplied.
+ wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
+ interpreted as real dimensions, not
+ default values.
+ ======================== ======================================
+
"""
return _core_.Window_SetDimensions(*args, **kwargs)
"""
return _core_.Window_MoveXY(*args, **kwargs)
+ def SetBestFittingSize(*args, **kwargs):
+ """
+ SetBestFittingSize(self, Size size=DefaultSize)
+
+ A 'Smart' SetSize that will fill in default size components with the
+ window's *best size* values. Also set's the minsize for use with sizers.
+ """
+ return _core_.Window_SetBestFittingSize(*args, **kwargs)
+
def Raise(*args, **kwargs):
"""
Raise(self)
- Raises the window to the top of the window hierarchy if it is a
- managed window (dialog or frame).
+ Raises the window to the top of the window hierarchy. In current
+ version of wxWidgets this works both for manage and child windows.
"""
return _core_.Window_Raise(*args, **kwargs)
"""
Lower(self)
- Lowers the window to the bottom of the window hierarchy if it is a
- managed window (dialog or frame).
+ Lowers the window to the bottom of the window hierarchy. In current
+ version of wxWidgets this works both for manage and child windows.
"""
return _core_.Window_Lower(*args, **kwargs)
"""
GetPosition(self) -> Point
- Get the window's position.
+ Get the window's position. Notice that the position is in client
+ coordinates for child windows and screen coordinates for the top level
+ ones, use `GetScreenPosition` if you need screen coordinates for all
+ kinds of windows.
"""
return _core_.Window_GetPosition(*args, **kwargs)
"""
GetPositionTuple() -> (x,y)
- Get the window's position.
+ Get the window's position. Notice that the position is in client
+ coordinates for child windows and screen coordinates for the top level
+ ones, use `GetScreenPosition` if you need screen coordinates for all
+ kinds of windows.
"""
return _core_.Window_GetPositionTuple(*args, **kwargs)
+ def GetScreenPosition(*args, **kwargs):
+ """
+ GetScreenPosition(self) -> Point
+
+ Get the position of the window in screen coordinantes.
+ """
+ return _core_.Window_GetScreenPosition(*args, **kwargs)
+
+ def GetScreenPositionTuple(*args, **kwargs):
+ """
+ GetScreenPositionTuple() -> (x,y)
+
+ Get the position of the window in screen coordinantes.
+ """
+ return _core_.Window_GetScreenPositionTuple(*args, **kwargs)
+
+ def GetScreenRect(*args, **kwargs):
+ """
+ GetScreenRect(self) -> Rect
+
+ Returns the size and position of the window in screen coordinantes as
+ a `wx.Rect` object.
+ """
+ return _core_.Window_GetScreenRect(*args, **kwargs)
+
def GetSize(*args, **kwargs):
"""
GetSize(self) -> Size
"""
GetRect(self) -> Rect
- Returns the size and position of the window as a wx.Rect object.
+ Returns the size and position of the window as a `wx.Rect` object.
"""
return _core_.Window_GetRect(*args, **kwargs)
"""
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)
"""
GetBestSize(self) -> Size
- This functions returns the best acceptable minimal size for the
+ This function returns the best acceptable minimal size for the
window, if applicable. For example, for a static text control, it will
be the minimal size such that the control label is not truncated. For
windows containing subwindows (suzh aswx.Panel), the size returned by
"""
GetBestSizeTuple() -> (width, height)
- This functions returns the best acceptable minimal size for the
+ This function returns the best acceptable minimal size for the
window, if applicable. For example, for a static text control, it will
be the minimal size such that the control label is not truncated. For
windows containing subwindows (suzh aswx.Panel), the size returned by
"""
return _core_.Window_GetBestSizeTuple(*args, **kwargs)
+ def InvalidateBestSize(*args, **kwargs):
+ """
+ InvalidateBestSize(self)
+
+ Reset the cached best size value so it will be recalculated the next
+ time it is needed.
+ """
+ return _core_.Window_InvalidateBestSize(*args, **kwargs)
+
+ def CacheBestSize(*args, **kwargs):
+ """
+ CacheBestSize(self, Size size)
+
+ Cache the best size so it doesn't need to be calculated again, (at least until
+ some properties of the window change.)
+ """
+ return _core_.Window_CacheBestSize(*args, **kwargs)
+
+ def GetBestFittingSize(*args, **kwargs):
+ """
+ GetBestFittingSize(self) -> Size
+
+ This function will merge the window's best size into the window's
+ minimum size, giving priority to the min size components, and returns
+ the results.
+
+ """
+ return _core_.Window_GetBestFittingSize(*args, **kwargs)
+
def GetAdjustedBestSize(*args, **kwargs):
"""
GetAdjustedBestSize(self) -> Size
return _core_.Window_Center(*args, **kwargs)
Centre = Center
- def CenterOnScreen(*args, **kwargs):
- """
- CenterOnScreen(self, int dir=BOTH)
-
- Center on screen (only works for top level windows)
- """
- return _core_.Window_CenterOnScreen(*args, **kwargs)
-
- CentreOnScreen = CenterOnScreen
def CenterOnParent(*args, **kwargs):
"""
CenterOnParent(self, int dir=BOTH)
"""
return _core_.Window_FitInside(*args, **kwargs)
- def SetSizeHints(*args):
+ def SetSizeHints(*args, **kwargs):
"""
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1,
int incH=-1)
- SetSizeHints(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
Allows specification of minimum and maximum window sizes, and window
size increments. If a pair of values is not set (or set to -1), the
default values will be used. If this function is called, the user
- will not be able to size the window outside the given bounds. The
- resizing increments are only significant under Motif or Xt.
+ will not be able to size the window outside the given bounds (if it is
+ a top-level window.) Sizers will also inspect the minimum window size
+ and will use that value if set when calculating layout.
+
+ The resizing increments are only significant under Motif or Xt.
+ """
+ return _core_.Window_SetSizeHints(*args, **kwargs)
+
+ def SetSizeHintsSz(*args, **kwargs):
+ """
+ SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
+
+ Allows specification of minimum and maximum window sizes, and window
+ size increments. If a pair of values is not set (or set to -1), the
+ default values will be used. If this function is called, the user
+ will not be able to size the window outside the given bounds (if it is
+ a top-level window.) Sizers will also inspect the minimum window size
+ and will use that value if set when calculating layout.
+
+ The resizing increments are only significant under Motif or Xt.
"""
- return _core_.Window_SetSizeHints(*args)
+ return _core_.Window_SetSizeHintsSz(*args, **kwargs)
- def SetVirtualSizeHints(*args):
+ def SetVirtualSizeHints(*args, **kwargs):
"""
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
- SetVirtualSizeHints(self, Size minSize, Size maxSize=DefaultSize)
Allows specification of minimum and maximum virtual window sizes. If a
pair of values is not set (or set to -1), the default values will be
used. If this function is called, the user will not be able to size
the virtual area of the window outside the given bounds.
"""
- return _core_.Window_SetVirtualSizeHints(*args)
+ return _core_.Window_SetVirtualSizeHints(*args, **kwargs)
+
+ def SetVirtualSizeHintsSz(*args, **kwargs):
+ """
+ SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
+
+ Allows specification of minimum and maximum virtual window sizes. If a
+ pair of values is not set (or set to -1), the default values will be
+ used. If this function is called, the user will not be able to size
+ the virtual area of the window outside the given bounds.
+ """
+ return _core_.Window_SetVirtualSizeHintsSz(*args, **kwargs)
+
+ def GetMaxSize(*args, **kwargs):
+ """GetMaxSize(self) -> Size"""
+ return _core_.Window_GetMaxSize(*args, **kwargs)
+
+ def GetMinSize(*args, **kwargs):
+ """GetMinSize(self) -> Size"""
+ return _core_.Window_GetMinSize(*args, **kwargs)
+
+ def SetMinSize(*args, **kwargs):
+ """
+ SetMinSize(self, Size minSize)
+
+ A more convenient method than `SetSizeHints` for setting just the
+ min size.
+ """
+ return _core_.Window_SetMinSize(*args, **kwargs)
+
+ def SetMaxSize(*args, **kwargs):
+ """
+ SetMaxSize(self, Size maxSize)
+
+ A more convenient method than `SetSizeHints` for setting just the
+ max size.
+ """
+ return _core_.Window_SetMaxSize(*args, **kwargs)
def GetMinWidth(*args, **kwargs):
"""GetMinWidth(self) -> int"""
"""GetMaxHeight(self) -> int"""
return _core_.Window_GetMaxHeight(*args, **kwargs)
- def GetMaxSize(*args, **kwargs):
- """GetMaxSize(self) -> Size"""
- return _core_.Window_GetMaxSize(*args, **kwargs)
-
- def GetMinSize(*args, **kwargs):
- """GetMinSize(self) -> Size"""
- return _core_.Window_GetMinSize(*args, **kwargs)
-
def SetVirtualSize(*args, **kwargs):
"""
SetVirtualSize(self, Size size)
"""
return _core_.Window_SetTmpDefaultItem(*args, **kwargs)
+ def Navigate(*args, **kwargs):
+ """
+ Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
+
+ Does keyboard navigation from this window to another, by sending a
+ `wx.NavigationKeyEvent`.
+ """
+ return _core_.Window_Navigate(*args, **kwargs)
+
+ def MoveAfterInTabOrder(*args, **kwargs):
+ """
+ MoveAfterInTabOrder(self, Window win)
+
+ Moves this window in the tab navigation order after the specified
+ sibling window. This means that when the user presses the TAB key on
+ that other window, the focus switches to this window.
+
+ The default tab order is the same as creation order. This function
+ and `MoveBeforeInTabOrder` allow to change it after creating all the
+ windows.
+
+ """
+ return _core_.Window_MoveAfterInTabOrder(*args, **kwargs)
+
+ def MoveBeforeInTabOrder(*args, **kwargs):
+ """
+ MoveBeforeInTabOrder(self, Window win)
+
+ Same as `MoveAfterInTabOrder` except that it inserts this window just
+ before win instead of putting it right after it.
+ """
+ return _core_.Window_MoveBeforeInTabOrder(*args, **kwargs)
+
def GetChildren(*args, **kwargs):
"""
GetChildren(self) -> PyObject
def RefreshRect(*args, **kwargs):
"""
- RefreshRect(self, Rect rect)
+ RefreshRect(self, Rect rect, bool eraseBackground=True)
Redraws the contents of the given rectangle: the area inside it will
be repainted. This is the same as Refresh but has a nicer syntax.
Sets the background colour of the window. Returns True if the colour
was changed. The background colour is usually painted by the default
EVT_ERASE_BACKGROUND event handler function under Windows and
- automatically under GTK.
+ automatically under GTK. Using `wx.NullColour` will reset the window
+ to the default background colour.
Note that setting the background colour may not cause an immediate
- refresh, so you may wish to call ClearBackground or Refresh after
+ refresh, so you may wish to call `ClearBackground` or `Refresh` after
calling this function.
- Use this function with care under GTK+ as the new appearance of the
- window might not look equally well when used with themes, i.e GTK+'s
- ability to change its look as the user wishes with run-time loadable
- modules.
+ Using this function will disable attempts to use themes for this
+ window, if the system supports them. Use with care since usually the
+ themes represent the appearance chosen by the user to be used for all
+ applications on the system.
"""
return _core_.Window_SetBackgroundColour(*args, **kwargs)
- def SetDefaultBackgroundColour(*args, **kwargs):
- """SetDefaultBackgroundColour(self, Colour colour)"""
- return _core_.Window_SetDefaultBackgroundColour(*args, **kwargs)
+ def SetOwnBackgroundColour(*args, **kwargs):
+ """SetOwnBackgroundColour(self, Colour colour)"""
+ return _core_.Window_SetOwnBackgroundColour(*args, **kwargs)
def SetForegroundColour(*args, **kwargs):
"""
"""
return _core_.Window_SetForegroundColour(*args, **kwargs)
- def SetDefaultForegroundColour(*args, **kwargs):
- """SetDefaultForegroundColour(self, Colour colour)"""
- return _core_.Window_SetDefaultForegroundColour(*args, **kwargs)
+ def SetOwnForegroundColour(*args, **kwargs):
+ """SetOwnForegroundColour(self, Colour colour)"""
+ return _core_.Window_SetOwnForegroundColour(*args, **kwargs)
def GetBackgroundColour(*args, **kwargs):
"""
"""
return _core_.Window_GetForegroundColour(*args, **kwargs)
+ def InheritsBackgroundColour(*args, **kwargs):
+ """InheritsBackgroundColour(self) -> bool"""
+ return _core_.Window_InheritsBackgroundColour(*args, **kwargs)
+
+ def UseBgCol(*args, **kwargs):
+ """UseBgCol(self) -> bool"""
+ return _core_.Window_UseBgCol(*args, **kwargs)
+
+ def SetBackgroundStyle(*args, **kwargs):
+ """
+ SetBackgroundStyle(self, int style) -> bool
+
+ Returns the background style of the window. The background style
+ indicates how the background of the window is drawn.
+
+ ====================== ========================================
+ wx.BG_STYLE_SYSTEM The background colour or pattern should
+ be determined by the system
+ wx.BG_STYLE_COLOUR The background should be a solid colour
+ wx.BG_STYLE_CUSTOM The background will be implemented by the
+ application.
+ ====================== ========================================
+
+ On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
+ a custom background, such as a tiled bitmap. Currently the style has
+ no effect on other platforms.
+
+ :see: `GetBackgroundStyle`, `SetBackgroundColour`
+ """
+ return _core_.Window_SetBackgroundStyle(*args, **kwargs)
+
+ def GetBackgroundStyle(*args, **kwargs):
+ """
+ GetBackgroundStyle(self) -> int
+
+ Returns the background style of the window.
+
+ :see: `SetBackgroundStyle`
+ """
+ return _core_.Window_GetBackgroundStyle(*args, **kwargs)
+
+ def HasTransparentBackground(*args, **kwargs):
+ """
+ HasTransparentBackground(self) -> bool
+
+ Returns True if this window's background is transparent (as, for
+ example, for `wx.StaticText`) and should show the parent window's
+ background.
+
+ This method is mostly used internally by the library itself and you
+ normally shouldn't have to call it. You may, however, have to override
+ it in your custom control classes to ensure that background is painted
+ correctly.
+ """
+ return _core_.Window_HasTransparentBackground(*args, **kwargs)
+
def SetCursor(*args, **kwargs):
"""
SetCursor(self, Cursor cursor) -> bool
"""
return _core_.Window_SetFont(*args, **kwargs)
- def SetDefaultFont(*args, **kwargs):
- """SetDefaultFont(self, Font font)"""
- return _core_.Window_SetDefaultFont(*args, **kwargs)
+ def SetOwnFont(*args, **kwargs):
+ """SetOwnFont(self, Font font)"""
+ return _core_.Window_SetOwnFont(*args, **kwargs)
def GetFont(*args, **kwargs):
"""
return _core_.Window_GetCharWidth(*args, **kwargs)
def GetTextExtent(*args, **kwargs):
- """GetTextExtent(String string) -> (width, height)"""
+ """
+ GetTextExtent(String string) -> (width, height)
+
+ Get the width and height of the text using the current font.
+ """
return _core_.Window_GetTextExtent(*args, **kwargs)
def GetFullTextExtent(*args, **kwargs):
function from your application to ensure that your UI is up-to-date at
a particular point in time (as far as your EVT_UPDATE_UI handlers are
concerned). This may be necessary if you have called
- wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
+ `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
limit the overhead that wxWindows incurs by sending update UI events
in idle time.
"""
def PopupMenuXY(*args, **kwargs):
"""
- PopupMenuXY(self, Menu menu, int x, int y) -> bool
+ PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
- Pops up the given menu at the specified coordinates, relative to this
- window, and returns control when the user has dismissed the menu. If a
- menu item is selected, the corresponding menu event is generated and
- will be processed as usual.
+ Pops up the given menu at the specified coordinates, relative to this window,
+ and returns control when the user has dismissed the menu. If a menu item is
+ selected, the corresponding menu event is generated and will be processed as
+ usual. If the default position is given then the current position of the
+ mouse cursor will be used.
"""
return _core_.Window_PopupMenuXY(*args, **kwargs)
def PopupMenu(*args, **kwargs):
"""
- PopupMenu(self, Menu menu, Point pos) -> bool
+ PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
- Pops up the given menu at the specified coordinates, relative to this
- window, and returns control when the user has dismissed the menu. If a
- menu item is selected, the corresponding menu event is generated and
- will be processed as usual.
+ Pops up the given menu at the specified coordinates, relative to this window,
+ and returns control when the user has dismissed the menu. If a menu item is
+ selected, the corresponding menu event is generated and will be processed as
+ usual. If the default position is given then the current position of the
+ mouse cursor will be used.
"""
return _core_.Window_PopupMenu(*args, **kwargs)
"""
return _core_.Window_GetHandle(*args, **kwargs)
+ def AssociateHandle(*args, **kwargs):
+ """
+ AssociateHandle(self, long handle)
+
+ Associate the window with a new native handle
+ """
+ return _core_.Window_AssociateHandle(*args, **kwargs)
+
+ def DissociateHandle(*args, **kwargs):
+ """
+ DissociateHandle(self)
+
+ Dissociate the current native handle from the window
+ """
+ return _core_.Window_DissociateHandle(*args, **kwargs)
+
def HasScrollbar(*args, **kwargs):
"""
HasScrollbar(self, int orient) -> bool
Sets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
- wxHelpProvider implementation, and not in the window object itself.
+ `wx.HelpProvider` implementation, and not in the window object itself.
"""
return _core_.Window_SetHelpText(*args, **kwargs)
Gets the help text to be used as context-sensitive help for this
window. Note that the text is actually stored by the current
- wxHelpProvider implementation, and not in the window object itself.
+ `wx.HelpProvider` implementation, and not in the window object itself.
"""
return _core_.Window_GetHelpText(*args, **kwargs)
"""
return _core_.Window_GetDropTarget(*args, **kwargs)
+ def DragAcceptFiles(*args, **kwargs):
+ """
+ DragAcceptFiles(self, bool accept)
+
+ Enables or disables eligibility for drop file events, EVT_DROP_FILES.
+ Only functional on Windows.
+ """
+ return _core_.Window_DragAcceptFiles(*args, **kwargs)
+
def SetConstraints(*args, **kwargs):
"""
SetConstraints(self, LayoutConstraints constraints)
SetAutoLayout(self, bool autoLayout)
Determines whether the Layout function will be called automatically
- when the window is resized. It is called implicitly by SetSizer but
- if you use SetConstraints you should call it manually or otherwise the
- window layout won't be correctly updated when its size changes.
+ when the window is resized. lease note that this only happens for the
+ windows usually used to contain children, namely `wx.Panel` and
+ `wx.TopLevelWindow` (and the classes deriving from them).
+
+ This method is called implicitly by `SetSizer` but if you use
+ `SetConstraints` you should call it manually or otherwise the window
+ layout won't be correctly updated when its size changes.
"""
return _core_.Window_SetAutoLayout(*args, **kwargs)
layout sizer object is already owned by the window, it will be deleted
if the deleteOld parameter is true. Note that this function will also
call SetAutoLayout implicitly with a True parameter if the sizer is
- non-NoneL and False otherwise.
+ non-None, and False otherwise.
"""
return _core_.Window_SetSizer(*args, **kwargs)
By 'intelligently' the following is meant: by default, all windows use
their own default attributes. However if some of the parent's
attributes are explicitly changed (that is, using SetFont and not
- SetDefaultFont) and if the corresponding attribute hadn't been
+ SetOwnFont) and if the corresponding attribute hadn't been
explicitly set for this window itself, then this window takes the same
value as used by the parent. In addition, if the window overrides
ShouldInheritColours to return false, the colours will not be changed
no matter what and only the font might.
- This rather complicated logic is necessary in order to accomodate the
- different usage scenarius. The most common one is when all default
+ This rather complicated logic is necessary in order to accommodate the
+ different usage scenarios. The most common one is when all default
attributes are used and in this case, nothing should be inherited as
in modern GUIs different controls use different fonts (and colours)
than their siblings so they can't inherit the same value from the
if hasattr(self, '_setCallbackInfo'):
self._setCallbackInfo(self, self.__class__)
+ def SendSizeEvent(self):
+ self.GetEventhandler().ProcessEvent(wx.SizeEvent((-1,-1)))
-class WindowPtr(Window):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Window
-_core_.Window_swigregister(WindowPtr)
+Window_swigregister = _core_.Window_swigregister
+Window_swigregister(Window)
def PreWindow(*args, **kwargs):
"""
Precreate a Window for 2-phase creation.
"""
val = _core_.new_PreWindow(*args, **kwargs)
- val.thisown = 1
return val
-def Window_NewControlId(*args, **kwargs):
- """
+def Window_NewControlId(*args):
+ """
Window_NewControlId() -> int
Generate a control id for the controls which were not given one.
"""
- return _core_.Window_NewControlId(*args, **kwargs)
+ return _core_.Window_NewControlId(*args)
def Window_NextControlId(*args, **kwargs):
- """
+ """
Window_NextControlId(int winid) -> int
Get the id of the control following the one with the given
autogenerated) id
"""
- return _core_.Window_NextControlId(*args, **kwargs)
+ return _core_.Window_NextControlId(*args, **kwargs)
def Window_PrevControlId(*args, **kwargs):
- """
+ """
Window_PrevControlId(int winid) -> int
Get the id of the control preceding the one with the given
autogenerated) id
"""
- return _core_.Window_PrevControlId(*args, **kwargs)
+ return _core_.Window_PrevControlId(*args, **kwargs)
-def Window_FindFocus(*args, **kwargs):
- """
+def Window_FindFocus(*args):
+ """
Window_FindFocus() -> Window
Returns the window or control that currently has the keyboard focus,
or None.
"""
- return _core_.Window_FindFocus(*args, **kwargs)
+ return _core_.Window_FindFocus(*args)
-def Window_GetCapture(*args, **kwargs):
- """
+def Window_GetCapture(*args):
+ """
Window_GetCapture() -> Window
Returns the window which currently captures the mouse or None
"""
- return _core_.Window_GetCapture(*args, **kwargs)
+ return _core_.Window_GetCapture(*args)
def Window_GetClassDefaultAttributes(*args, **kwargs):
- """
+ """
Window_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want
the returned font. See `wx.Window.SetWindowVariant` for more about
this.
"""
- return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
+ return _core_.Window_GetClassDefaultAttributes(*args, **kwargs)
def DLG_PNT(win, point_or_x, y=None):
"""
def FindWindowById(*args, **kwargs):
- """
+ """
FindWindowById(long id, Window parent=None) -> Window
Find the first window in the application with the given id. If parent
boxes; if non-None, the search will be limited to the given window
hierarchy. The search is recursive in both cases.
"""
- return _core_.FindWindowById(*args, **kwargs)
+ return _core_.FindWindowById(*args, **kwargs)
def FindWindowByName(*args, **kwargs):
- """
+ """
FindWindowByName(String name, Window parent=None) -> Window
Find a window by its name (as given in a window constructor or Create
If no window with such name is found, wx.FindWindowByLabel is called.
"""
- return _core_.FindWindowByName(*args, **kwargs)
+ return _core_.FindWindowByName(*args, **kwargs)
def FindWindowByLabel(*args, **kwargs):
- """
+ """
FindWindowByLabel(String label, Window parent=None) -> Window
Find a window by its label. Depending on the type of window, the label
non-None, the search will be limited to the given window
hierarchy. The search is recursive in both cases.
"""
- return _core_.FindWindowByLabel(*args, **kwargs)
+ return _core_.FindWindowByLabel(*args, **kwargs)
def Window_FromHWND(*args, **kwargs):
- """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
- return _core_.Window_FromHWND(*args, **kwargs)
+ """Window_FromHWND(Window parent, unsigned long _hWnd) -> Window"""
+ return _core_.Window_FromHWND(*args, **kwargs)
+
+def GetTopLevelWindows(*args):
+ """
+ GetTopLevelWindows() -> PyObject
+
+ Returns a list of the the application's top-level windows, (frames,
+ dialogs, etc.) NOTE: Currently this is a copy of the list maintained
+ by wxWidgets, and so it is only valid as long as no top-level windows
+ are closed or new top-level windows are created.
+
+ """
+ return _core_.GetTopLevelWindows(*args)
#---------------------------------------------------------------------------
class Validator(EvtHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ Validator class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> Validator"""
- newobj = _core_.new_Validator(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.Validator_swiginit(self,_core_.new_Validator(*args, **kwargs))
self._setOORInfo(self)
def Clone(*args, **kwargs):
return _core_.Validator_SetBellOnError(*args, **kwargs)
SetBellOnError = staticmethod(SetBellOnError)
+Validator_swigregister = _core_.Validator_swigregister
+Validator_swigregister(Validator)
-class ValidatorPtr(Validator):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Validator
-_core_.Validator_swigregister(ValidatorPtr)
-
-def Validator_IsSilent(*args, **kwargs):
- """Validator_IsSilent() -> bool"""
- return _core_.Validator_IsSilent(*args, **kwargs)
+def Validator_IsSilent(*args):
+ """Validator_IsSilent() -> bool"""
+ return _core_.Validator_IsSilent(*args)
def Validator_SetBellOnError(*args, **kwargs):
- """Validator_SetBellOnError(int doIt=True)"""
- return _core_.Validator_SetBellOnError(*args, **kwargs)
+ """Validator_SetBellOnError(int doIt=True)"""
+ return _core_.Validator_SetBellOnError(*args, **kwargs)
class PyValidator(Validator):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPyValidator instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ PyValidator class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> PyValidator"""
- newobj = _core_.new_PyValidator(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.PyValidator_swiginit(self,_core_.new_PyValidator(*args, **kwargs))
self._setCallbackInfo(self, PyValidator, 1)
self._setOORInfo(self)
"""_setCallbackInfo(self, PyObject self, PyObject _class, int incref=True)"""
return _core_.PyValidator__setCallbackInfo(*args, **kwargs)
-
-class PyValidatorPtr(PyValidator):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PyValidator
-_core_.PyValidator_swigregister(PyValidatorPtr)
+PyValidator_swigregister = _core_.PyValidator_swigregister
+PyValidator_swigregister(PyValidator)
#---------------------------------------------------------------------------
class Menu(EvtHandler):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMenu instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ Menu class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self, String title=EmptyString, long style=0) -> Menu"""
- newobj = _core_.new_Menu(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.Menu_swiginit(self,_core_.new_Menu(*args, **kwargs))
self._setOORInfo(self)
def Append(*args, **kwargs):
"""AppendItem(self, MenuItem item) -> MenuItem"""
return _core_.Menu_AppendItem(*args, **kwargs)
- def Break(*args, **kwargs):
- """Break(self)"""
- return _core_.Menu_Break(*args, **kwargs)
-
def InsertItem(*args, **kwargs):
"""InsertItem(self, size_t pos, MenuItem item) -> MenuItem"""
return _core_.Menu_InsertItem(*args, **kwargs)
+ def PrependItem(*args, **kwargs):
+ """PrependItem(self, MenuItem item) -> MenuItem"""
+ return _core_.Menu_PrependItem(*args, **kwargs)
+
+ def Break(*args, **kwargs):
+ """Break(self)"""
+ return _core_.Menu_Break(*args, **kwargs)
+
def Insert(*args, **kwargs):
"""
Insert(self, size_t pos, int id, String text, String help=EmptyString,
"""InsertMenu(self, size_t pos, int id, String text, Menu submenu, String help=EmptyString) -> MenuItem"""
return _core_.Menu_InsertMenu(*args, **kwargs)
- def PrependItem(*args, **kwargs):
- """PrependItem(self, MenuItem item) -> MenuItem"""
- return _core_.Menu_PrependItem(*args, **kwargs)
-
def Prepend(*args, **kwargs):
"""Prepend(self, int id, String text, String help=EmptyString, int kind=ITEM_NORMAL) -> MenuItem"""
return _core_.Menu_Prepend(*args, **kwargs)
Deletes the C++ object this Python object is a proxy for.
"""
- return _core_.Menu_Destroy(*args, **kwargs)
+ val = _core_.Menu_Destroy(*args, **kwargs)
+ args[0].thisown = 0
+ return val
def DestroyId(*args, **kwargs):
"""
Deletes the C++ object this Python object is a proxy for.
"""
- return _core_.Menu_DestroyId(*args, **kwargs)
+ val = _core_.Menu_DestroyId(*args, **kwargs)
+ args[0].thisown = 0
+ return val
def DestroyItem(*args, **kwargs):
"""
Deletes the C++ object this Python object is a proxy for.
"""
- return _core_.Menu_DestroyItem(*args, **kwargs)
+ val = _core_.Menu_DestroyItem(*args, **kwargs)
+ args[0].thisown = 0
+ return val
def GetMenuItemCount(*args, **kwargs):
"""GetMenuItemCount(self) -> size_t"""
"""GetParent(self) -> Menu"""
return _core_.Menu_GetParent(*args, **kwargs)
-
-class MenuPtr(Menu):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Menu
-_core_.Menu_swigregister(MenuPtr)
+Menu_swigregister = _core_.Menu_swigregister
+Menu_swigregister(Menu)
DefaultValidator = cvar.DefaultValidator
#---------------------------------------------------------------------------
class MenuBar(Window):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMenuBar instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ MenuBar class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""__init__(self, long style=0) -> MenuBar"""
- newobj = _core_.new_MenuBar(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.MenuBar_swiginit(self,_core_.new_MenuBar(*args, **kwargs))
self._setOORInfo(self)
def Append(*args, **kwargs):
"""Detach(self)"""
return _core_.MenuBar_Detach(*args, **kwargs)
+ def SetAutoWindowMenu(*args, **kwargs):
+ """SetAutoWindowMenu(bool enable)"""
+ return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
+
+ SetAutoWindowMenu = staticmethod(SetAutoWindowMenu)
+ def GetAutoWindowMenu(*args, **kwargs):
+ """GetAutoWindowMenu() -> bool"""
+ return _core_.MenuBar_GetAutoWindowMenu(*args, **kwargs)
+
+ GetAutoWindowMenu = staticmethod(GetAutoWindowMenu)
+MenuBar_swigregister = _core_.MenuBar_swigregister
+MenuBar_swigregister(MenuBar)
+
+def MenuBar_SetAutoWindowMenu(*args, **kwargs):
+ """MenuBar_SetAutoWindowMenu(bool enable)"""
+ return _core_.MenuBar_SetAutoWindowMenu(*args, **kwargs)
-class MenuBarPtr(MenuBar):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MenuBar
-_core_.MenuBar_swigregister(MenuBarPtr)
+def MenuBar_GetAutoWindowMenu(*args):
+ """MenuBar_GetAutoWindowMenu() -> bool"""
+ return _core_.MenuBar_GetAutoWindowMenu(*args)
#---------------------------------------------------------------------------
class MenuItem(Object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxMenuItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ """Proxy of C++ MenuItem class"""
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
__init__(self, Menu parentMenu=None, int id=ID_ANY, String text=EmptyString,
String help=EmptyString, int kind=ITEM_NORMAL,
Menu subMenu=None) -> MenuItem
"""
- newobj = _core_.new_MenuItem(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.MenuItem_swiginit(self,_core_.new_MenuItem(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_MenuItem
+ __del__ = lambda self : None;
def GetMenu(*args, **kwargs):
"""GetMenu(self) -> Menu"""
return _core_.MenuItem_GetMenu(*args, **kwargs)
"""SetAccel(self, AcceleratorEntry accel)"""
return _core_.MenuItem_SetAccel(*args, **kwargs)
- def GetDefaultMarginWidth(*args, **kwargs):
- """GetDefaultMarginWidth() -> int"""
- return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
-
- GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
def SetBitmap(*args, **kwargs):
"""SetBitmap(self, Bitmap bitmap)"""
return _core_.MenuItem_SetBitmap(*args, **kwargs)
"""GetBitmap(self) -> Bitmap"""
return _core_.MenuItem_GetBitmap(*args, **kwargs)
+ def SetFont(*args, **kwargs):
+ """SetFont(self, Font font)"""
+ return _core_.MenuItem_SetFont(*args, **kwargs)
+
+ def GetFont(*args, **kwargs):
+ """GetFont(self) -> Font"""
+ return _core_.MenuItem_GetFont(*args, **kwargs)
+
+ def SetTextColour(*args, **kwargs):
+ """SetTextColour(self, Colour colText)"""
+ return _core_.MenuItem_SetTextColour(*args, **kwargs)
+
+ def GetTextColour(*args, **kwargs):
+ """GetTextColour(self) -> Colour"""
+ return _core_.MenuItem_GetTextColour(*args, **kwargs)
+
+ def SetBackgroundColour(*args, **kwargs):
+ """SetBackgroundColour(self, Colour colBack)"""
+ return _core_.MenuItem_SetBackgroundColour(*args, **kwargs)
+
+ def GetBackgroundColour(*args, **kwargs):
+ """GetBackgroundColour(self) -> Colour"""
+ return _core_.MenuItem_GetBackgroundColour(*args, **kwargs)
+
+ def SetBitmaps(*args, **kwargs):
+ """SetBitmaps(self, Bitmap bmpChecked, Bitmap bmpUnchecked=wxNullBitmap)"""
+ return _core_.MenuItem_SetBitmaps(*args, **kwargs)
+
+ def SetDisabledBitmap(*args, **kwargs):
+ """SetDisabledBitmap(self, Bitmap bmpDisabled)"""
+ return _core_.MenuItem_SetDisabledBitmap(*args, **kwargs)
+
+ def GetDisabledBitmap(*args, **kwargs):
+ """GetDisabledBitmap(self) -> Bitmap"""
+ return _core_.MenuItem_GetDisabledBitmap(*args, **kwargs)
+
+ def SetMarginWidth(*args, **kwargs):
+ """SetMarginWidth(self, int nWidth)"""
+ return _core_.MenuItem_SetMarginWidth(*args, **kwargs)
+
+ def GetMarginWidth(*args, **kwargs):
+ """GetMarginWidth(self) -> int"""
+ return _core_.MenuItem_GetMarginWidth(*args, **kwargs)
+
+ def GetDefaultMarginWidth(*args, **kwargs):
+ """GetDefaultMarginWidth() -> int"""
+ return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
+
+ GetDefaultMarginWidth = staticmethod(GetDefaultMarginWidth)
+ def IsOwnerDrawn(*args, **kwargs):
+ """IsOwnerDrawn(self) -> bool"""
+ return _core_.MenuItem_IsOwnerDrawn(*args, **kwargs)
+
+ def SetOwnerDrawn(*args, **kwargs):
+ """SetOwnerDrawn(self, bool ownerDrawn=True)"""
+ return _core_.MenuItem_SetOwnerDrawn(*args, **kwargs)
-class MenuItemPtr(MenuItem):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = MenuItem
-_core_.MenuItem_swigregister(MenuItemPtr)
+ def ResetOwnerDrawn(*args, **kwargs):
+ """ResetOwnerDrawn(self)"""
+ return _core_.MenuItem_ResetOwnerDrawn(*args, **kwargs)
+
+MenuItem_swigregister = _core_.MenuItem_swigregister
+MenuItem_swigregister(MenuItem)
def MenuItem_GetLabelFromText(*args, **kwargs):
- """MenuItem_GetLabelFromText(String text) -> String"""
- return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
+ """MenuItem_GetLabelFromText(String text) -> String"""
+ return _core_.MenuItem_GetLabelFromText(*args, **kwargs)
-def MenuItem_GetDefaultMarginWidth(*args, **kwargs):
- """MenuItem_GetDefaultMarginWidth() -> int"""
- return _core_.MenuItem_GetDefaultMarginWidth(*args, **kwargs)
+def MenuItem_GetDefaultMarginWidth(*args):
+ """MenuItem_GetDefaultMarginWidth() -> int"""
+ return _core_.MenuItem_GetDefaultMarginWidth(*args)
#---------------------------------------------------------------------------
A control is generally a small window which processes user input
and/or displays one or more item of data.
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxControl instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
"""
- __init__(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ __init__(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> Control
Create a Control. Normally you should only call this from a subclass'
__init__ as a plain old wx.Control is not very useful.
"""
- newobj = _core_.new_Control(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.Control_swiginit(self,_core_.new_Control(*args, **kwargs))
self._setOORInfo(self)
def Create(*args, **kwargs):
"""
- Create(self, Window parent, int id, Point pos=DefaultPosition, Size size=DefaultSize,
- long style=0, Validator validator=DefaultValidator,
+ Create(self, Window parent, int id=-1, Point pos=DefaultPosition,
+ Size size=DefaultSize, long style=0, Validator validator=DefaultValidator,
String name=ControlNameStr) -> bool
Do the 2nd phase and create the GUI control.
"""
return _core_.Control_GetLabel(*args, **kwargs)
- def SetLabel(*args, **kwargs):
- """
- SetLabel(self, String label)
-
- Sets the item's text.
- """
- return _core_.Control_SetLabel(*args, **kwargs)
-
def GetClassDefaultAttributes(*args, **kwargs):
"""
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes = staticmethod(GetClassDefaultAttributes)
-
-class ControlPtr(Control):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Control
-_core_.Control_swigregister(ControlPtr)
+Control_swigregister = _core_.Control_swigregister
+Control_swigregister(Control)
ControlNameStr = cvar.ControlNameStr
def PreControl(*args, **kwargs):
Precreate a Control control for 2-phase creation
"""
val = _core_.new_PreControl(*args, **kwargs)
- val.thisown = 1
return val
def Control_GetClassDefaultAttributes(*args, **kwargs):
- """
+ """
Control_GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes
Get the default attributes for this class. This is useful if you want
the returned font. See `wx.Window.SetWindowVariant` for more about
this.
"""
- return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
+ return _core_.Control_GetClassDefaultAttributes(*args, **kwargs)
#---------------------------------------------------------------------------
class ItemContainer(object):
"""
- wx.ItemContainer defines an interface which is implemented by all
- controls which have string subitems, each of which may be selected,
- such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well as
- `wx.ComboBox` which implements an extended interface deriving from
+ The wx.ItemContainer class defines an interface which is implemented
+ by all controls which have string subitems, each of which may be
+ selected, such as `wx.ListBox`, `wx.CheckListBox`, `wx.Choice` as well
+ as `wx.ComboBox` which implements an extended interface deriving from
this one.
It defines the methods for accessing the control's items and although
optionally, client data associated with them.
"""
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxItemContainer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
def Append(*args, **kwargs):
"""
Append(self, String item, PyObject clientData=None) -> int
def AppendItems(*args, **kwargs):
"""
- AppendItems(self, wxArrayString strings)
+ AppendItems(self, List strings)
Apend several items at once to the control. Notice that calling this
method may be much faster than appending the items one by one if you
def Insert(*args, **kwargs):
"""
- Insert(self, String item, int pos, PyObject clientData=None) -> int
+ Insert(self, String item, unsigned int pos, PyObject clientData=None) -> int
Insert an item into the control before the item at the ``pos`` index,
optionally associating some data object with the item.
def Delete(*args, **kwargs):
"""
- Delete(self, int n)
+ Delete(self, unsigned int n)
Deletes the item at the zero-based index 'n' from the control. Note
that it is an error (signalled by a `wx.PyAssertionError` exception if
"""
return _core_.ItemContainer_Delete(*args, **kwargs)
+ def GetClientData(*args, **kwargs):
+ """
+ GetClientData(self, unsigned int n) -> PyObject
+
+ Returns the client data associated with the given item, (if any.)
+ """
+ return _core_.ItemContainer_GetClientData(*args, **kwargs)
+
+ def SetClientData(*args, **kwargs):
+ """
+ SetClientData(self, unsigned int n, PyObject clientData)
+
+ Associate the given client data with the item at position n.
+ """
+ return _core_.ItemContainer_SetClientData(*args, **kwargs)
+
def GetCount(*args, **kwargs):
"""
- GetCount(self) -> int
+ GetCount(self) -> unsigned int
Returns the number of items in the control.
"""
def GetString(*args, **kwargs):
"""
- GetString(self, int n) -> String
+ GetString(self, unsigned int n) -> String
Returns the label of the item with the given index.
"""
def SetString(*args, **kwargs):
"""
- SetString(self, int n, String s)
+ SetString(self, unsigned int n, String s)
Sets the label for the given item.
"""
"""
return _core_.ItemContainer_FindString(*args, **kwargs)
- def Select(*args, **kwargs):
+ def SetSelection(*args, **kwargs):
"""
- Select(self, int n)
+ SetSelection(self, int n)
Sets the item at index 'n' to be the selected item.
"""
- return _core_.ItemContainer_Select(*args, **kwargs)
+ return _core_.ItemContainer_SetSelection(*args, **kwargs)
- SetSelection = Select
def GetSelection(*args, **kwargs):
"""
GetSelection(self) -> int
"""
return _core_.ItemContainer_GetSelection(*args, **kwargs)
+ def SetStringSelection(*args, **kwargs):
+ """SetStringSelection(self, String s) -> bool"""
+ return _core_.ItemContainer_SetStringSelection(*args, **kwargs)
+
def GetStringSelection(*args, **kwargs):
"""
GetStringSelection(self) -> String
"""
return _core_.ItemContainer_GetStringSelection(*args, **kwargs)
- def GetClientData(*args, **kwargs):
- """
- GetClientData(self, int n) -> PyObject
-
- Returns the client data associated with the given item, (if any.)
- """
- return _core_.ItemContainer_GetClientData(*args, **kwargs)
-
- def SetClientData(*args, **kwargs):
+ def Select(*args, **kwargs):
"""
- SetClientData(self, int n, PyObject clientData)
+ Select(self, int n)
- Associate the given client data with the item at position n.
+ This is the same as `SetSelection` and exists only because it is
+ slightly more natural for controls which support multiple selection.
"""
- return _core_.ItemContainer_SetClientData(*args, **kwargs)
-
+ return _core_.ItemContainer_Select(*args, **kwargs)
-class ItemContainerPtr(ItemContainer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ItemContainer
-_core_.ItemContainer_swigregister(ItemContainerPtr)
+ItemContainer_swigregister = _core_.ItemContainer_swigregister
+ItemContainer_swigregister(ItemContainer)
#---------------------------------------------------------------------------
wx.Control class, and is used for the base class of various controls
that have items.
"""
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxControlWithItems instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
-
-class ControlWithItemsPtr(ControlWithItems):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = ControlWithItems
-_core_.ControlWithItems_swigregister(ControlWithItemsPtr)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
+ControlWithItems_swigregister = _core_.ControlWithItems_swigregister
+ControlWithItems_swigregister(ControlWithItems)
#---------------------------------------------------------------------------
class SizerItem(Object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> SizerItem"""
- newobj = _core_.new_SizerItem(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ The wx.SizerItem class is used to track the position, size and other
+ attributes of each item managed by a `wx.Sizer`. In normal usage user
+ code should never need to deal directly with a wx.SizerItem, but
+ custom classes derived from `wx.PySizer` will probably need to use the
+ collection of wx.SizerItems held by wx.Sizer when calculating layout.
+
+ :see: `wx.Sizer`, `wx.GBSizerItem`
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> SizerItem
+
+ Constructs an empty wx.SizerItem. Either a window, sizer or spacer
+ size will need to be set before this item can be used in a Sizer.
+
+ You will probably never need to create a wx.SizerItem directly as they
+ are created automatically when the sizer's Add, Insert or Prepend
+ methods are called.
+
+ :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`
+ """
+ _core_.SizerItem_swiginit(self,_core_.new_SizerItem(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_SizerItem
+ __del__ = lambda self : None;
def DeleteWindows(*args, **kwargs):
- """DeleteWindows(self)"""
+ """
+ DeleteWindows(self)
+
+ Destroy the window or the windows in a subsizer, depending on the type
+ of item.
+ """
return _core_.SizerItem_DeleteWindows(*args, **kwargs)
def DetachSizer(*args, **kwargs):
- """DetachSizer(self)"""
+ """
+ DetachSizer(self)
+
+ Enable deleting the SizerItem without destroying the contained sizer.
+ """
return _core_.SizerItem_DetachSizer(*args, **kwargs)
def GetSize(*args, **kwargs):
- """GetSize(self) -> Size"""
+ """
+ GetSize(self) -> Size
+
+ Get the current size of the item, as set in the last Layout.
+ """
return _core_.SizerItem_GetSize(*args, **kwargs)
def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
+ """
+ CalcMin(self) -> Size
+
+ Calculates the minimum desired size for the item, including any space
+ needed by borders.
+ """
return _core_.SizerItem_CalcMin(*args, **kwargs)
def SetDimension(*args, **kwargs):
- """SetDimension(self, Point pos, Size size)"""
+ """
+ SetDimension(self, Point pos, Size size)
+
+ Set the position and size of the space allocated for this item by the
+ sizer, and adjust the position and size of the item (window or
+ subsizer) to be within that space taking alignment and borders into
+ account.
+ """
return _core_.SizerItem_SetDimension(*args, **kwargs)
def GetMinSize(*args, **kwargs):
- """GetMinSize(self) -> Size"""
+ """
+ GetMinSize(self) -> Size
+
+ Get the minimum size needed for the item.
+ """
return _core_.SizerItem_GetMinSize(*args, **kwargs)
+ def GetMinSizeWithBorder(*args, **kwargs):
+ """
+ GetMinSizeWithBorder(self) -> Size
+
+ Get the minimum size needed for the item with space for the borders
+ added, if needed.
+ """
+ return _core_.SizerItem_GetMinSizeWithBorder(*args, **kwargs)
+
def SetInitSize(*args, **kwargs):
"""SetInitSize(self, int x, int y)"""
return _core_.SizerItem_SetInitSize(*args, **kwargs)
def SetRatioWH(*args, **kwargs):
- """SetRatioWH(self, int width, int height)"""
+ """
+ SetRatioWH(self, int width, int height)
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_SetRatioWH(*args, **kwargs)
def SetRatioSize(*args, **kwargs):
- """SetRatioSize(self, Size size)"""
+ """
+ SetRatioSize(self, Size size)
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_SetRatioSize(*args, **kwargs)
def SetRatio(*args, **kwargs):
- """SetRatio(self, float ratio)"""
+ """
+ SetRatio(self, float ratio)
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_SetRatio(*args, **kwargs)
def GetRatio(*args, **kwargs):
- """GetRatio(self) -> float"""
+ """
+ GetRatio(self) -> float
+
+ Set the ratio item attribute.
+ """
return _core_.SizerItem_GetRatio(*args, **kwargs)
+ def GetRect(*args, **kwargs):
+ """
+ GetRect(self) -> Rect
+
+ Returns the rectangle that the sizer item should occupy
+ """
+ return _core_.SizerItem_GetRect(*args, **kwargs)
+
def IsWindow(*args, **kwargs):
- """IsWindow(self) -> bool"""
+ """
+ IsWindow(self) -> bool
+
+ Is this sizer item a window?
+ """
return _core_.SizerItem_IsWindow(*args, **kwargs)
def IsSizer(*args, **kwargs):
- """IsSizer(self) -> bool"""
+ """
+ IsSizer(self) -> bool
+
+ Is this sizer item a subsizer?
+ """
return _core_.SizerItem_IsSizer(*args, **kwargs)
def IsSpacer(*args, **kwargs):
- """IsSpacer(self) -> bool"""
+ """
+ IsSpacer(self) -> bool
+
+ Is this sizer item a spacer?
+ """
return _core_.SizerItem_IsSpacer(*args, **kwargs)
def SetProportion(*args, **kwargs):
- """SetProportion(self, int proportion)"""
+ """
+ SetProportion(self, int proportion)
+
+ Set the proportion value for this item.
+ """
return _core_.SizerItem_SetProportion(*args, **kwargs)
def GetProportion(*args, **kwargs):
- """GetProportion(self) -> int"""
+ """
+ GetProportion(self) -> int
+
+ Get the proportion value for this item.
+ """
return _core_.SizerItem_GetProportion(*args, **kwargs)
- SetOption = SetProportion
- GetOption = GetProportion
+ SetOption = wx._deprecated(SetProportion, "Please use `SetProportion` instead.")
+ GetOption = wx._deprecated(GetProportion, "Please use `GetProportion` instead.")
def SetFlag(*args, **kwargs):
- """SetFlag(self, int flag)"""
+ """
+ SetFlag(self, int flag)
+
+ Set the flag value for this item.
+ """
return _core_.SizerItem_SetFlag(*args, **kwargs)
def GetFlag(*args, **kwargs):
- """GetFlag(self) -> int"""
+ """
+ GetFlag(self) -> int
+
+ Get the flag value for this item.
+ """
return _core_.SizerItem_GetFlag(*args, **kwargs)
def SetBorder(*args, **kwargs):
- """SetBorder(self, int border)"""
+ """
+ SetBorder(self, int border)
+
+ Set the border value for this item.
+ """
return _core_.SizerItem_SetBorder(*args, **kwargs)
def GetBorder(*args, **kwargs):
- """GetBorder(self) -> int"""
+ """
+ GetBorder(self) -> int
+
+ Get the border value for this item.
+ """
return _core_.SizerItem_GetBorder(*args, **kwargs)
def GetWindow(*args, **kwargs):
- """GetWindow(self) -> Window"""
+ """
+ GetWindow(self) -> Window
+
+ Get the window (if any) that is managed by this sizer item.
+ """
return _core_.SizerItem_GetWindow(*args, **kwargs)
def SetWindow(*args, **kwargs):
- """SetWindow(self, Window window)"""
+ """
+ SetWindow(self, Window window)
+
+ Set the window to be managed by this sizer item.
+ """
return _core_.SizerItem_SetWindow(*args, **kwargs)
def GetSizer(*args, **kwargs):
- """GetSizer(self) -> Sizer"""
+ """
+ GetSizer(self) -> Sizer
+
+ Get the subsizer (if any) that is managed by this sizer item.
+ """
return _core_.SizerItem_GetSizer(*args, **kwargs)
def SetSizer(*args, **kwargs):
- """SetSizer(self, Sizer sizer)"""
+ """
+ SetSizer(self, Sizer sizer)
+
+ Set the subsizer to be managed by this sizer item.
+ """
return _core_.SizerItem_SetSizer(*args, **kwargs)
def GetSpacer(*args, **kwargs):
- """GetSpacer(self) -> Size"""
+ """
+ GetSpacer(self) -> Size
+
+ Get the size of the spacer managed by this sizer item.
+ """
return _core_.SizerItem_GetSpacer(*args, **kwargs)
def SetSpacer(*args, **kwargs):
- """SetSpacer(self, Size size)"""
+ """
+ SetSpacer(self, Size size)
+
+ Set the size of the spacer to be managed by this sizer item.
+ """
return _core_.SizerItem_SetSpacer(*args, **kwargs)
def Show(*args, **kwargs):
- """Show(self, bool show)"""
+ """
+ Show(self, bool show)
+
+ Set the show item attribute, which sizers use to determine if the item
+ is to be made part of the layout or not. If the item is tracking a
+ window then it is shown or hidden as needed.
+ """
return _core_.SizerItem_Show(*args, **kwargs)
def IsShown(*args, **kwargs):
- """IsShown(self) -> bool"""
+ """
+ IsShown(self) -> bool
+
+ Is the item to be shown in the layout?
+ """
return _core_.SizerItem_IsShown(*args, **kwargs)
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the current position of the item, as set in the last Layout.
+ """
return _core_.SizerItem_GetPosition(*args, **kwargs)
def GetUserData(*args, **kwargs):
- """GetUserData(self) -> PyObject"""
+ """
+ GetUserData(self) -> PyObject
+
+ Returns the userData associated with this sizer item, or None if there
+ isn't any.
+ """
return _core_.SizerItem_GetUserData(*args, **kwargs)
+ def SetUserData(*args, **kwargs):
+ """
+ SetUserData(self, PyObject userData)
-class SizerItemPtr(SizerItem):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = SizerItem
-_core_.SizerItem_swigregister(SizerItemPtr)
+ Associate a Python object with this sizer item.
+ """
+ return _core_.SizerItem_SetUserData(*args, **kwargs)
-def SizerItemSpacer(*args, **kwargs):
- """
- SizerItemSpacer(int width, int height, int proportion, int flag, int border,
- Object userData) -> SizerItem
- """
- val = _core_.new_SizerItemSpacer(*args, **kwargs)
- val.thisown = 1
- return val
+SizerItem_swigregister = _core_.SizerItem_swigregister
+SizerItem_swigregister(SizerItem)
def SizerItemWindow(*args, **kwargs):
"""
SizerItemWindow(Window window, int proportion, int flag, int border,
- Object userData) -> SizerItem
+ PyObject userData=None) -> SizerItem
+
+ Constructs a `wx.SizerItem` for tracking a window.
"""
val = _core_.new_SizerItemWindow(*args, **kwargs)
- val.thisown = 1
+ return val
+
+def SizerItemSpacer(*args, **kwargs):
+ """
+ SizerItemSpacer(int width, int height, int proportion, int flag, int border,
+ PyObject userData=None) -> SizerItem
+
+ Constructs a `wx.SizerItem` for tracking a spacer.
+ """
+ val = _core_.new_SizerItemSpacer(*args, **kwargs)
return val
def SizerItemSizer(*args, **kwargs):
"""
SizerItemSizer(Sizer sizer, int proportion, int flag, int border,
- Object userData) -> SizerItem
+ PyObject userData=None) -> SizerItem
+
+ Constructs a `wx.SizerItem` for tracking a subsizer
"""
val = _core_.new_SizerItemSizer(*args, **kwargs)
- val.thisown = 1
return val
class Sizer(Object):
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ """
+ wx.Sizer is the abstract base class used for laying out subwindows in
+ a window. You cannot use wx.Sizer directly; instead, you will have to
+ use one of the sizer classes derived from it such as `wx.BoxSizer`,
+ `wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`, `wx.FlexGridSizer`
+ and `wx.GridBagSizer`.
+
+ The concept implemented by sizers in wxWidgets is closely related to
+ layout tools in other GUI toolkits, such as Java's AWT, the GTK
+ toolkit or the Qt toolkit. It is based upon the idea of the individual
+ subwindows reporting their minimal required size and their ability to
+ get stretched if the size of the parent window has changed. This will
+ most often mean that the programmer does not set the original size of
+ a dialog in the beginning, rather the dialog will assigned a sizer and
+ this sizer will be queried about the recommended size. The sizer in
+ turn will query its children, which can be normal windows or contorls,
+ empty space or other sizers, so that a hierarchy of sizers can be
+ constructed. Note that wxSizer does not derive from wxWindow and thus
+ do not interfere with tab ordering and requires very little resources
+ compared to a real window on screen.
+
+ What makes sizers so well fitted for use in wxWidgets is the fact that
+ every control reports its own minimal size and the algorithm can
+ handle differences in font sizes or different window (dialog item)
+ sizes on different platforms without problems. If for example the
+ standard font as well as the overall design of Mac widgets requires
+ more space than on Windows, then the initial size of a dialog using a
+ sizer will automatically be bigger on Mac than on Windows.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
+ __swig_destroy__ = _core_.delete_Sizer
+ __del__ = lambda self : None;
def _setOORInfo(*args, **kwargs):
"""_setOORInfo(self, PyObject _self)"""
return _core_.Sizer__setOORInfo(*args, **kwargs)
def Add(*args, **kwargs):
"""
- Add(self, PyObject item, int proportion=0, int flag=0, int border=0,
- PyObject userData=None)
+ Add(self, item, int proportion=0, int flag=0, int border=0,
+ PyObject userData=None) -> wx.SizerItem
+
+ Appends a child item to the sizer.
"""
return _core_.Sizer_Add(*args, **kwargs)
def Insert(*args, **kwargs):
"""
- Insert(self, int before, PyObject item, int proportion=0, int flag=0,
- int border=0, PyObject userData=None)
+ Insert(self, int before, item, int proportion=0, int flag=0, int border=0,
+ PyObject userData=None) -> wx.SizerItem
+
+ Inserts a new item into the list of items managed by this sizer before
+ the item at index *before*. See `Add` for a description of the parameters.
"""
return _core_.Sizer_Insert(*args, **kwargs)
def Prepend(*args, **kwargs):
"""
- Prepend(self, PyObject item, int proportion=0, int flag=0, int border=0,
- PyObject userData=None)
+ Prepend(self, item, int proportion=0, int flag=0, int border=0,
+ PyObject userData=None) -> wx.SizerItem
+
+ Adds a new item to the begining of the list of sizer items managed by
+ this sizer. See `Add` for a description of the parameters.
"""
return _core_.Sizer_Prepend(*args, **kwargs)
def Remove(*args, **kwargs):
- """Remove(self, PyObject item) -> bool"""
+ """
+ Remove(self, item) -> bool
+
+ Removes an item from the sizer and destroys it. This method does not
+ cause any layout or resizing to take place, call `Layout` to update
+ the layout on screen after removing a child from the sizer. The
+ *item* parameter can be either a window, a sizer, or the zero-based
+ index of an item to remove. Returns True if the child item was found
+ and removed.
+ """
return _core_.Sizer_Remove(*args, **kwargs)
def Detach(*args, **kwargs):
- """Detach(self, PyObject item) -> bool"""
+ """
+ Detach(self, item) -> bool
+
+ Detaches an item from the sizer without destroying it. This method
+ does not cause any layout or resizing to take place, call `Layout` to
+ do so. The *item* parameter can be either a window, a sizer, or the
+ zero-based index of the item to be detached. Returns True if the child item
+ was found and detached.
+ """
return _core_.Sizer_Detach(*args, **kwargs)
+ def GetItem(*args, **kwargs):
+ """
+ GetItem(self, item) -> wx.SizerItem
+
+ Returns the `wx.SizerItem` which holds the *item* given. The *item*
+ parameter can be either a window, a sizer, or the zero-based index of
+ the item to be found.
+ """
+ return _core_.Sizer_GetItem(*args, **kwargs)
+
def _SetItemMinSize(*args, **kwargs):
"""_SetItemMinSize(self, PyObject item, Size size)"""
return _core_.Sizer__SetItemMinSize(*args, **kwargs)
+ def SetItemMinSize(self, item, *args):
+ """
+ SetItemMinSize(self, item, Size size)
+
+ Sets the minimum size that will be allocated for an item in the sizer.
+ The *item* parameter can be either a window, a sizer, or the
+ zero-based index of the item. If a window or sizer is given then it
+ will be searched for recursivly in subsizers if neccessary.
+ """
+ if len(args) == 2:
+ # for backward compatibility accept separate width,height args too
+ return self._SetItemMinSize(item, args)
+ else:
+ return self._SetItemMinSize(item, args[0])
+
def AddItem(*args, **kwargs):
- """AddItem(self, SizerItem item)"""
+ """
+ AddItem(self, SizerItem item)
+
+ Adds a `wx.SizerItem` to the sizer.
+ """
return _core_.Sizer_AddItem(*args, **kwargs)
def InsertItem(*args, **kwargs):
- """InsertItem(self, size_t index, SizerItem item)"""
+ """
+ InsertItem(self, int index, SizerItem item)
+
+ Inserts a `wx.SizerItem` to the sizer at the position given by *index*.
+ """
return _core_.Sizer_InsertItem(*args, **kwargs)
def PrependItem(*args, **kwargs):
- """PrependItem(self, SizerItem item)"""
+ """
+ PrependItem(self, SizerItem item)
+
+ Prepends a `wx.SizerItem` to the sizer.
+ """
return _core_.Sizer_PrependItem(*args, **kwargs)
- def AddMany(self, widgets):
+ def AddMany(self, items):
"""
AddMany is a convenience method for adding several items
to a sizer at one time. Simply pass it a list of tuples,
where each tuple consists of the parameters that you
would normally pass to the `Add` method.
"""
- for childinfo in widgets:
- if type(childinfo) != type(()) or (len(childinfo) == 2 and type(childinfo[0]) == type(1)):
- childinfo = (childinfo, )
- self.Add(*childinfo)
+ for item in items:
+ if type(item) != type(()) or (len(item) == 2 and type(item[0]) == type(1)):
+ item = (item, )
+ self.Add(*item)
# for backwards compatibility only, please do not use in new code
- AddWindow = wx._deprecated(Add, "AddWindow is deprecated, use `Add` instead.")
- AddSizer = wx._deprecated(Add, "AddSizer is deprecated, use `Add` instead.")
- AddSpacer = wx._deprecated(Add, "AddSpacer is deprecated, use `Add` instead.")
- PrependWindow = wx._deprecated(Prepend, "PrependWindow is deprecated, use `Prepend` instead.")
- PrependSizer = wx._deprecated(Prepend, "PrependSizer is deprecated, use `Prepend` instead.")
- PrependSpacer = wx._deprecated(Prepend, "PrependSpacer is deprecated, use `Prepend` instead.")
- InsertWindow = wx._deprecated(Insert, "InsertWindow is deprecated, use `Insert` instead.")
- InsertSizer = wx._deprecated(Insert, "InsertSizer is deprecated, use `Insert` instead.")
- InsertSpacer = wx._deprecated(Insert, "InsertSpacer is deprecated, use `Insert` instead.")
- RemoveWindow = wx._deprecated(Remove, "RemoveWindow is deprecated, use `Remove` instead.")
- RemoveSizer = wx._deprecated(Remove, "RemoveSizer is deprecated, use `Remove` instead.")
- RemovePos = wx._deprecated(Remove, "RemovePos is deprecated, use `Remove` instead.")
+ def AddWindow(self, *args, **kw):
+ """Compatibility alias for `Add`."""
+ return self.Add(*args, **kw)
+ def AddSizer(self, *args, **kw):
+ """Compatibility alias for `Add`."""
+ return self.Add(*args, **kw)
+ def AddSpacer(self, *args, **kw):
+ """Compatibility alias for `Add`."""
+ return self.Add(*args, **kw)
+
+ def PrependWindow(self, *args, **kw):
+ """Compatibility alias for `Prepend`."""
+ return self.Prepend(*args, **kw)
+ def PrependSizer(self, *args, **kw):
+ """Compatibility alias for `Prepend`."""
+ return self.Prepend(*args, **kw)
+ def PrependSpacer(self, *args, **kw):
+ """Compatibility alias for `Prepend`."""
+ return self.Prepend(*args, **kw)
+
+ def InsertWindow(self, *args, **kw):
+ """Compatibility alias for `Insert`."""
+ return self.Insert(*args, **kw)
+ def InsertSizer(self, *args, **kw):
+ """Compatibility alias for `Insert`."""
+ return self.Insert(*args, **kw)
+ def InsertSpacer(self, *args, **kw):
+ """Compatibility alias for `Insert`."""
+ return self.Insert(*args, **kw)
+
+ def RemoveWindow(self, *args, **kw):
+ """Compatibility alias for `Remove`."""
+ return self.Remove(*args, **kw)
+ def RemoveSizer(self, *args, **kw):
+ """Compatibility alias for `Remove`."""
+ return self.Remove(*args, **kw)
+ def RemovePos(self, *args, **kw):
+ """Compatibility alias for `Remove`."""
+ return self.Remove(*args, **kw)
- def SetItemMinSize(self, item, *args):
- if len(args) == 2:
- return self._SetItemMinSize(item, args)
- else:
- return self._SetItemMinSize(item, args[0])
-
def SetDimension(*args, **kwargs):
- """SetDimension(self, int x, int y, int width, int height)"""
+ """
+ SetDimension(self, int x, int y, int width, int height)
+
+ Call this to force the sizer to take the given dimension and thus
+ force the items owned by the sizer to resize themselves according to
+ the rules defined by the parameter in the `Add`, `Insert` or `Prepend`
+ methods.
+ """
return _core_.Sizer_SetDimension(*args, **kwargs)
def SetMinSize(*args, **kwargs):
- """SetMinSize(self, Size size)"""
+ """
+ SetMinSize(self, Size size)
+
+ Call this to give the sizer a minimal size. Normally, the sizer will
+ calculate its minimal size based purely on how much space its children
+ need. After calling this method `GetMinSize` will return either the
+ minimal size as requested by its children or the minimal size set
+ here, depending on which is bigger.
+ """
return _core_.Sizer_SetMinSize(*args, **kwargs)
def GetSize(*args, **kwargs):
- """GetSize(self) -> Size"""
+ """
+ GetSize(self) -> Size
+
+ Returns the current size of the space managed by the sizer.
+ """
return _core_.Sizer_GetSize(*args, **kwargs)
def GetPosition(*args, **kwargs):
- """GetPosition(self) -> Point"""
+ """
+ GetPosition(self) -> Point
+
+ Returns the current position of the sizer's managed space.
+ """
return _core_.Sizer_GetPosition(*args, **kwargs)
def GetMinSize(*args, **kwargs):
- """GetMinSize(self) -> Size"""
+ """
+ GetMinSize(self) -> Size
+
+ Returns the minimal size of the sizer. This is either the combined
+ minimal size of all the children and their borders or the minimal size
+ set by SetMinSize, depending on which is bigger.
+ """
return _core_.Sizer_GetMinSize(*args, **kwargs)
def GetSizeTuple(self):
return self.GetMinSize().Get()
def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
+ """
+ RecalcSizes(self)
+
+ Using the sizes calculated by `CalcMin` reposition and resize all the
+ items managed by this sizer. You should not need to call this directly as
+ it is called by `Layout`.
+ """
return _core_.Sizer_RecalcSizes(*args, **kwargs)
def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
+ """
+ CalcMin(self) -> Size
+
+ This method is where the sizer will do the actual calculation of its
+ children's minimal sizes. You should not need to call this directly as
+ it is called by `Layout`.
+ """
return _core_.Sizer_CalcMin(*args, **kwargs)
def Layout(*args, **kwargs):
- """Layout(self)"""
+ """
+ Layout(self)
+
+ This method will force the recalculation and layout of the items
+ controlled by the sizer using the current space allocated to the
+ sizer. Normally this is called automatically from the owning window's
+ EVT_SIZE handler, but it is also useful to call it from user code when
+ one of the items in a sizer change size, or items are added or
+ removed.
+ """
return _core_.Sizer_Layout(*args, **kwargs)
def Fit(*args, **kwargs):
- """Fit(self, Window window) -> Size"""
+ """
+ Fit(self, Window window) -> Size
+
+ Tell the sizer to resize the *window* to match the sizer's minimal
+ size. This is commonly done in the constructor of the window itself in
+ order to set its initial size to match the needs of the children as
+ determined by the sizer. Returns the new size.
+
+ For a top level window this is the total window size, not the client size.
+ """
return _core_.Sizer_Fit(*args, **kwargs)
def FitInside(*args, **kwargs):
- """FitInside(self, Window window)"""
+ """
+ FitInside(self, Window window)
+
+ Tell the sizer to resize the *virtual size* of the *window* to match the
+ sizer's minimal size. This will not alter the on screen size of the
+ window, but may cause the addition/removal/alteration of scrollbars
+ required to view the virtual area in windows which manage it.
+
+ :see: `wx.ScrolledWindow.SetScrollbars`, `SetVirtualSizeHints`
+
+ """
return _core_.Sizer_FitInside(*args, **kwargs)
def SetSizeHints(*args, **kwargs):
- """SetSizeHints(self, Window window)"""
+ """
+ SetSizeHints(self, Window window)
+
+ Tell the sizer to set (and `Fit`) the minimal size of the *window* to
+ match the sizer's minimal size. This is commonly done in the
+ constructor of the window itself if the window is resizable (as are
+ many dialogs under Unix and frames on probably all platforms) in order
+ to prevent the window from being sized smaller than the minimal size
+ required by the sizer.
+ """
return _core_.Sizer_SetSizeHints(*args, **kwargs)
def SetVirtualSizeHints(*args, **kwargs):
- """SetVirtualSizeHints(self, Window window)"""
+ """
+ SetVirtualSizeHints(self, Window window)
+
+ Tell the sizer to set the minimal size of the window virtual area to
+ match the sizer's minimal size. For windows with managed scrollbars
+ this will set them appropriately.
+
+ :see: `wx.ScrolledWindow.SetScrollbars`
+
+ """
return _core_.Sizer_SetVirtualSizeHints(*args, **kwargs)
def Clear(*args, **kwargs):
- """Clear(self, bool delete_windows=False)"""
+ """
+ Clear(self, bool deleteWindows=False)
+
+ Clear all items from the sizer, optionally destroying the window items
+ as well.
+ """
return _core_.Sizer_Clear(*args, **kwargs)
def DeleteWindows(*args, **kwargs):
- """DeleteWindows(self)"""
+ """
+ DeleteWindows(self)
+
+ Destroy all windows managed by the sizer.
+ """
return _core_.Sizer_DeleteWindows(*args, **kwargs)
def GetChildren(*args, **kwargs):
- """GetChildren(self) -> PyObject"""
+ """
+ GetChildren(self) -> list
+
+ Returns a list of all the `wx.SizerItem` objects managed by the sizer.
+ """
return _core_.Sizer_GetChildren(*args, **kwargs)
def Show(*args, **kwargs):
- """Show(self, PyObject item, bool show=True)"""
- return _core_.Sizer_Show(*args, **kwargs)
+ """
+ Show(self, item, bool show=True, bool recursive=false) -> bool
- def Hide(*args, **kwargs):
- """Hide(self, PyObject item)"""
- return _core_.Sizer_Hide(*args, **kwargs)
+ Shows or hides an item managed by the sizer. To make a sizer item
+ disappear or reappear, use Show followed by `Layout`. The *item*
+ parameter can be either a window, a sizer, or the zero-based index of
+ the item. Use the recursive parameter to show or hide an item in a
+ subsizer. Returns True if the item was found.
+ """
+ return _core_.Sizer_Show(*args, **kwargs)
def IsShown(*args, **kwargs):
- """IsShown(self, PyObject item) -> bool"""
+ """
+ IsShown(self, item)
+
+ Determines if the item is currently shown. To make a sizer
+ item disappear or reappear, use Show followed by `Layout`. The *item*
+ parameter can be either a window, a sizer, or the zero-based index of
+ the item.
+ """
return _core_.Sizer_IsShown(*args, **kwargs)
+ def Hide(self, item, recursive=False):
+ """
+ A convenience method for `Show` (item, False, recursive).
+ """
+ return self.Show(item, False, recursive)
+
def ShowItems(*args, **kwargs):
- """ShowItems(self, bool show)"""
+ """
+ ShowItems(self, bool show)
+
+ Recursively call `wx.SizerItem.Show` on all sizer items.
+ """
return _core_.Sizer_ShowItems(*args, **kwargs)
+Sizer_swigregister = _core_.Sizer_swigregister
+Sizer_swigregister(Sizer)
-class SizerPtr(Sizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = Sizer
-_core_.Sizer_swigregister(SizerPtr)
+class PySizer(Sizer):
+ """
+ wx.PySizer is a special version of `wx.Sizer` that has been
+ instrumented to allow the C++ virtual methods to be overloaded in
+ Python derived classes. You would derive from this class if you are
+ wanting to implement a custom sizer in Python code. Simply implement
+ `CalcMin` and `RecalcSizes` in the derived class and you're all set.
+ For example::
+
+ class MySizer(wx.PySizer):
+ def __init__(self):
+ wx.PySizer.__init__(self)
+
+ def CalcMin(self):
+ for item in self.GetChildren():
+ # calculate the total minimum width and height needed
+ # by all items in the sizer according to this sizer's
+ # layout algorithm.
+ ...
+ return wx.Size(width, height)
+
+ def RecalcSizes(self):
+ # find the space allotted to this sizer
+ pos = self.GetPosition()
+ size = self.GetSize()
+ for item in self.GetChildren():
+ # Recalculate (if necessary) the position and size of
+ # each item and then call item.SetDimension to do the
+ # actual positioning and sizing of the items within the
+ # space alloted to this sizer.
+ ...
+ item.SetDimension(itemPos, itemSize)
+
+
+ When `Layout` is called it first calls `CalcMin` followed by
+ `RecalcSizes` so you can optimize a bit by saving the results of
+ `CalcMin` and reusing them in `RecalcSizes`.
+
+ :see: `wx.SizerItem`, `wx.Sizer.GetChildren`
+
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> PySizer
-class PySizer(Sizer):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxPySizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> PySizer"""
- newobj = _core_.new_PySizer(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ Creates a wx.PySizer. Must be called from the __init__ in the derived
+ class.
+ """
+ _core_.PySizer_swiginit(self,_core_.new_PySizer(*args, **kwargs))
self._setCallbackInfo(self, PySizer);self._setOORInfo(self)
def _setCallbackInfo(*args, **kwargs):
"""_setCallbackInfo(self, PyObject self, PyObject _class)"""
return _core_.PySizer__setCallbackInfo(*args, **kwargs)
-
-class PySizerPtr(PySizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = PySizer
-_core_.PySizer_swigregister(PySizerPtr)
+PySizer_swigregister = _core_.PySizer_swigregister
+PySizer_swigregister(PySizer)
#---------------------------------------------------------------------------
class BoxSizer(Sizer):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int orient=HORIZONTAL) -> BoxSizer"""
- newobj = _core_.new_BoxSizer(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ The basic idea behind a box sizer is that windows will most often be
+ laid out in rather simple basic geometry, typically in a row or a
+ column or nested hierarchies of either. A wx.BoxSizer will lay out
+ its items in a simple row or column, depending on the orientation
+ parameter passed to the constructor.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int orient=HORIZONTAL) -> BoxSizer
+
+ Constructor for a wx.BoxSizer. *orient* may be one of ``wx.VERTICAL``
+ or ``wx.HORIZONTAL`` for creating either a column sizer or a row
+ sizer.
+ """
+ _core_.BoxSizer_swiginit(self,_core_.new_BoxSizer(*args, **kwargs))
self._setOORInfo(self)
def GetOrientation(*args, **kwargs):
- """GetOrientation(self) -> int"""
+ """
+ GetOrientation(self) -> int
+
+ Returns the current orientation of the sizer.
+ """
return _core_.BoxSizer_GetOrientation(*args, **kwargs)
def SetOrientation(*args, **kwargs):
- """SetOrientation(self, int orient)"""
- return _core_.BoxSizer_SetOrientation(*args, **kwargs)
-
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.BoxSizer_RecalcSizes(*args, **kwargs)
-
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.BoxSizer_CalcMin(*args, **kwargs)
+ """
+ SetOrientation(self, int orient)
+ Resets the orientation of the sizer.
+ """
+ return _core_.BoxSizer_SetOrientation(*args, **kwargs)
-class BoxSizerPtr(BoxSizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = BoxSizer
-_core_.BoxSizer_swigregister(BoxSizerPtr)
+BoxSizer_swigregister = _core_.BoxSizer_swigregister
+BoxSizer_swigregister(BoxSizer)
#---------------------------------------------------------------------------
class StaticBoxSizer(BoxSizer):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxStaticBoxSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, wxStaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer"""
- newobj = _core_.new_StaticBoxSizer(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ wx.StaticBoxSizer derives from and functions identically to the
+ `wx.BoxSizer` and adds a `wx.StaticBox` around the items that the sizer
+ manages. Note that this static box must be created separately and
+ passed to the sizer constructor.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, StaticBox box, int orient=HORIZONTAL) -> StaticBoxSizer
+
+ Constructor. It takes an associated static box and the orientation
+ *orient* as parameters - orient can be either of ``wx.VERTICAL`` or
+ ``wx.HORIZONTAL``.
+ """
+ _core_.StaticBoxSizer_swiginit(self,_core_.new_StaticBoxSizer(*args, **kwargs))
self._setOORInfo(self)
def GetStaticBox(*args, **kwargs):
- """GetStaticBox(self) -> wxStaticBox"""
- return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
-
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.StaticBoxSizer_RecalcSizes(*args, **kwargs)
-
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.StaticBoxSizer_CalcMin(*args, **kwargs)
+ """
+ GetStaticBox(self) -> StaticBox
+ Returns the static box associated with this sizer.
+ """
+ return _core_.StaticBoxSizer_GetStaticBox(*args, **kwargs)
-class StaticBoxSizerPtr(StaticBoxSizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = StaticBoxSizer
-_core_.StaticBoxSizer_swigregister(StaticBoxSizerPtr)
+StaticBoxSizer_swigregister = _core_.StaticBoxSizer_swigregister
+StaticBoxSizer_swigregister(StaticBoxSizer)
#---------------------------------------------------------------------------
class GridSizer(Sizer):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer"""
- newobj = _core_.new_GridSizer(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- self._setOORInfo(self)
+ """
+ A grid sizer is a sizer which lays out its children in a
+ two-dimensional table with all cells having the same size. In other
+ words, the width of each cell within the grid is the width of the
+ widest item added to the sizer and the height of each grid cell is the
+ height of the tallest item. An optional vertical and/or horizontal
+ gap between items can also be specified (in pixels.)
+
+ Items are placed in the cells of the grid in the order they are added,
+ in row-major order. In other words, the first row is filled first,
+ then the second, and so on until all items have been added. (If
+ neccessary, additional rows will be added as items are added.) If you
+ need to have greater control over the cells that items are placed in
+ then use the `wx.GridBagSizer`.
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.GridSizer_RecalcSizes(*args, **kwargs)
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> GridSizer
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.GridSizer_CalcMin(*args, **kwargs)
+ Constructor for a wx.GridSizer. *rows* and *cols* determine the number
+ of columns and rows in the sizer - if either of the parameters is
+ zero, it will be calculated to from the total number of children in
+ the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
+ define extra space between all children.
+ """
+ _core_.GridSizer_swiginit(self,_core_.new_GridSizer(*args, **kwargs))
+ self._setOORInfo(self)
def SetCols(*args, **kwargs):
- """SetCols(self, int cols)"""
+ """
+ SetCols(self, int cols)
+
+ Sets the number of columns in the sizer.
+ """
return _core_.GridSizer_SetCols(*args, **kwargs)
def SetRows(*args, **kwargs):
- """SetRows(self, int rows)"""
+ """
+ SetRows(self, int rows)
+
+ Sets the number of rows in the sizer.
+ """
return _core_.GridSizer_SetRows(*args, **kwargs)
def SetVGap(*args, **kwargs):
- """SetVGap(self, int gap)"""
+ """
+ SetVGap(self, int gap)
+
+ Sets the vertical gap (in pixels) between the cells in the sizer.
+ """
return _core_.GridSizer_SetVGap(*args, **kwargs)
def SetHGap(*args, **kwargs):
- """SetHGap(self, int gap)"""
+ """
+ SetHGap(self, int gap)
+
+ Sets the horizontal gap (in pixels) between cells in the sizer
+ """
return _core_.GridSizer_SetHGap(*args, **kwargs)
def GetCols(*args, **kwargs):
- """GetCols(self) -> int"""
+ """
+ GetCols(self) -> int
+
+ Returns the number of columns in the sizer.
+ """
return _core_.GridSizer_GetCols(*args, **kwargs)
def GetRows(*args, **kwargs):
- """GetRows(self) -> int"""
+ """
+ GetRows(self) -> int
+
+ Returns the number of rows in the sizer.
+ """
return _core_.GridSizer_GetRows(*args, **kwargs)
def GetVGap(*args, **kwargs):
- """GetVGap(self) -> int"""
+ """
+ GetVGap(self) -> int
+
+ Returns the vertical gap (in pixels) between the cells in the sizer.
+ """
return _core_.GridSizer_GetVGap(*args, **kwargs)
def GetHGap(*args, **kwargs):
- """GetHGap(self) -> int"""
+ """
+ GetHGap(self) -> int
+
+ Returns the horizontal gap (in pixels) between cells in the sizer.
+ """
return _core_.GridSizer_GetHGap(*args, **kwargs)
+ def CalcRowsCols(self):
+ """
+ CalcRowsCols() -> (rows, cols)
+
+ Calculates how many rows and columns will be in the sizer based
+ on the current number of items and also the rows, cols specified
+ in the constructor.
+ """
+ nitems = len(self.GetChildren())
+ rows = self.GetRows()
+ cols = self.GetCols()
+ assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
+ if cols != 0:
+ rows = (nitems + cols - 1) / cols
+ elif rows != 0:
+ cols = (nitems + rows - 1) / rows
+ return (rows, cols)
-class GridSizerPtr(GridSizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = GridSizer
-_core_.GridSizer_swigregister(GridSizerPtr)
+GridSizer_swigregister = _core_.GridSizer_swigregister
+GridSizer_swigregister(GridSizer)
#---------------------------------------------------------------------------
FLEX_GROWMODE_SPECIFIED = _core_.FLEX_GROWMODE_SPECIFIED
FLEX_GROWMODE_ALL = _core_.FLEX_GROWMODE_ALL
class FlexGridSizer(GridSizer):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxFlexGridSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer"""
- newobj = _core_.new_FlexGridSizer(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
- self._setOORInfo(self)
+ """
+ A flex grid sizer is a sizer which lays out its children in a
+ two-dimensional table with all table cells in one row having the same
+ height and all cells in one column having the same width, but all
+ rows or all columns are not necessarily the same height or width as in
+ the `wx.GridSizer`.
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.FlexGridSizer_RecalcSizes(*args, **kwargs)
+ wx.FlexGridSizer can also size items equally in one direction but
+ unequally ("flexibly") in the other. If the sizer is only flexible
+ in one direction (this can be changed using `SetFlexibleDirection`), it
+ needs to be decided how the sizer should grow in the other ("non
+ flexible") direction in order to fill the available space. The
+ `SetNonFlexibleGrowMode` method serves this purpose.
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.FlexGridSizer_CalcMin(*args, **kwargs)
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int rows=1, int cols=0, int vgap=0, int hgap=0) -> FlexGridSizer
+
+ Constructor for a wx.FlexGridSizer. *rows* and *cols* determine the
+ number of columns and rows in the sizer - if either of the parameters
+ is zero, it will be calculated to from the total number of children in
+ the sizer, thus making the sizer grow dynamically. *vgap* and *hgap*
+ define extra space between all children.
+ """
+ _core_.FlexGridSizer_swiginit(self,_core_.new_FlexGridSizer(*args, **kwargs))
+ self._setOORInfo(self)
def AddGrowableRow(*args, **kwargs):
- """AddGrowableRow(self, size_t idx, int proportion=0)"""
+ """
+ AddGrowableRow(self, size_t idx, int proportion=0)
+
+ Specifies that row *idx* (starting from zero) should be grown if there
+ is extra space available to the sizer.
+
+ The *proportion* parameter has the same meaning as the stretch factor
+ for the box sizers except that if all proportions are 0, then all
+ columns are resized equally (instead of not being resized at all).
+ """
return _core_.FlexGridSizer_AddGrowableRow(*args, **kwargs)
def RemoveGrowableRow(*args, **kwargs):
- """RemoveGrowableRow(self, size_t idx)"""
+ """
+ RemoveGrowableRow(self, size_t idx)
+
+ Specifies that row *idx* is no longer growable.
+ """
return _core_.FlexGridSizer_RemoveGrowableRow(*args, **kwargs)
def AddGrowableCol(*args, **kwargs):
- """AddGrowableCol(self, size_t idx, int proportion=0)"""
+ """
+ AddGrowableCol(self, size_t idx, int proportion=0)
+
+ Specifies that column *idx* (starting from zero) should be grown if
+ there is extra space available to the sizer.
+
+ The *proportion* parameter has the same meaning as the stretch factor
+ for the box sizers except that if all proportions are 0, then all
+ columns are resized equally (instead of not being resized at all).
+ """
return _core_.FlexGridSizer_AddGrowableCol(*args, **kwargs)
def RemoveGrowableCol(*args, **kwargs):
- """RemoveGrowableCol(self, size_t idx)"""
+ """
+ RemoveGrowableCol(self, size_t idx)
+
+ Specifies that column *idx* is no longer growable.
+ """
return _core_.FlexGridSizer_RemoveGrowableCol(*args, **kwargs)
def SetFlexibleDirection(*args, **kwargs):
- """SetFlexibleDirection(self, int direction)"""
+ """
+ SetFlexibleDirection(self, int direction)
+
+ Specifies whether the sizer should flexibly resize its columns, rows,
+ or both. Argument *direction* can be one of the following values. Any
+ other value is ignored.
+
+ ============== =======================================
+ wx.VERTICAL Rows are flexibly sized.
+ wx.HORIZONTAL Columns are flexibly sized.
+ wx.BOTH Both rows and columns are flexibly sized
+ (this is the default value).
+ ============== =======================================
+
+ Note that this method does not trigger relayout.
+
+ """
return _core_.FlexGridSizer_SetFlexibleDirection(*args, **kwargs)
def GetFlexibleDirection(*args, **kwargs):
- """GetFlexibleDirection(self) -> int"""
+ """
+ GetFlexibleDirection(self) -> int
+
+ Returns a value that specifies whether the sizer
+ flexibly resizes its columns, rows, or both (default).
+
+ :see: `SetFlexibleDirection`
+ """
return _core_.FlexGridSizer_GetFlexibleDirection(*args, **kwargs)
def SetNonFlexibleGrowMode(*args, **kwargs):
- """SetNonFlexibleGrowMode(self, int mode)"""
+ """
+ SetNonFlexibleGrowMode(self, int mode)
+
+ Specifies how the sizer should grow in the non-flexible direction if
+ there is one (so `SetFlexibleDirection` must have been called
+ previously). Argument *mode* can be one of the following values:
+
+ ========================== =================================================
+ wx.FLEX_GROWMODE_NONE Sizer doesn't grow in the non flexible direction.
+ wx.FLEX_GROWMODE_SPECIFIED Sizer honors growable columns/rows set with
+ `AddGrowableCol` and `AddGrowableRow`. In this
+ case equal sizing applies to minimum sizes of
+ columns or rows (this is the default value).
+ wx.FLEX_GROWMODE_ALL Sizer equally stretches all columns or rows in
+ the non flexible direction, whether they are
+ growable or not in the flexbile direction.
+ ========================== =================================================
+
+ Note that this method does not trigger relayout.
+
+
+ """
return _core_.FlexGridSizer_SetNonFlexibleGrowMode(*args, **kwargs)
def GetNonFlexibleGrowMode(*args, **kwargs):
- """GetNonFlexibleGrowMode(self) -> int"""
+ """
+ GetNonFlexibleGrowMode(self) -> int
+
+ Returns the value that specifies how the sizer grows in the
+ non-flexible direction if there is one.
+
+ :see: `SetNonFlexibleGrowMode`
+ """
return _core_.FlexGridSizer_GetNonFlexibleGrowMode(*args, **kwargs)
def GetRowHeights(*args, **kwargs):
- """GetRowHeights(self) -> wxArrayInt"""
+ """
+ GetRowHeights(self) -> list
+
+ Returns a list of integers representing the heights of each of the
+ rows in the sizer.
+ """
return _core_.FlexGridSizer_GetRowHeights(*args, **kwargs)
def GetColWidths(*args, **kwargs):
- """GetColWidths(self) -> wxArrayInt"""
+ """
+ GetColWidths(self) -> list
+
+ Returns a list of integers representing the widths of each of the
+ columns in the sizer.
+ """
return _core_.FlexGridSizer_GetColWidths(*args, **kwargs)
+FlexGridSizer_swigregister = _core_.FlexGridSizer_swigregister
+FlexGridSizer_swigregister(FlexGridSizer)
+
+class StdDialogButtonSizer(BoxSizer):
+ """
+ A special sizer that knows how to order and position standard buttons
+ in order to conform to the current platform's standards. You simply
+ need to add each `wx.Button` to the sizer, and be sure to create the
+ buttons using the standard ID's. Then call `Realize` and the sizer
+ will take care of the rest.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """__init__(self) -> StdDialogButtonSizer"""
+ _core_.StdDialogButtonSizer_swiginit(self,_core_.new_StdDialogButtonSizer(*args, **kwargs))
+ def AddButton(*args, **kwargs):
+ """
+ AddButton(self, wxButton button)
+
+ Use this to add the buttons to this sizer. Do not use the `Add`
+ method in the base class.
+ """
+ return _core_.StdDialogButtonSizer_AddButton(*args, **kwargs)
+
+ def Realize(*args, **kwargs):
+ """
+ Realize(self)
+
+ This funciton needs to be called after all the buttons have been added
+ to the sizer. It will reorder them and position them in a platform
+ specifc manner.
+ """
+ return _core_.StdDialogButtonSizer_Realize(*args, **kwargs)
+
+ def SetAffirmativeButton(*args, **kwargs):
+ """SetAffirmativeButton(self, wxButton button)"""
+ return _core_.StdDialogButtonSizer_SetAffirmativeButton(*args, **kwargs)
+
+ def SetNegativeButton(*args, **kwargs):
+ """SetNegativeButton(self, wxButton button)"""
+ return _core_.StdDialogButtonSizer_SetNegativeButton(*args, **kwargs)
+
+ def SetCancelButton(*args, **kwargs):
+ """SetCancelButton(self, wxButton button)"""
+ return _core_.StdDialogButtonSizer_SetCancelButton(*args, **kwargs)
+
+ def GetAffirmativeButton(*args, **kwargs):
+ """GetAffirmativeButton(self) -> wxButton"""
+ return _core_.StdDialogButtonSizer_GetAffirmativeButton(*args, **kwargs)
+
+ def GetApplyButton(*args, **kwargs):
+ """GetApplyButton(self) -> wxButton"""
+ return _core_.StdDialogButtonSizer_GetApplyButton(*args, **kwargs)
+
+ def GetNegativeButton(*args, **kwargs):
+ """GetNegativeButton(self) -> wxButton"""
+ return _core_.StdDialogButtonSizer_GetNegativeButton(*args, **kwargs)
+
+ def GetCancelButton(*args, **kwargs):
+ """GetCancelButton(self) -> wxButton"""
+ return _core_.StdDialogButtonSizer_GetCancelButton(*args, **kwargs)
+
+ def GetHelpButton(*args, **kwargs):
+ """GetHelpButton(self) -> wxButton"""
+ return _core_.StdDialogButtonSizer_GetHelpButton(*args, **kwargs)
-class FlexGridSizerPtr(FlexGridSizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = FlexGridSizer
-_core_.FlexGridSizer_swigregister(FlexGridSizerPtr)
+StdDialogButtonSizer_swigregister = _core_.StdDialogButtonSizer_swigregister
+StdDialogButtonSizer_swigregister(StdDialogButtonSizer)
#---------------------------------------------------------------------------
class GBPosition(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxGBPosition instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int row=0, int col=0) -> GBPosition"""
- newobj = _core_.new_GBPosition(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This class represents the position of an item in a virtual grid of
+ rows and columns managed by a `wx.GridBagSizer`. wxPython has
+ typemaps that will automatically convert from a 2-element sequence of
+ integers to a wx.GBPosition, so you can use the more pythonic
+ representation of the position nearly transparently in Python code.
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int row=0, int col=0) -> GBPosition
+
+ This class represents the position of an item in a virtual grid of
+ rows and columns managed by a `wx.GridBagSizer`. wxPython has
+ typemaps that will automatically convert from a 2-element sequence of
+ integers to a wx.GBPosition, so you can use the more pythonic
+ representation of the position nearly transparently in Python code.
+ """
+ _core_.GBPosition_swiginit(self,_core_.new_GBPosition(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_GBPosition
+ __del__ = lambda self : None;
def GetRow(*args, **kwargs):
"""GetRow(self) -> int"""
return _core_.GBPosition_GetRow(*args, **kwargs)
row = property(GetRow, SetRow)
col = property(GetCol, SetCol)
-
-class GBPositionPtr(GBPosition):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = GBPosition
-_core_.GBPosition_swigregister(GBPositionPtr)
+GBPosition_swigregister = _core_.GBPosition_swigregister
+GBPosition_swigregister(GBPosition)
class GBSpan(object):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxGBSpan instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int rowspan=1, int colspan=1) -> GBSpan"""
- newobj = _core_.new_GBSpan(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ This class is used to hold the row and column spanning attributes of
+ items in a `wx.GridBagSizer`. wxPython has typemaps that will
+ automatically convert from a 2-element sequence of integers to a
+ wx.GBSpan, so you can use the more pythonic representation of the span
+ nearly transparently in Python code.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int rowspan=1, int colspan=1) -> GBSpan
+
+ Construct a new wxGBSpan, optionally setting the rowspan and
+ colspan. The default is (1,1). (Meaning that the item occupies one
+ cell in each direction.
+ """
+ _core_.GBSpan_swiginit(self,_core_.new_GBSpan(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_GBSpan
+ __del__ = lambda self : None;
def GetRowspan(*args, **kwargs):
"""GetRowspan(self) -> int"""
return _core_.GBSpan_GetRowspan(*args, **kwargs)
rowspan = property(GetRowspan, SetRowspan)
colspan = property(GetColspan, SetColspan)
-
-class GBSpanPtr(GBSpan):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = GBSpan
-_core_.GBSpan_swigregister(GBSpanPtr)
+GBSpan_swigregister = _core_.GBSpan_swigregister
+GBSpan_swigregister(GBSpan)
class GBSizerItem(SizerItem):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxGBSizerItem instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self) -> GBSizerItem"""
- newobj = _core_.new_GBSizerItem(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ The wx.GBSizerItem class is used to track the additional data about
+ items in a `wx.GridBagSizer` such as the item's position in the grid
+ and how many rows or columns it spans.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self) -> GBSizerItem
+
+ Constructs an empty wx.GBSizerItem. Either a window, sizer or spacer
+ size will need to be set, as well as a position and span before this
+ item can be used in a Sizer.
+
+ You will probably never need to create a wx.GBSizerItem directly as they
+ are created automatically when the sizer's Add method is called.
+ """
+ _core_.GBSizerItem_swiginit(self,_core_.new_GBSizerItem(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_GBSizerItem
+ __del__ = lambda self : None;
def GetPos(*args, **kwargs):
- """GetPos(self) -> GBPosition"""
+ """
+ GetPos(self) -> GBPosition
+
+ Get the grid position of the item
+ """
return _core_.GBSizerItem_GetPos(*args, **kwargs)
def GetPosTuple(self): return self.GetPos().Get()
def GetSpan(*args, **kwargs):
- """GetSpan(self) -> GBSpan"""
+ """
+ GetSpan(self) -> GBSpan
+
+ Get the row and column spanning of the item
+ """
return _core_.GBSizerItem_GetSpan(*args, **kwargs)
def GetSpanTuple(self): return self.GetSpan().Get()
def SetPos(*args, **kwargs):
- """SetPos(self, GBPosition pos) -> bool"""
+ """
+ SetPos(self, GBPosition pos) -> bool
+
+ If the item is already a member of a sizer then first ensure that
+ there is no other item that would intersect with this one at the new
+ position, then set the new position. Returns True if the change is
+ successful and after the next Layout() the item will be moved.
+ """
return _core_.GBSizerItem_SetPos(*args, **kwargs)
def SetSpan(*args, **kwargs):
- """SetSpan(self, GBSpan span) -> bool"""
+ """
+ SetSpan(self, GBSpan span) -> bool
+
+ If the item is already a member of a sizer then first ensure that
+ there is no other item that would intersect with this one with its new
+ spanning size, then set the new spanning. Returns True if the change
+ is successful and after the next Layout() the item will be resized.
+
+ """
return _core_.GBSizerItem_SetSpan(*args, **kwargs)
- def Intersects(*args):
+ def Intersects(*args, **kwargs):
"""
Intersects(self, GBSizerItem other) -> bool
- Intersects(self, GBPosition pos, GBSpan span) -> bool
+
+ Returns True if this item and the other item instersect.
+ """
+ return _core_.GBSizerItem_Intersects(*args, **kwargs)
+
+ def IntersectsPos(*args, **kwargs):
"""
- return _core_.GBSizerItem_Intersects(*args)
+ IntersectsPos(self, GBPosition pos, GBSpan span) -> bool
+
+ Returns True if the given pos/span would intersect with this item.
+ """
+ return _core_.GBSizerItem_IntersectsPos(*args, **kwargs)
def GetEndPos(*args, **kwargs):
- """GetEndPos(self, int row, int col)"""
+ """
+ GetEndPos(self) -> GBPosition
+
+ Get the row and column of the endpoint of this item.
+ """
return _core_.GBSizerItem_GetEndPos(*args, **kwargs)
def GetGBSizer(*args, **kwargs):
- """GetGBSizer(self) -> GridBagSizer"""
+ """
+ GetGBSizer(self) -> GridBagSizer
+
+ Get the sizer this item is a member of.
+ """
return _core_.GBSizerItem_GetGBSizer(*args, **kwargs)
def SetGBSizer(*args, **kwargs):
- """SetGBSizer(self, GridBagSizer sizer)"""
- return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
+ """
+ SetGBSizer(self, GridBagSizer sizer)
+ Set the sizer this item is a member of.
+ """
+ return _core_.GBSizerItem_SetGBSizer(*args, **kwargs)
-class GBSizerItemPtr(GBSizerItem):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = GBSizerItem
-_core_.GBSizerItem_swigregister(GBSizerItemPtr)
+GBSizerItem_swigregister = _core_.GBSizerItem_swigregister
+GBSizerItem_swigregister(GBSizerItem)
DefaultSpan = cvar.DefaultSpan
def GBSizerItemWindow(*args, **kwargs):
"""
GBSizerItemWindow(Window window, GBPosition pos, GBSpan span, int flag,
- int border, Object userData) -> GBSizerItem
+ int border, PyObject userData=None) -> GBSizerItem
+
+ Construct a `wx.GBSizerItem` for a window.
"""
val = _core_.new_GBSizerItemWindow(*args, **kwargs)
- val.thisown = 1
return val
def GBSizerItemSizer(*args, **kwargs):
"""
GBSizerItemSizer(Sizer sizer, GBPosition pos, GBSpan span, int flag,
- int border, Object userData) -> GBSizerItem
+ int border, PyObject userData=None) -> GBSizerItem
+
+ Construct a `wx.GBSizerItem` for a sizer
"""
val = _core_.new_GBSizerItemSizer(*args, **kwargs)
- val.thisown = 1
return val
def GBSizerItemSpacer(*args, **kwargs):
"""
GBSizerItemSpacer(int width, int height, GBPosition pos, GBSpan span,
- int flag, int border, Object userData) -> GBSizerItem
+ int flag, int border, PyObject userData=None) -> GBSizerItem
+
+ Construct a `wx.GBSizerItem` for a spacer.
"""
val = _core_.new_GBSizerItemSpacer(*args, **kwargs)
- val.thisown = 1
return val
class GridBagSizer(FlexGridSizer):
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxGridBagSizer instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
- def __init__(self, *args, **kwargs):
- """__init__(self, int vgap=0, int hgap=0) -> GridBagSizer"""
- newobj = _core_.new_GridBagSizer(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ """
+ A `wx.Sizer` that can lay out items in a virtual grid like a
+ `wx.FlexGridSizer` but in this case explicit positioning of the items
+ is allowed using `wx.GBPosition`, and items can optionally span more
+ than one row and/or column using `wx.GBSpan`. The total size of the
+ virtual grid is determined by the largest row and column that items are
+ positioned at, adjusted for spanning.
+
+ """
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
+ def __init__(self, *args, **kwargs):
+ """
+ __init__(self, int vgap=0, int hgap=0) -> GridBagSizer
+
+ Constructor, with optional parameters to specify the gap between the
+ rows and columns.
+ """
+ _core_.GridBagSizer_swiginit(self,_core_.new_GridBagSizer(*args, **kwargs))
+ self._setOORInfo(self)
+
def Add(*args, **kwargs):
"""
- Add(self, PyObject item, GBPosition pos, GBSpan span=DefaultSpan,
- int flag=0, int border=0, PyObject userData=None) -> bool
+ Add(self, item, GBPosition pos, GBSpan span=DefaultSpan, int flag=0,
+ int border=0, userData=None) -> wx.GBSizerItem
+
+ Adds an item to the sizer at the grid cell *pos*, optionally spanning
+ more than one row or column as specified with *span*. The remaining
+ args behave similarly to `wx.Sizer.Add`.
+
+ Returns True if the item was successfully placed at the given cell
+ position, False if something was already there.
+
"""
return _core_.GridBagSizer_Add(*args, **kwargs)
def AddItem(*args, **kwargs):
- """AddItem(self, GBSizerItem item) -> bool"""
+ """
+ Add(self, GBSizerItem item) -> wx.GBSizerItem
+
+ Add an item to the sizer using a `wx.GBSizerItem`. Returns True if
+ the item was successfully placed at its given cell position, False if
+ something was already there.
+ """
return _core_.GridBagSizer_AddItem(*args, **kwargs)
+ def GetCellSize(*args, **kwargs):
+ """
+ GetCellSize(self, int row, int col) -> Size
+
+ Get the size of the specified cell, including hgap and
+ vgap. Only valid after a Layout.
+ """
+ return _core_.GridBagSizer_GetCellSize(*args, **kwargs)
+
def GetEmptyCellSize(*args, **kwargs):
- """GetEmptyCellSize(self) -> Size"""
+ """
+ GetEmptyCellSize(self) -> Size
+
+ Get the size used for cells in the grid with no item.
+ """
return _core_.GridBagSizer_GetEmptyCellSize(*args, **kwargs)
def SetEmptyCellSize(*args, **kwargs):
- """SetEmptyCellSize(self, Size sz)"""
+ """
+ SetEmptyCellSize(self, Size sz)
+
+ Set the size used for cells in the grid with no item.
+ """
return _core_.GridBagSizer_SetEmptyCellSize(*args, **kwargs)
def GetItemPosition(*args):
"""
- GetItemPosition(self, Window window) -> GBPosition
- GetItemPosition(self, Sizer sizer) -> GBPosition
- GetItemPosition(self, size_t index) -> GBPosition
+ GetItemPosition(self, item) -> GBPosition
+
+ Get the grid position of the specified *item* where *item* is either a
+ window or subsizer that is a member of this sizer, or a zero-based
+ index of an item.
"""
return _core_.GridBagSizer_GetItemPosition(*args)
def SetItemPosition(*args):
"""
- SetItemPosition(self, Window window, GBPosition pos) -> bool
- SetItemPosition(self, Sizer sizer, GBPosition pos) -> bool
- SetItemPosition(self, size_t index, GBPosition pos) -> bool
+ SetItemPosition(self, item, GBPosition pos) -> bool
+
+ Set the grid position of the specified *item* where *item* is either a
+ window or subsizer that is a member of this sizer, or a zero-based
+ index of an item. Returns True on success. If the move is not
+ allowed (because an item is already there) then False is returned.
+
"""
return _core_.GridBagSizer_SetItemPosition(*args)
def GetItemSpan(*args):
"""
- GetItemSpan(self, Window window) -> GBSpan
- GetItemSpan(self, Sizer sizer) -> GBSpan
- GetItemSpan(self, size_t index) -> GBSpan
+ GetItemSpan(self, item) -> GBSpan
+
+ Get the row/col spanning of the specified *item* where *item* is
+ either a window or subsizer that is a member of this sizer, or a
+ zero-based index of an item.
"""
return _core_.GridBagSizer_GetItemSpan(*args)
def SetItemSpan(*args):
"""
- SetItemSpan(self, Window window, GBSpan span) -> bool
- SetItemSpan(self, Sizer sizer, GBSpan span) -> bool
- SetItemSpan(self, size_t index, GBSpan span) -> bool
+ SetItemSpan(self, item, GBSpan span) -> bool
+
+ Set the row/col spanning of the specified *item* where *item* is
+ either a window or subsizer that is a member of this sizer, or a
+ zero-based index of an item. Returns True on success. If the move is
+ not allowed (because an item is already there) then False is returned.
"""
return _core_.GridBagSizer_SetItemSpan(*args)
def FindItem(*args):
"""
- FindItem(self, Window window) -> GBSizerItem
- FindItem(self, Sizer sizer) -> GBSizerItem
+ FindItem(self, item) -> GBSizerItem
+
+ Find the sizer item for the given window or subsizer, returns None if
+ not found. (non-recursive)
"""
return _core_.GridBagSizer_FindItem(*args)
def FindItemAtPosition(*args, **kwargs):
- """FindItemAtPosition(self, GBPosition pos) -> GBSizerItem"""
+ """
+ FindItemAtPosition(self, GBPosition pos) -> GBSizerItem
+
+ Return the sizer item for the given grid cell, or None if there is no
+ item at that position. (non-recursive)
+ """
return _core_.GridBagSizer_FindItemAtPosition(*args, **kwargs)
def FindItemAtPoint(*args, **kwargs):
- """FindItemAtPoint(self, Point pt) -> GBSizerItem"""
- return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
+ """
+ FindItemAtPoint(self, Point pt) -> GBSizerItem
- def FindItemWithData(*args, **kwargs):
- """FindItemWithData(self, Object userData) -> GBSizerItem"""
- return _core_.GridBagSizer_FindItemWithData(*args, **kwargs)
+ Return the sizer item located at the point given in *pt*, or None if
+ there is no item at that point. The (x,y) coordinates in pt correspond
+ to the client coordinates of the window using the sizer for
+ layout. (non-recursive)
+ """
+ return _core_.GridBagSizer_FindItemAtPoint(*args, **kwargs)
- def RecalcSizes(*args, **kwargs):
- """RecalcSizes(self)"""
- return _core_.GridBagSizer_RecalcSizes(*args, **kwargs)
+ def CheckForIntersection(*args, **kwargs):
+ """
+ CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
- def CalcMin(*args, **kwargs):
- """CalcMin(self) -> Size"""
- return _core_.GridBagSizer_CalcMin(*args, **kwargs)
+ Look at all items and see if any intersect (or would overlap) the
+ given *item*. Returns True if so, False if there would be no overlap.
+ If an *excludeItem* is given then it will not be checked for
+ intersection, for example it may be the item we are checking the
+ position of.
- def CheckForIntersection(*args):
"""
- CheckForIntersection(self, GBSizerItem item, GBSizerItem excludeItem=None) -> bool
- CheckForIntersection(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
+ return _core_.GridBagSizer_CheckForIntersection(*args, **kwargs)
+
+ def CheckForIntersectionPos(*args, **kwargs):
"""
- return _core_.GridBagSizer_CheckForIntersection(*args)
+ CheckForIntersectionPos(self, GBPosition pos, GBSpan span, GBSizerItem excludeItem=None) -> bool
+ Look at all items and see if any intersect (or would overlap) the
+ given position and span. Returns True if so, False if there would be
+ no overlap. If an *excludeItem* is given then it will not be checked
+ for intersection, for example it may be the item we are checking the
+ position of.
+ """
+ return _core_.GridBagSizer_CheckForIntersectionPos(*args, **kwargs)
-class GridBagSizerPtr(GridBagSizer):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = GridBagSizer
-_core_.GridBagSizer_swigregister(GridBagSizerPtr)
+GridBagSizer_swigregister = _core_.GridBagSizer_swigregister
+GridBagSizer_swigregister(GridBagSizer)
#---------------------------------------------------------------------------
`wx.LayoutConstraints` instance and use the individual contstraints
that it contains.
"""
- def __init__(self): raise RuntimeError, "No constructor defined"
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxIndividualLayoutConstraint instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ def __init__(self): raise AttributeError, "No constructor defined"
+ __repr__ = _swig_repr
def Set(*args, **kwargs):
"""
Set(self, int rel, Window otherW, int otherE, int val=0, int marg=wxLAYOUT_DEFAULT_MARGIN)
"""
return _core_.IndividualLayoutConstraint_GetEdge(*args, **kwargs)
-
-class IndividualLayoutConstraintPtr(IndividualLayoutConstraint):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = IndividualLayoutConstraint
-_core_.IndividualLayoutConstraint_swigregister(IndividualLayoutConstraintPtr)
+IndividualLayoutConstraint_swigregister = _core_.IndividualLayoutConstraint_swigregister
+IndividualLayoutConstraint_swigregister(IndividualLayoutConstraint)
class LayoutConstraints(Object):
"""
:see: `wx.IndividualLayoutConstraint`, `wx.Window.SetConstraints`
"""
- def __repr__(self):
- return "<%s.%s; proxy of C++ wxLayoutConstraints instance at %s>" % (self.__class__.__module__, self.__class__.__name__, self.this,)
+ thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
+ __repr__ = _swig_repr
left = property(_core_.LayoutConstraints_left_get)
top = property(_core_.LayoutConstraints_top_get)
right = property(_core_.LayoutConstraints_right_get)
height = property(_core_.LayoutConstraints_height_get)
centreX = property(_core_.LayoutConstraints_centreX_get)
centreY = property(_core_.LayoutConstraints_centreY_get)
- def __init__(self, *args, **kwargs):
+ def __init__(self, *args, **kwargs):
"""__init__(self) -> LayoutConstraints"""
- newobj = _core_.new_LayoutConstraints(*args, **kwargs)
- self.this = newobj.this
- self.thisown = 1
- del newobj.thisown
+ _core_.LayoutConstraints_swiginit(self,_core_.new_LayoutConstraints(*args, **kwargs))
+ __swig_destroy__ = _core_.delete_LayoutConstraints
+ __del__ = lambda self : None;
def SatisfyConstraints(*args, **kwargs):
"""SatisfyConstraints(Window win) -> (areSatisfied, noChanges)"""
return _core_.LayoutConstraints_SatisfyConstraints(*args, **kwargs)
"""AreSatisfied(self) -> bool"""
return _core_.LayoutConstraints_AreSatisfied(*args, **kwargs)
-
-class LayoutConstraintsPtr(LayoutConstraints):
- def __init__(self, this):
- self.this = this
- if not hasattr(self,"thisown"): self.thisown = 0
- self.__class__ = LayoutConstraints
-_core_.LayoutConstraints_swigregister(LayoutConstraintsPtr)
+LayoutConstraints_swigregister = _core_.LayoutConstraints_swigregister
+LayoutConstraints_swigregister(LayoutConstraints)
#----------------------------------------------------------------------------
#----------------------------------------------------------------------------
# Load version numbers from __version__... Ensure that major and minor
-# versions are the same for both wxPython and wxWindows.
+# versions are the same for both wxPython and wxWidgets.
from __version__ import *
__version__ = VERSION_STRING
-assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWindows version mismatch"
-assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWindows version mismatch"
+assert MAJOR_VERSION == _core_.MAJOR_VERSION, "wxPython/wxWidgets version mismatch"
+assert MINOR_VERSION == _core_.MINOR_VERSION, "wxPython/wxWidgets version mismatch"
if RELEASE_VERSION != _core_.RELEASE_VERSION:
import warnings
- warnings.warn("wxPython/wxWindows release number mismatch")
+ warnings.warn("wxPython/wxWidgets release number mismatch")
+
+#----------------------------------------------------------------------------
+
+# Set wxPython's default string<-->unicode conversion encoding from
+# the locale, but only if Python's default hasn't been changed. (We
+# assume that if the user has customized it already then that is the
+# encoding we need to use as well.)
+#
+# The encoding selected here is used when string or unicode objects
+# need to be converted in order to pass them to wxWidgets. Please be
+# aware that the default encoding within the same locale may be
+# slightly different on different platforms. For example, please see
+# http://www.alanwood.net/demos/charsetdiffs.html for differences
+# between the common latin/roman encodings.
+
+default = _sys.getdefaultencoding()
+if default == 'ascii':
+ import locale
+ import codecs
+ try:
+ default = locale.getdefaultlocale()[1]
+ codecs.lookup(default)
+ except (ValueError, LookupError, TypeError):
+ default = _sys.getdefaultencoding()
+ del locale
+ del codecs
+if default:
+ wx.SetDefaultPyEncoding(default)
+del default
#----------------------------------------------------------------------------
#----------------------------------------------------------------------------
-_wxPyCallAfterId = None
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'
+ assert app is not None, 'No wx.App created yet'
- global _wxPyCallAfterId
- if _wxPyCallAfterId is None:
- _wxPyCallAfterId = wx.NewEventType()
- app.Connect(-1, -1, _wxPyCallAfterId,
- lambda event: event.callable(*event.args, **event.kw) )
+ if not hasattr(app, "_CallAfterId"):
+ app._CallAfterId = wx.NewEventType()
+ app.Connect(-1, -1, app._CallAfterId,
+ lambda event: event.callable(*event.args, **event.kw) )
evt = wx.PyEvent()
- evt.SetEventType(_wxPyCallAfterId)
+ evt.SetEventType(app._CallAfterId)
evt.callable = callable
evt.args = args
evt.kw = kw
wx.PostEvent(app, evt)
-
#----------------------------------------------------------------------------
class FutureCall:
"""
- A convenience class for wx.Timer, that calls the given callable
+ 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
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
obj = self._globals.get(name, None)
if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
return False
- if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
+ if name.startswith('_') or name.startswith('EVT') or name.endswith('_swigregister') or name.endswith('Ptr') :
return False
return True
#----------------------------------------------------------------------------
+
projects / wxWidgets.git / blobdiff